prepare v1.2 (pydantic#1042)

* making field-reuse idempotent (pydantic#1016)

* making field-reuse idempotent

* fix for 3.6

* correct change details

* uprev

* generate HISTORY.md

Author: samuelcolvin

HISTORY.md

@@ -1,3 +1,26 @@
+## v1.2 (2019-11-28)
+
+* Add benchmarks for `cattrs`, #513 by @sebastianmika
+* Add `exclude_none` option to `dict()` and friends, #587 by @niknetniko
+* Add benchmarks for `valideer`, #670 by @gsakkis
+* Add `parse_obj_as` and `parse_file_as` functions for ad-hoc parsing of data into arbitrary pydantic-compatible types, #934 by @dmontagu
+* Add `allow_reuse` argument to validators, thus allowing validator reuse, #940 by @dmontagu
+* Add support for mapping types for custom root models, #958 by @dmontagu
+* Mypy plugin support for dataclasses, #966 by @koxudaxi
+* Add support for dataclasses default factory, #968 by @ahirner
+* Add a `ByteSize` type for converting byte string (`1GB`) to plain bytes, #977 by @dgasmith
+* Fix mypy complaint about `@root_validator(pre=True)`, #984 by @samuelcolvin
+* Add manylinux binaries for python 3.8 to pypi, also support manylinux2010, #994 by @samuelcolvin
+* Adds ByteSize conversion to another unit, #995 by @dgasmith
+* Fix `__str__` and `__repr__` inheritance for models, #1022 by @samuelcolvin
+* add testimonials section to docs, #1025 by @sullivancolin
+* Add support for `typing.Literal` for Python 3.8, #1026 by @dmontagu
+* Add support for required `Optional` with `name: Optional[AnyType] = Field(...)` and refactor `ModelField` creation to preserve `required` parameter value, #1031 by @tiangolo
+
+## v1.1.1 (2019-11-20)
+
+* Fix bug where use of complex fields on sub-models could cause fields to be incorrectly configured, #1015 by @samuelcolvin
+
 ## v1.1 (2019-11-07)
 
 * Add a mypy plugin for type checking `BaseModel.__init__` and more, #722 by @dmontagu

changes/1022-samuelcolvin.md

@@ -289,6 +289,12 @@ def alt_alias(self) -> bool:
         return self.name != self.alias
 
     def prepare(self) -> None:
+        """
+        Prepare the field but inspecting self.default, self.type_ etc.
+
+        Note: this method is **not** idempotent (because _type_analysis is not idempotent),
+        e.g. calling it it multiple times may modify the field and configure it incorrectly.
+        """
         if self.default is not None and self.type_ is None:
             self.type_ = type(self.default)
 
@@ -313,7 +319,7 @@ def prepare(self) -> None:
             self.field_info.default = Required
         if self.default is Undefined:
             self.default = None
-        self._populate_validators()
+        self.populate_validators()
 
     def _type_analysis(self) -> None:  # noqa: C901 (ignore complexity)
         # typing interface is horrible, we have to do some ugly checks
@@ -419,7 +425,12 @@ def _create_sub_type(self, type_: AnyType, name: str, *, for_keys: bool = False)
             model_config=self.model_config,
         )
 
-    def _populate_validators(self) -> None:
+    def populate_validators(self) -> None:
+        """
+        Prepare self.pre_validators, self.validators, and self.post_validators based on self.type_'s  __get_validators__
+        and class validators. This method should be idempotent, e.g. it should be safe to call multiple times
+        without mis-configuring the field.
+        """
         class_validators_ = self.class_validators.values()
         if not self.sub_fields:
             get_validators = getattr(self.type_, '__get_validators__', None)

changes/1025-sullivancolin.md

@@ -166,7 +166,7 @@ def __new__(mcs, name, bases, namespace, **kwargs):  # noqa C901
             if extra_validators:
                 f.class_validators.update(extra_validators)
                 # re-run prepare to add extra validators
-                f.prepare()
+                f.populate_validators()
 
         prepare_config(config, name)
 

changes/1026-dmontagu.md

@@ -2,4 +2,4 @@
 
 __all__ = ['VERSION']
 
-VERSION = StrictVersion('1.2a1')
+VERSION = StrictVersion('1.2')

changes/1031-tiangolo.md

@@ -1305,6 +1305,25 @@ class MyModel(BaseModel):
     assert m.foo == {'x': 'a', 'y': None}
 
 
+def test_modify_fields():
+    class Foo(BaseModel):
+        foo: List[List[int]]
+
+        @validator('foo')
+        def check_something(cls, value):
+            return value
+
+    class Bar(Foo):
+        pass
+
+    # output is slightly different for 3.6
+    if sys.version_info >= (3, 7):
+        assert repr(Foo.__fields__['foo']) == "ModelField(name='foo', type=List[List[int]], required=True)"
+        assert repr(Bar.__fields__['foo']) == "ModelField(name='foo', type=List[List[int]], required=True)"
+    assert Foo(foo=[[0, 1]]).foo == [[0, 1]]
+    assert Bar(foo=[[0, 1]]).foo == [[0, 1]]
+
+
 def test_exclude_none():
     class MyModel(BaseModel):
         a: Optional[int] = None