Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions crates/ty_python_semantic/resources/mdtest/typed_dict.md
Original file line number Diff line number Diff line change
Expand Up @@ -1883,6 +1883,47 @@ def bad(
): ...
```

### `Required` and `NotRequired` not allowed outside `TypedDict`

```py
from typing_extensions import Required, NotRequired

# error: [invalid-type-form] "`Required` is only allowed in TypedDict fields"
x: Required[int]
# error: [invalid-type-form] "`NotRequired` is only allowed in TypedDict fields"
y: NotRequired[str]

class MyClass:
# error: [invalid-type-form] "`Required` is only allowed in TypedDict fields"
x: Required[int]
# error: [invalid-type-form] "`NotRequired` is only allowed in TypedDict fields"
y: NotRequired[str]

def f():
# error: [invalid-type-form] "`Required` is only allowed in TypedDict fields"
x: Required[int] = 1
# error: [invalid-type-form] "`NotRequired` is only allowed in TypedDict fields"
y: NotRequired[str] = ""
```

### Nested `Required` and `NotRequired`

`Required` and `NotRequired` cannot be nested inside each other:

```py
from typing_extensions import TypedDict, Required, NotRequired

class TD(TypedDict):
# error: [invalid-type-form] "`typing.Required` cannot be nested inside `Required` or `NotRequired`"
a: Required[Required[int]]
# error: [invalid-type-form] "`typing.NotRequired` cannot be nested inside `Required` or `NotRequired`"
b: NotRequired[NotRequired[int]]
# error: [invalid-type-form] "`typing.Required` cannot be nested inside `Required` or `NotRequired`"
c: Required[NotRequired[int]]
# error: [invalid-type-form] "`typing.NotRequired` cannot be nested inside `Required` or `NotRequired`"
d: NotRequired[Required[int]]
```

### `dict`-subclass inhabitants

Values that inhabit a `TypedDict` type must be instances of `dict` itself, not a subclass:
Expand Down
28 changes: 27 additions & 1 deletion crates/ty_python_semantic/src/types/infer/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ use crate::types::generics::{
GenericContext, InferableTypeVars, SpecializationBuilder, bind_typevar,
enclosing_generic_contexts, typing_self,
};
use crate::types::infer::nearest_enclosing_function;
use crate::types::infer::{nearest_enclosing_class, nearest_enclosing_function};
use crate::types::mro::{DynamicMroErrorKind, StaticMroErrorKind};
use crate::types::newtype::NewType;
use crate::types::special_form::AliasSpec;
Expand Down Expand Up @@ -9225,6 +9225,32 @@ impl<'db, 'ast> TypeInferenceBuilder<'db, 'ast> {
}
}
}

// `Required`, `NotRequired`, and `ReadOnly` are only valid inside TypedDict classes.
if declared.qualifiers.intersects(
TypeQualifiers::REQUIRED | TypeQualifiers::NOT_REQUIRED | TypeQualifiers::READ_ONLY,
) {
let in_typed_dict = current_scope.kind() == ScopeKind::Class
&& nearest_enclosing_class(self.db(), self.index, self.scope())
.is_some_and(|class| class.is_typed_dict(self.db()));
if !in_typed_dict {
for qualifier in [
TypeQualifiers::REQUIRED,
TypeQualifiers::NOT_REQUIRED,
TypeQualifiers::READ_ONLY,
] {
if declared.qualifiers.contains(qualifier)
&& let Some(builder) =
self.context.report_lint(&INVALID_TYPE_FORM, annotation)
{
builder.into_diagnostic(format_args!(
"`{name}` is only allowed in TypedDict fields",
name = qualifier.name()
));
}
}
}
}
}

if target
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,23 @@ impl<'db> TypeInferenceBuilder<'db, '_> {
"`ClassVar` cannot contain type variables",
);
}

// Reject nested `Required`/`NotRequired`, e.g.
// `Required[Required[int]]` or `Required[NotRequired[int]]`.
if matches!(
qualifier,
TypeQualifier::Required | TypeQualifier::NotRequired
) && type_and_qualifiers.qualifiers.intersects(
TypeQualifiers::REQUIRED | TypeQualifiers::NOT_REQUIRED,
) && let Some(builder) =
self.context.report_lint(&INVALID_TYPE_FORM, subscript)
{
builder.into_diagnostic(format_args!(
"`{qualifier}` cannot be nested inside \
`Required` or `NotRequired`",
));
}

type_and_qualifiers.with_qualifier(TypeQualifiers::from(qualifier))
} else {
for element in arguments {
Expand Down
Loading