Merge pull request #288 from koxudaxi/support_frozen_on_config

Support frozen on config

resources/META-INF/plugin.xml

@@ -7,6 +7,7 @@
     <h2>version 0.3.1</h2>
     <p>Features</p>
     <ul>
+        <li>Support frozen on config [#288]</li>
         <li>Fix format [#287]</li>
         <li>Improve handling pydantic version [#286]</li>
         <li>Support config parameters on class kwargs [#285]</li>

src/com/koxudaxi/pydantic/Pydantic.kt

@@ -97,6 +97,7 @@ val DEFAULT_CONFIG = mapOf<String, Any?>(
     "allow_population_by_field_name" to false,
     "orm_mode" to false,
     "allow_mutation" to true,
+    "frozen" to false,
     "keep_untouched" to listOf<PyType>()
 )
 
@@ -105,6 +106,7 @@ val CONFIG_TYPES = mapOf(
     "allow_population_by_field_name" to ConfigType.BOOLEAN,
     "orm_mode" to ConfigType.BOOLEAN,
     "allow_mutation" to ConfigType.BOOLEAN,
+    "frozen" to ConfigType.BOOLEAN,
     "keep_untouched" to ConfigType.LIST_PYTYPE
 )
 

src/com/koxudaxi/pydantic/PydanticInspection.kt

@@ -131,11 +131,12 @@ class PydanticInspection : PyInspection() {
             if (!isPydanticModel(pyClass, false, myTypeEvalContext)) return
             val attributeName = (node.leftHandSideExpression as? PyTargetExpressionImpl)?.name ?: return
             val config = getConfig(pyClass, myTypeEvalContext, true)
-            if (config["allow_mutation"] != false) return
-            registerProblem(node,
-                "Property \"${attributeName}\" defined in \"${pyClass.name}\" is read-only",
-                ProblemHighlightType.GENERIC_ERROR)
-
+            val version = PydanticVersionService.getVersion(pyClass.project, myTypeEvalContext)
+            if (config["allow_mutation"] == false || (version?.isAtLeast(1, 8) == true && config["frozen"] == true)) {
+                registerProblem(node,
+                    "Property \"${attributeName}\" defined in \"${pyClass.name}\" is read-only",
+                    ProblemHighlightType.GENERIC_ERROR)
+            }
         }
 
         private fun inspectWarnUntypedFields(node: PyAssignmentStatement) {

testData/inspection/readOnlyProperty.py

@@ -52,4 +52,10 @@ class Config:
 class H:
     class Config:
         allow_mutation=False
-H.abc = '123'
+H.abc = '123'
+
+class I(BaseModel):
+    abc: str = '123'
+    class Config:
+        frozen=False
+I.abc = '456'

testData/inspectionv18/readOnlyProperty.py

@@ -0,0 +1,55 @@
+from pydantic import BaseModel
+
+
+class A(BaseModel):
+    abc: str = '123'
+A.abc = '456'
+A().abc = '456'
+
+class B(BaseModel):
+    abc: str = '123'
+    class Config:
+        allow_mutation=False
+B.abc = '456'
+<error descr="Property \"abc\" defined in \"B\" is read-only">B().abc = '456'</error>
+
+class C(BaseModel):
+    abc: str = '123'
+    class Config:
+        allow_mutation=True
+C.abc = '456'
+C().abc = '456'
+
+class D(BaseModel):
+    class Config:
+        allow_mutation=False
+D.abc = '456'
+<error descr="Property \"abc\" defined in \"D\" is read-only">D().abc = '456'</error>
+
+allow_mutation = True
+class E(BaseModel):
+    class Config:
+        allow_mutation=allow_mutation
+E.abc = '456'
+E().abc = '456'
+
+
+class F(D):
+    class Config:
+        allow_mutation=False
+F.abc = '456'
+<error descr="Property \"abc\" defined in \"F\" is read-only">F().abc = '456'</error>
+
+
+class G(BaseModel):
+    class Config:
+        allow_mutation=False
+G.abc =<EOLError descr="Expression expected"></EOLError>
+G.abc.lower()
+<error descr="Cannot assign to function call">G.abc.lower()</error> = 'efg'
+
+
+class H:
+    class Config:
+        allow_mutation=False
+H.abc = '123'

testData/inspectionv18/readOnlyPropertyFrozen.py

@@ -0,0 +1,55 @@
+from pydantic import BaseModel
+
+
+class A(BaseModel):
+    abc: str = '123'
+A.abc = '456'
+A().abc = '456'
+
+class B(BaseModel):
+    abc: str = '123'
+    class Config:
+        frozen=True
+B.abc = '456'
+<error descr="Property \"abc\" defined in \"B\" is read-only">B().abc = '456'</error>
+
+class C(BaseModel):
+    abc: str = '123'
+    class Config:
+        frozen=False
+C.abc = '456'
+C().abc = '456'
+
+class D(BaseModel):
+    class Config:
+        frozen=True
+D.abc = '456'
+<error descr="Property \"abc\" defined in \"D\" is read-only">D().abc = '456'</error>
+
+frozen = False
+class E(BaseModel):
+    class Config:
+        frozen=frozen
+E.abc = '456'
+E().abc = '456'
+
+
+class F(D):
+    class Config:
+        frozen=True
+F.abc = '456'
+<error descr="Property \"abc\" defined in \"F\" is read-only">F().abc = '456'</error>
+
+
+class G(BaseModel):
+    class Config:
+        frozen=False
+G.abc =<EOLError descr="Expression expected"></EOLError>
+G.abc.lower()
+<error descr="Cannot assign to function call">G.abc.lower()</error> = 'efg'
+
+
+class H:
+    class Config:
+        frozen=True
+H.abc = '123'

testData/mock/pydanticv18/main.py

@@ -38,6 +38,7 @@ class BaseConfig:
     validate_all = False
     extra = Extra.ignore
     allow_mutation = True
+    frozen = False
     allow_population_by_field_name = False
     use_enum_values = False
     fields = {}

testSrc/com/koxudaxi/pydantic/PydanticInspectionV18Test.kt

@@ -16,4 +16,12 @@ open class PydanticInspectionV18Test : PydanticInspectionBase(version = "v18") {
     fun testKwargConfig() {
         doTest()
     }
+
+    fun testReadOnlyProperty() {
+        doTest()
+    }
+
+    fun testReadOnlyPropertyFrozen() {
+        doTest()
+    }
 }