Respect msgspec.Struct's default-copy semantics

astral-sh · Oct 3, 2023 · eeb23c7 · eeb23c7
1 parent 37d21c0
commit eeb23c7
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 6 deletions.
diff --git a/crates/ruff_linter/resources/test/fixtures/ruff/RUF012.py b/crates/ruff_linter/resources/test/fixtures/ruff/RUF012.py
@@ -37,3 +37,14 @@ class D(BaseModel):
     without_annotation = []
     class_variable: ClassVar[list[int]] = []
     final_variable: Final[list[int]] = []
+
+
+from msgspec import Struct
+
+
+class E(Struct):
+    mutable_default: list[int] = []
+    immutable_annotation: Sequence[int] = []
+    without_annotation = []
+    class_variable: ClassVar[list[int]] = []
+    final_variable: Final[list[int]] = []
diff --git a/crates/ruff_linter/src/rules/ruff/rules/helpers.rs b/crates/ruff_linter/src/rules/ruff/rules/helpers.rs
@@ -49,8 +49,14 @@ pub(super) fn is_dataclass(class_def: &ast::StmtClassDef, semantic: &SemanticMod
     })
 }
 
-/// Returns `true` if the given class is a Pydantic `BaseModel` or `BaseSettings` subclass.
-pub(super) fn is_pydantic_model(class_def: &ast::StmtClassDef, semantic: &SemanticModel) -> bool {
+/// Returns `true` if the given class has "default copy" semantics.
+///
+/// For example, Pydantic `BaseModel` and `BaseSettings` subclassses copy attribute defaults on
+/// instance creation. As such, the use of mutable default values is safe for such classes.
+pub(super) fn has_default_copy_semantics(
+    class_def: &ast::StmtClassDef,
+    semantic: &SemanticModel,
+) -> bool {
     let Some(Arguments { args: bases, .. }) = class_def.arguments.as_deref() else {
         return false;
     };
@@ -59,7 +65,7 @@ pub(super) fn is_pydantic_model(class_def: &ast::StmtClassDef, semantic: &Semant
         semantic.resolve_call_path(expr).is_some_and(|call_path| {
             matches!(
                 call_path.as_slice(),
-                ["pydantic", "BaseModel" | "BaseSettings"]
+                ["pydantic", "BaseModel" | "BaseSettings"] | ["msgspec", "Struct"]
             )
         })
     })

diff --git a/crates/ruff_linter/src/rules/ruff/rules/mutable_class_default.rs b/crates/ruff_linter/src/rules/ruff/rules/mutable_class_default.rs
@@ -7,7 +7,7 @@ use ruff_text_size::Ranged;
 
 use crate::checkers::ast::Checker;
 use crate::rules::ruff::rules::helpers::{
-    is_class_var_annotation, is_dataclass, is_final_annotation, is_pydantic_model,
+    has_default_copy_semantics, is_class_var_annotation, is_dataclass, is_final_annotation,
     is_special_attribute,
 };
 
@@ -65,7 +65,7 @@ pub(crate) fn mutable_class_default(checker: &mut Checker, class_def: &ast::Stmt
                     && !is_dataclass(class_def, checker.semantic())
                 {
                     // Avoid Pydantic models, which end up copying defaults on instance creation.
-                    if is_pydantic_model(class_def, checker.semantic()) {
+                    if has_default_copy_semantics(class_def, checker.semantic()) {
                         return;
                     }
 
@@ -79,7 +79,7 @@ pub(crate) fn mutable_class_default(checker: &mut Checker, class_def: &ast::Stmt
                     && is_mutable_expr(value, checker.semantic())
                 {
                     // Avoid Pydantic models, which end up copying defaults on instance creation.
-                    if is_pydantic_model(class_def, checker.semantic()) {
+                    if has_default_copy_semantics(class_def, checker.semantic()) {
                         return;
                     }