Add __pydantic_private__ (#640)

Author: dmontagu

pydantic_core/core_schema.py

@@ -2912,7 +2912,12 @@ def model_schema(
     from pydantic_core import CoreConfig, SchemaValidator, core_schema
 
     class MyModel:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = (
+            '__dict__',
+            '__pydantic_fields_set__',
+            '__pydantic_extra__',
+            '__pydantic_private__',
+        )
 
     schema = core_schema.model_schema(
         cls=MyModel,
@@ -3407,7 +3412,12 @@ def json_schema(
     )
 
     class MyModel:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = (
+            '__dict__',
+            '__pydantic_fields_set__',
+            '__pydantic_extra__',
+            '__pydantic_private__',
+        )
         field_a: str
         field_b: bool
 

src/validators/model.rs

@@ -20,6 +20,7 @@ const ROOT_FIELD: &str = "root";
 const DUNDER_DICT: &str = "__dict__";
 const DUNDER_FIELDS_SET_KEY: &str = "__pydantic_fields_set__";
 const DUNDER_MODEL_EXTRA_KEY: &str = "__pydantic_extra__";
+const DUNDER_MODEL_PRIVATE_KEY: &str = "__pydantic_private__";
 
 #[derive(Debug, Clone)]
 pub(super) enum Revalidate {
@@ -363,6 +364,7 @@ fn set_model_attrs(instance: &PyAny, model_dict: &PyAny, model_extra: &PyAny, fi
     let py = instance.py();
     force_setattr(py, instance, intern!(py, DUNDER_DICT), model_dict)?;
     force_setattr(py, instance, intern!(py, DUNDER_MODEL_EXTRA_KEY), model_extra)?;
+    force_setattr(py, instance, intern!(py, DUNDER_MODEL_PRIVATE_KEY), py.None())?;
     force_setattr(py, instance, intern!(py, DUNDER_FIELDS_SET_KEY), fields_set)?;
     Ok(())
 }

tests/benchmarks/complete_schema.py

@@ -1,7 +1,7 @@
 def schema(*, strict: bool = False) -> dict:
     class MyModel:
         # __slots__ is not required, but it avoids __pydantic_fields_set__ falling into __dict__
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
     def append_func(input_value, info):
         return f'{input_value} Changed'

tests/benchmarks/test_micro_benchmarks.py

@@ -41,7 +41,7 @@ class PydanticModel(BaseModel):
     @pytest.fixture(scope='class')
     def core_validator_fs(self):
         class CoreModel:
-            __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+            __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
         return SchemaValidator(
             {
@@ -101,7 +101,7 @@ class TestModelLarge:
     @pytest.fixture(scope='class')
     def core_model_validator(self):
         class CoreModel:
-            __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+            __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
         return SchemaValidator(
             {
@@ -193,7 +193,7 @@ def test_small_class_core_dict(benchmark):
 def test_small_class_core_model(benchmark):
     class MyCoreModel:
         # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         # these are here just as decoration
         name: str
         age: int
@@ -344,7 +344,7 @@ class PydanticBranch(BaseModel):
 def test_definition_model_core(definition_model_data, benchmark):
     class CoreBranch:
         # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
     v = SchemaValidator(
         {
@@ -678,7 +678,7 @@ def test_many_models_core_dict(benchmark):
 @pytest.mark.benchmark(group='List[SimpleMode]')
 def test_many_models_core_model(benchmark):
     class MyCoreModel:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
     v = SchemaValidator(
         {
@@ -745,7 +745,7 @@ class PydanticModel(BaseModel):
     @pytest.fixture(scope='class')
     def core_validator(self):
         class CoreModel:
-            __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+            __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
         return SchemaValidator(
             {
@@ -1234,7 +1234,7 @@ def test_definition_out_of_tree(benchmark):
 @pytest.mark.benchmark(group='model_instance')
 def test_model_instance(benchmark):
     class MyModel:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
         def __init__(self, **d):
             self.__dict__ = d
@@ -1271,7 +1271,7 @@ def __instancecheck__(self, instance) -> bool:
             return hasattr(instance, '__pydantic_validator__') and super().__instancecheck__(instance)
 
     class BaseModel(metaclass=MyMeta):
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         __pydantic_validator__ = True
 
         def __init__(self, **d):

tests/benchmarks/test_serialization_micro.py

@@ -23,7 +23,7 @@ class PydanticModel(BaseModel):
     @pytest.fixture(scope='class')
     def core_schema(self):
         class CoreModel:
-            __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+            __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
         return {
             'type': 'model',
@@ -335,7 +335,7 @@ def test_core_model_json_extra(benchmark, basic_model_serializer_extra):
 
 
 class FieldsSetModel:
-    __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+    __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
     def __init__(self, **kwargs):
         for key, value in kwargs.items():

tests/serializers/test_any.py

@@ -258,7 +258,7 @@ def test_exclude_dict(any_serializer):
 
 class FieldsSetModel:
     __pydantic_serializer__ = 42
-    __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+    __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
     def __init__(self, **kwargs):
         fields = {}

tests/serializers/test_model.py

@@ -251,7 +251,7 @@ def test_exclude_none():
 
 
 class FieldsSetModel:
-    __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+    __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
     def __init__(self, **kwargs):
         for key, value in kwargs.items():
@@ -756,7 +756,7 @@ def random_n(self) -> int:
 def test_extra():
     class MyModel:
         # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         field_a: str
         field_b: int
 
@@ -813,7 +813,7 @@ class MyModel:
 def test_extra_config():
     class MyModel:
         # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         field_a: str
         field_b: int
 

tests/test_config.py

@@ -34,7 +34,7 @@ def test_field_priority_arg():
 
 class MyModel:
     # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-    __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+    __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
 
 def test_on_model_class():

tests/test_misc.py

@@ -98,7 +98,7 @@ def test_custom_title():
 def test_validation_error_multiple():
     class MyModel:
         # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         field_a: str
         field_b: int
 

tests/test_schema_functions.py

@@ -17,7 +17,7 @@ def make_5():
 
 
 class MyModel:
-    __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+    __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
 
 
 @dataclasses.dataclass

tests/validators/test_definitions_recursive.py

@@ -236,7 +236,7 @@ class Bar:
 def test_model_class():
     class Branch:
         # this is not required, but it avoids `__pydantic_fields_set__` being included in `__dict__`
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         # these are here just as decoration
         width: int
         branch: Optional['Branch']

tests/validators/test_function.py

@@ -462,7 +462,7 @@ def f(input_value):
         return input_value
 
     class Model:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         field_a: str
 
     v = SchemaValidator(
@@ -785,7 +785,7 @@ def f(input_value: Any, info: core_schema.ValidationInfo) -> Any:
 
 def test_non_model_field_wrap_validator_tries_to_access_field_info() -> None:
     class Model:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         x: str
 
     def f(input_value: Any, val: core_schema.ValidatorFunctionWrapHandler, info: core_schema.ValidationInfo) -> Any:
@@ -867,7 +867,7 @@ def test_model_root_function_assignment(mode: str, calls1: Any, calls2: Any):
     calls: list[Any] = []
 
     class Model:
-        __slots__ = '__dict__', '__pydantic_extra__', '__pydantic_fields_set__'
+        __slots__ = '__dict__', '__pydantic_fields_set__', '__pydantic_extra__', '__pydantic_private__'
         x: str
         y: int