mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-30 05:44:56 +00:00
[ty] synthesize __replace__
for dataclasses (>=3.13) (#19545)
Some checks are pending
CI / mkdocs (push) Waiting to run
CI / Determine changes (push) Waiting to run
CI / cargo fmt (push) Waiting to run
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / check playground (push) Blocked by required conditions
CI / benchmarks-instrumented (push) Blocked by required conditions
CI / benchmarks-walltime (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
Some checks are pending
CI / mkdocs (push) Waiting to run
CI / Determine changes (push) Waiting to run
CI / cargo fmt (push) Waiting to run
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / check playground (push) Blocked by required conditions
CI / benchmarks-instrumented (push) Blocked by required conditions
CI / benchmarks-walltime (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
## Summary https://github.com/astral-sh/ty/issues/111 adds support for the new `copy.replace` and `__replace__` protocol [added in 3.13](https://docs.python.org/3/whatsnew/3.13.html#copy) - docs: https://docs.python.org/3/library/copy.html#object.__replace__ - some discussion on pyright/mypy implementations: https://discuss.python.org/t/dataclass-transform-and-replace/69067 ### Burndown - [x] add tests - [x] implement `__replace__` - [ ] [collections.namedtuple()](https://docs.python.org/3/library/collections.html#collections.namedtuple) - [x] [dataclasses.dataclass](https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass) ## Test Plan new mdtests --------- Co-authored-by: David Peter <mail@david-peter.de>
This commit is contained in:
parent
81867ea7ce
commit
656273bf3d
2 changed files with 96 additions and 22 deletions
|
@ -1596,7 +1596,10 @@ impl<'db> ClassLiteral<'db> {
|
|||
|
||||
let field_policy = CodeGeneratorKind::from_class(db, self)?;
|
||||
|
||||
let signature_from_fields = |mut parameters: Vec<_>| {
|
||||
let instance_ty =
|
||||
Type::instance(db, self.apply_optional_specialization(db, specialization));
|
||||
|
||||
let signature_from_fields = |mut parameters: Vec<_>, return_ty: Option<Type<'db>>| {
|
||||
let mut kw_only_field_seen = false;
|
||||
for (
|
||||
field_name,
|
||||
|
@ -1669,21 +1672,26 @@ impl<'db> ClassLiteral<'db> {
|
|||
}
|
||||
}
|
||||
|
||||
let mut parameter = if kw_only_field_seen {
|
||||
let mut parameter = if kw_only_field_seen || name == "__replace__" {
|
||||
Parameter::keyword_only(field_name)
|
||||
} else {
|
||||
Parameter::positional_or_keyword(field_name)
|
||||
}
|
||||
.with_annotated_type(field_ty);
|
||||
|
||||
if let Some(default_ty) = default_ty {
|
||||
if name == "__replace__" {
|
||||
// When replacing, we know there is a default value for the field
|
||||
// (the value that is currently assigned to the field)
|
||||
// assume this to be the declared type of the field
|
||||
parameter = parameter.with_default_type(field_ty);
|
||||
} else if let Some(default_ty) = default_ty {
|
||||
parameter = parameter.with_default_type(default_ty);
|
||||
}
|
||||
|
||||
parameters.push(parameter);
|
||||
}
|
||||
|
||||
let mut signature = Signature::new(Parameters::new(parameters), Some(Type::none(db)));
|
||||
let mut signature = Signature::new(Parameters::new(parameters), return_ty);
|
||||
signature.inherited_generic_context = self.generic_context(db);
|
||||
Some(CallableType::function_like(db, signature))
|
||||
};
|
||||
|
@ -1701,16 +1709,13 @@ impl<'db> ClassLiteral<'db> {
|
|||
|
||||
let self_parameter = Parameter::positional_or_keyword(Name::new_static("self"))
|
||||
// TODO: could be `Self`.
|
||||
.with_annotated_type(Type::instance(
|
||||
db,
|
||||
self.apply_optional_specialization(db, specialization),
|
||||
));
|
||||
signature_from_fields(vec![self_parameter])
|
||||
.with_annotated_type(instance_ty);
|
||||
signature_from_fields(vec![self_parameter], Some(Type::none(db)))
|
||||
}
|
||||
(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])
|
||||
signature_from_fields(vec![cls_parameter], Some(Type::none(db)))
|
||||
}
|
||||
(CodeGeneratorKind::DataclassLike, "__lt__" | "__le__" | "__gt__" | "__ge__") => {
|
||||
if !has_dataclass_param(DataclassParams::ORDER) {
|
||||
|
@ -1721,16 +1726,10 @@ impl<'db> ClassLiteral<'db> {
|
|||
Parameters::new([
|
||||
Parameter::positional_or_keyword(Name::new_static("self"))
|
||||
// TODO: could be `Self`.
|
||||
.with_annotated_type(Type::instance(
|
||||
db,
|
||||
self.apply_optional_specialization(db, specialization),
|
||||
)),
|
||||
.with_annotated_type(instance_ty),
|
||||
Parameter::positional_or_keyword(Name::new_static("other"))
|
||||
// TODO: could be `Self`.
|
||||
.with_annotated_type(Type::instance(
|
||||
db,
|
||||
self.apply_optional_specialization(db, specialization),
|
||||
)),
|
||||
.with_annotated_type(instance_ty),
|
||||
]),
|
||||
Some(KnownClass::Bool.to_instance(db)),
|
||||
);
|
||||
|
@ -1745,15 +1744,20 @@ impl<'db> ClassLiteral<'db> {
|
|||
.place
|
||||
.ignore_possibly_unbound()
|
||||
}
|
||||
(CodeGeneratorKind::DataclassLike, "__replace__")
|
||||
if Program::get(db).python_version(db) >= PythonVersion::PY313 =>
|
||||
{
|
||||
let self_parameter = Parameter::positional_or_keyword(Name::new_static("self"))
|
||||
.with_annotated_type(instance_ty);
|
||||
|
||||
signature_from_fields(vec![self_parameter], Some(instance_ty))
|
||||
}
|
||||
(CodeGeneratorKind::DataclassLike, "__setattr__") => {
|
||||
if has_dataclass_param(DataclassParams::FROZEN) {
|
||||
let signature = Signature::new(
|
||||
Parameters::new([
|
||||
Parameter::positional_or_keyword(Name::new_static("self"))
|
||||
.with_annotated_type(Type::instance(
|
||||
db,
|
||||
self.apply_optional_specialization(db, specialization),
|
||||
)),
|
||||
.with_annotated_type(instance_ty),
|
||||
Parameter::positional_or_keyword(Name::new_static("name")),
|
||||
Parameter::positional_or_keyword(Name::new_static("value")),
|
||||
]),
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue