Fix pydantic/semver example

mssalvatore · mssalvatore · commit 35da4f6715ce · 2023-01-31T09:06:15.000-05:00
The current example, when used with semver 3.0.0.dev4 and pydantic
1.10.4, produces the following error:

  pydantic.errors.ConfigError: Invalid signature for validator &lt;bound
  method Version.parse of &lt;class '__main__.PydanticVersion'&gt;&gt;: (version:
  Union[str, bytes], optional_minor_and_patch: bool = False) -&gt;
  'Version', should be: (value, values, config, field), "values",
  "config" and "field" are all optional.

This commit fixes the example in the documentation so that it works and
does not raise an error.
diff --git a/changelog.d/pr392.doc.rst b/changelog.d/pr392.doc.rst
@@ -0,0 +1 @@
+Fix the example in the documentation for combining semver and pydantic.
diff --git a/docs/advanced/combine-pydantic-and-semver.rst b/docs/advanced/combine-pydantic-and-semver.rst
@@ -17,10 +17,14 @@ To work with Pydantic, use the following steps:
         from semver import Version
 
         class PydanticVersion(Version):
+            @classmethod
+            def _parse(cls, version):
+                return cls.parse(version)
+
             @classmethod
             def __get_validators__(cls):
                 """Return a list of validator methods for pydantic models."""
-                yield cls.parse
+                yield cls._parse
 
             @classmethod
             def __modify_schema__(cls, field_schema):

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Fix the example in the documentation for combining semver and pydantic.`