Merge pull request #5 from cofin/main

Enhancement: Add `str` type hint and validator for `email` field

Author: Goldziher

pydantic_openapi_schema/v3_0_3/contact.py

@@ -1,6 +1,6 @@
-from typing import Optional
+from typing import Optional, Union
 
-from pydantic import AnyUrl, BaseModel, EmailStr, Extra
+from pydantic import AnyUrl, BaseModel, EmailStr, Extra, validator
 
 
 class Contact(BaseModel):
@@ -18,11 +18,31 @@ class Contact(BaseModel):
     The URL pointing to the contact information. MUST be in the format of a URL.
     """
 
-    email: Optional[EmailStr] = None
+    email: Optional[Union[EmailStr, str]] = None
     """
     The email address of the contact person/organization. MUST be in the format of an email address.
     """
 
+    @validator("email", pre=True)
+    def validate_email(  # pylint: disable=no-self-argument
+        cls,
+        v: Union[EmailStr, str],
+    ) -> EmailStr:
+        """Validates that email is a valid email address
+
+        Args:
+            v (EmailStr|str): Holds the email string to be validated
+
+        Raises:
+            ValueError: Value is not a valid email address
+
+        Returns:
+            _type_: CompressionBackend
+        """
+        if isinstance(v, str):
+            v = EmailStr(v)
+        return v
+
     class Config:
         extra = Extra.ignore
         schema_extra = {

pydantic_openapi_schema/v3_1_0/contact.py

@@ -1,6 +1,6 @@
-from typing import Optional
+from typing import Optional, Union
 
-from pydantic import AnyUrl, BaseModel, EmailStr, Extra
+from pydantic import AnyUrl, BaseModel, EmailStr, Extra, validator
 
 
 class Contact(BaseModel):
@@ -25,6 +25,26 @@ class Contact(BaseModel):
     MUST be in the form of an email address.
     """
 
+    @validator("email", pre=True)
+    def validate_email(  # pylint: disable=no-self-argument
+        cls,
+        v: Union[EmailStr, str],
+    ) -> EmailStr:
+        """Validates that email is a valid email address
+
+        Args:
+            v (EmailStr|str): Holds the email string to be validated
+
+        Raises:
+            ValueError: Value is not a valid email address
+
+        Returns:
+            _type_: CompressionBackend
+        """
+        if isinstance(v, str):
+            v = EmailStr(v)
+        return v
+
     class Config:
         extra = Extra.ignore
         schema_extra = {

pyproject.toml

@@ -71,7 +71,7 @@ max-line-length = "120"
 ignored-argument-names = "args|kwargs|_|__"
 
 [tool.pylint.BASIC]
-good-names = "_,i,e,fn"
+good-names = "_,i,e,fn,v"
 
 [tool.coverage.run]
 omit = ["*/tests/*"]