[red-knot] Enforce specifying paths for mdtest code blocks in a separate preceding line (#15890)

## Summary

Resolves #15695, rework of #15704.

This change modifies the Mdtests framework so that:

* Paths must now be specified in a separate preceding line:

	`````markdown
	`a.py`:

	```py
	x = 1
	```
	`````

If the path of a file conflicts with its `lang`, an error will be
thrown.

* Configs are no longer accepted. The pattern still take them into
account, however, to avoid "Unterminated code block" errors.
* Unnamed files are now assigned unique, `lang`-respecting paths
automatically.

Additionally, all legacy usages have been updated.

## Test Plan

Unit tests and Markdown tests.

---------

Co-authored-by: Carl Meyer <carl@astral.sh>
This commit is contained in:
InSync
2025-02-04 14:27:17 +07:00
committed by GitHub
parent 0529ad67d7
commit 11cfe2ea8a
35 changed files with 967 additions and 286 deletions

View File

@@ -9,7 +9,9 @@ E = D
reveal_type(E) # revealed: Literal[C]
```
```py path=b.py
`b.py`:
```py
class C: ...
```
@@ -22,7 +24,9 @@ D = b.C
reveal_type(D) # revealed: Literal[C]
```
```py path=b.py
`b.py`:
```py
class C: ...
```
@@ -34,10 +38,14 @@ import a.b
reveal_type(a.b.C) # revealed: Literal[C]
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b.py
`a/b.py`:
```py
class C: ...
```
@@ -49,13 +57,19 @@ import a.b.c
reveal_type(a.b.c.C) # revealed: Literal[C]
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b/__init__.py
`a/b/__init__.py`:
```py
```
```py path=a/b/c.py
`a/b/c.py`:
```py
class C: ...
```
@@ -67,10 +81,14 @@ import a.b as b
reveal_type(b.C) # revealed: Literal[C]
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b.py
`a/b.py`:
```py
class C: ...
```
@@ -82,13 +100,19 @@ import a.b.c as c
reveal_type(c.C) # revealed: Literal[C]
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b/__init__.py
`a/b/__init__.py`:
```py
```
```py path=a/b/c.py
`a/b/c.py`:
```py
class C: ...
```
@@ -102,5 +126,7 @@ import a.foo # error: [unresolved-import] "Cannot resolve import `a.foo`"
import b.foo # error: [unresolved-import] "Cannot resolve import `b.foo`"
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```

View File

@@ -29,13 +29,17 @@ builtins from the "actual" vendored typeshed:
typeshed = "/typeshed"
```
```pyi path=/typeshed/stdlib/builtins.pyi
`/typeshed/stdlib/builtins.pyi`:
```pyi
class Custom: ...
custom_builtin: Custom
```
```pyi path=/typeshed/stdlib/typing_extensions.pyi
`/typeshed/stdlib/typing_extensions.pyi`:
```pyi
def reveal_type(obj, /): ...
```
@@ -56,12 +60,16 @@ that point:
typeshed = "/typeshed"
```
```pyi path=/typeshed/stdlib/builtins.pyi
`/typeshed/stdlib/builtins.pyi`:
```pyi
foo = bar
bar = 1
```
```pyi path=/typeshed/stdlib/typing_extensions.pyi
`/typeshed/stdlib/typing_extensions.pyi`:
```pyi
def reveal_type(obj, /): ...
```

View File

@@ -2,7 +2,9 @@
## Maybe unbound
```py path=maybe_unbound.py
`maybe_unbound.py`:
```py
def coinflip() -> bool:
return True
@@ -29,7 +31,9 @@ reveal_type(y) # revealed: Unknown | Literal[3]
## Maybe unbound annotated
```py path=maybe_unbound_annotated.py
`maybe_unbound_annotated.py`:
```py
def coinflip() -> bool:
return True
@@ -60,7 +64,9 @@ reveal_type(y) # revealed: int
Importing a possibly undeclared name still gives us its declared type:
```py path=maybe_undeclared.py
`maybe_undeclared.py`:
```py
def coinflip() -> bool:
return True
@@ -76,11 +82,15 @@ reveal_type(x) # revealed: int
## Reimport
```py path=c.py
`c.py`:
```py
def f(): ...
```
```py path=b.py
`b.py`:
```py
def coinflip() -> bool:
return True
@@ -102,11 +112,15 @@ reveal_type(f) # revealed: Literal[f, f]
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
`c.pyi`:
```pyi
x: int
```
```py path=b.py
`b.py`:
```py
def coinflip() -> bool:
return True

View File

@@ -8,11 +8,15 @@ import a.b
reveal_type(a.b) # revealed: <module 'a.b'>
```
```py path=a/__init__.py
`a/__init__.py`:
```py
b: int = 42
```
```py path=a/b.py
`a/b.py`:
```py
```
## Via from/import
@@ -23,11 +27,15 @@ from a import b
reveal_type(b) # revealed: int
```
```py path=a/__init__.py
`a/__init__.py`:
```py
b: int = 42
```
```py path=a/b.py
`a/b.py`:
```py
```
## Via both
@@ -40,11 +48,15 @@ reveal_type(b) # revealed: <module 'a.b'>
reveal_type(a.b) # revealed: <module 'a.b'>
```
```py path=a/__init__.py
`a/__init__.py`:
```py
b: int = 42
```
```py path=a/b.py
`a/b.py`:
```py
```
## Via both (backwards)
@@ -65,11 +77,15 @@ reveal_type(b) # revealed: <module 'a.b'>
reveal_type(a.b) # revealed: <module 'a.b'>
```
```py path=a/__init__.py
`a/__init__.py`:
```py
b: int = 42
```
```py path=a/b.py
`a/b.py`:
```py
```
[from-import]: https://docs.python.org/3/reference/simple_stmts.html#the-import-statement

View File

@@ -18,7 +18,9 @@ reveal_type(baz) # revealed: Unknown
## Unresolved import from resolved module
```py path=a.py
`a.py`:
```py
```
```py
@@ -29,7 +31,9 @@ reveal_type(thing) # revealed: Unknown
## Resolved import of symbol from unresolved import
```py path=a.py
`a.py`:
```py
import foo as foo # error: "Cannot resolve import `foo`"
reveal_type(foo) # revealed: Unknown
@@ -46,7 +50,9 @@ reveal_type(foo) # revealed: Unknown
## No implicit shadowing
```py path=b.py
`b.py`:
```py
x: int
```
@@ -58,7 +64,9 @@ x = "foo" # error: [invalid-assignment] "Object of type `Literal["foo"]"
## Import cycle
```py path=a.py
`a.py`:
```py
class A: ...
reveal_type(A.__mro__) # revealed: tuple[Literal[A], Literal[object]]
@@ -69,7 +77,9 @@ class C(b.B): ...
reveal_type(C.__mro__) # revealed: tuple[Literal[C], Literal[B], Literal[A], Literal[object]]
```
```py path=b.py
`b.py`:
```py
from a import A
class B(A): ...

View File

@@ -23,9 +23,13 @@ reveal_type(b) # revealed: <module 'a.b'>
reveal_type(b.c) # revealed: int
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b.py
`a/b.py`:
```py
c: int = 1
```

View File

@@ -2,10 +2,14 @@
## Non-existent
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/bar.py
`package/bar.py`:
```py
from .foo import X # error: [unresolved-import]
reveal_type(X) # revealed: Unknown
@@ -13,14 +17,20 @@ reveal_type(X) # revealed: Unknown
## Simple
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/foo.py
`package/foo.py`:
```py
X: int = 42
```
```py path=package/bar.py
`package/bar.py`:
```py
from .foo import X
reveal_type(X) # revealed: int
@@ -28,14 +38,20 @@ reveal_type(X) # revealed: int
## Dotted
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/foo/bar/baz.py
`package/foo/bar/baz.py`:
```py
X: int = 42
```
```py path=package/bar.py
`package/bar.py`:
```py
from .foo.bar.baz import X
reveal_type(X) # revealed: int
@@ -43,11 +59,15 @@ reveal_type(X) # revealed: int
## Bare to package
```py path=package/__init__.py
`package/__init__.py`:
```py
X: int = 42
```
```py path=package/bar.py
`package/bar.py`:
```py
from . import X
reveal_type(X) # revealed: int
@@ -55,7 +75,9 @@ reveal_type(X) # revealed: int
## Non-existent + bare to package
```py path=package/bar.py
`package/bar.py`:
```py
from . import X # error: [unresolved-import]
reveal_type(X) # revealed: Unknown
@@ -63,19 +85,25 @@ reveal_type(X) # revealed: Unknown
## Dunder init
```py path=package/__init__.py
`package/__init__.py`:
```py
from .foo import X
reveal_type(X) # revealed: int
```
```py path=package/foo.py
`package/foo.py`:
```py
X: int = 42
```
## Non-existent + dunder init
```py path=package/__init__.py
`package/__init__.py`:
```py
from .foo import X # error: [unresolved-import]
reveal_type(X) # revealed: Unknown
@@ -83,14 +111,20 @@ reveal_type(X) # revealed: Unknown
## Long relative import
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/foo.py
`package/foo.py`:
```py
X: int = 42
```
```py path=package/subpackage/subsubpackage/bar.py
`package/subpackage/subsubpackage/bar.py`:
```py
from ...foo import X
reveal_type(X) # revealed: int
@@ -98,14 +132,20 @@ reveal_type(X) # revealed: int
## Unbound symbol
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/foo.py
`package/foo.py`:
```py
x # error: [unresolved-reference]
```
```py path=package/bar.py
`package/bar.py`:
```py
from .foo import x # error: [unresolved-import]
reveal_type(x) # revealed: Unknown
@@ -113,14 +153,20 @@ reveal_type(x) # revealed: Unknown
## Bare to module
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/foo.py
`package/foo.py`:
```py
X: int = 42
```
```py path=package/bar.py
`package/bar.py`:
```py
from . import foo
reveal_type(foo.X) # revealed: int
@@ -131,10 +177,14 @@ reveal_type(foo.X) # revealed: int
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`.
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/bar.py
`package/bar.py`:
```py
from . import foo # error: [unresolved-import]
reveal_type(foo) # revealed: Unknown
@@ -148,14 +198,20 @@ submodule when that submodule name appears in the `imported_modules` set. That m
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.
```py path=package/__init__.py
`package/__init__.py`:
```py
```
```py path=package/foo.py
`package/foo.py`:
```py
X: int = 42
```
```py path=package/bar.py
`package/bar.py`:
```py
from . import foo
import package

View File

@@ -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
```

View File

@@ -32,10 +32,14 @@ reveal_type(a.b.C) # revealed: Literal[C]
import a.b
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b.py
`a/b.py`:
```py
class C: ...
```
@@ -55,14 +59,20 @@ reveal_type(a.b) # revealed: <module 'a.b'>
reveal_type(a.b.C) # revealed: Literal[C]
```
```py path=a/__init__.py
`a/__init__.py`:
```py
```
```py path=a/b.py
`a/b.py`:
```py
class C: ...
```
```py path=q.py
`q.py`:
```py
import a as a
import a.b as b
```
@@ -83,18 +93,26 @@ reveal_type(sub.b) # revealed: <module 'sub.b'>
reveal_type(attr.b) # revealed: <module 'attr.b'>
```
```py path=sub/__init__.py
`sub/__init__.py`:
```py
b = 1
```
```py path=sub/b.py
`sub/b.py`:
```py
```
```py path=attr/__init__.py
`attr/__init__.py`:
```py
from . import b as _
b = 1
```
```py path=attr/b.py
`attr/b.py`:
```py
```