Add support for pydantic.EmailStr

Author: rmasters

docs/advanced/column-types.md

@@ -112,21 +112,22 @@ In addition, the following types are stored as `VARCHAR`:
 * ipaddress.IPv6Address
 * ipaddress.IPv6Network
 * pathlib.Path
+* pydantic.EmailStr
 
 ### IP Addresses
 
 IP Addresses from the <a href="https://docs.python.org/3/library/ipaddress.html" class="external-link" target="_blank">Python `ipaddress` module</a> are stored as text.
 
-```Python hl_lines="1 11"
-{!./docs_src/advanced/column_types/tutorial003.py[ln:1-13]!}
+```Python hl_lines="1 12"
+{!./docs_src/advanced/column_types/tutorial003.py[ln:1-15]!}
 ```
 
 ### Filesystem Paths
 
 Paths to files and directories using the <a href="https://docs.python.org/3/library/pathlib.html" class="external-link" target="_blank">Python `pathlib` module</a> are stored as text.
 
-```Python hl_lines="3 12"
-{!./docs_src/advanced/column_types/tutorial003.py[ln:1-13]!}
+```Python hl_lines="3 13"
+{!./docs_src/advanced/column_types/tutorial003.py[ln:1-15]!}
 ```
 
 /// tip
@@ -141,8 +142,17 @@ ensure you call `absolute()` on the path before setting it in your model.
 UUIDs from the <a href="https://docs.python.org/3/library/uuid.html" class="external-link" target="_blank">Python `uuid`
 module</a> are stored as `UUID` types in supported databases (just PostgreSQL at the moment), otherwise as a `CHAR(32)`.
 
-```Python hl_lines="4 10"
-{!./docs_src/advanced/column_types/tutorial003.py[ln:1-13]!}
+```Python hl_lines="4 11"
+{!./docs_src/advanced/column_types/tutorial003.py[ln:1-15]!}
+```
+
+### Email Addresses
+
+Email addresses using <a href="https://docs.pydantic.dev/latest/api/networks/#pydantic.networks.EmailStr" class="external-link" target="_blank">Pydantic's `EmailStr` type</a>
+are stored as strings.
+
+```Python hl_lines="6 15"
+{!./docs_src/advanced/column_types/tutorial003.py[ln:1-15]!}
 ```
 
 ## Custom Pydantic types

docs_src/advanced/column_types/tutorial003.py

@@ -3,6 +3,7 @@
 from pathlib import Path
 from uuid import UUID, uuid4
 
+from pydantic import EmailStr
 from sqlmodel import Field, SQLModel, create_engine
 
 
@@ -11,6 +12,7 @@ class Avatar(SQLModel, table=True):
     source_ip_address: ipaddress.IPv4Address
     upload_location: Path
     uploaded_at: datetime = Field(default=datetime.now(tz=UTC))
+    author_email: EmailStr
 
 
 sqlite_file_name = "database.db"

sqlmodel/main.py

@@ -24,7 +24,7 @@
     overload,
 )
 
-from pydantic import BaseModel
+from pydantic import BaseModel, EmailStr
 from pydantic.fields import FieldInfo as PydanticFieldInfo
 from sqlalchemy import (
     Boolean,
@@ -602,6 +602,8 @@ def get_sqlalchemy_type(field: Any) -> Any:
         return AutoString
     if issubclass(type_, Path):
         return AutoString
+    if issubclass(type_, EmailStr):
+        return AutoString
     if issubclass(type_, uuid.UUID):
         return GUID
     raise ValueError(f"{type_} has no matching SQLAlchemy type")