ruff/crates/red_knot_python_semantic/resources at ee9a912f47e64de13cad0b525a714b46c5e29293 - language-servers/ruff

mirror of https://github.com/astral-sh/ruff.git synced 2025-09-28 21:05:08 +00:00

History

David Peter 235fdfc57a [red-knot] `knot_extensions` Python API (#15103 ) ## Summary Adds a type-check-time Python API that allows us to create and manipulate types and to test various of their properties. For example, this can be used to write a Markdown test to make sure that `A & B` is a subtype of `A` and `B`, but not of an unrelated class `C` (something that requires quite a bit more code to do in Rust): ```py from knot_extensions import Intersection, is_subtype_of, static_assert class A: ... class B: ... type AB = Intersection[A, B] static_assert(is_subtype_of(AB, A)) static_assert(is_subtype_of(AB, B)) class C: ... static_assert(not is_subtype_of(AB, C)) ``` I think this functionality is also helpful for interactive debugging sessions, in order to query various properties of Red Knot's type system. Which is something that otherwise requires a custom Rust unit test, some boilerplate code and constant re-compilation. ## Test Plan - New Markdown tests - Tested the modified typeshed_sync workflow locally	2025-01-08 12:52:07 +01:00
..
mdtest	[red-knot] `knot_extensions` Python API (#15103 )	2025-01-08 12:52:07 +01:00
README.md	[red-knot] document test framework (#13695 )	2024-10-10 12:02:01 -07:00

[red-knot] knot_extensions Python API (#15103 )

## Summary

Adds a type-check-time Python API that allows us to create and
manipulate types and to test various of their properties. For example,
this can be used to write a Markdown test to make sure that `A & B` is a
subtype of `A` and `B`, but not of an unrelated class `C` (something
that requires quite a bit more code to do in Rust):
```py
from knot_extensions import Intersection, is_subtype_of, static_assert

class A: ...
class B: ...

type AB = Intersection[A, B]

static_assert(is_subtype_of(AB, A))
static_assert(is_subtype_of(AB, B))

class C: ...
static_assert(not is_subtype_of(AB, C))
```

I think this functionality is also helpful for interactive debugging
sessions, in order to query various properties of Red Knot's type
system. Which is something that otherwise requires a custom Rust unit
test, some boilerplate code and constant re-compilation.

## Test Plan

- New Markdown tests
- Tested the modified typeshed_sync workflow locally

2025-01-08 12:52:07 +01:00

mdtest [red-knot] knot_extensions Python API (#15103 ) 2025-01-08 12:52:07 +01:00

README.md [red-knot] document test framework (#13695 ) 2024-10-10 12:02:01 -07:00

README.md

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.