mirror of https://github.com/astral-sh/ruff synced 2026-01-21 13:30:49 -05:00

Files

Carl Meyer b6b4ad9949 [red-knot] @override lint rule (#11282 )

## Summary

Lots of TODOs and things to clean up here, but it demonstrates the
working lint rule.

## Test Plan

```
➜ cat main.py
from typing import override
from base import B

class C(B):
    @override
    def method(self): pass

➜ cat base.py
class B: pass

➜ cat typing.py
def override(func):
    return func
```

(We provide our own `typing.py` since we don't have typeshed vendored or
type stub support yet.)

```
➜ ./target/debug/red_knot main.py
...
1   0.012086s TRACE red_knot Main Loop: Tick
[crates/red_knot/src/main.rs:157:21] diagnostics = [
    "Method C.method is decorated with `typing.override` but does not override any base class method",
]
```

If we add `def method(self): pass` to class `B` in `base.py` and run
red_knot again, there is no lint error.

---------

Co-authored-by: Micha Reiser <micha@reiser.io>

2024-05-09 09:25:08 -06:00

src

[red-knot] @override lint rule (#11282 )

2024-05-09 09:25:08 -06:00

vendor/typeshed

[red-knot] Vendor typeshed's stdlib (#11340 )

2024-05-09 12:44:53 +01:00

Cargo.toml

[red-knot] Add "cheap" program.snapshot (#11172 )

2024-04-30 07:13:26 +00:00

README.md

[red-knot] Vendor typeshed's stdlib (#11340 )

2024-05-09 12:44:53 +01:00

README.md

Red Knot

The Red Knot crate contains code working towards multifile analysis, type inference and, ultimately, type-checking. It's very much a work in progress for now.

Vendored types for the stdlib

Red Knot vendors typeshed's stubs for the standard library. The vendored stubs can be found in crates/red_knot/vendor/typeshed. The file crates/red_knot/vendor/typeshed/source_commit.txt tells you the typeshed commit that our vendored stdlib stubs currently correspond to.

Updating the vendored stubs is currently done manually. On a Unix machine, follow the following steps (if you have a typeshed clone in a typeshed directory, and a Ruff clone in a ruff directory):

rm -rf ruff/crates/red_knot/vendor/typeshed
mkdir ruff/crates/red_knot/vendor/typeshed
cp typeshed/README.md ruff/crates/red_knot/vendor/typeshed
cp typeshed/LICENSE ruff/crates/red_knot/vendor/typeshed
cp -r typeshed/stdlib ruff/crates/red_knot/vendor/typeshed/stdlib
git -C typeshed rev-parse HEAD > ruff/crates/red_knot/vendor/typeshed/source_commit.txt