Add AutoString support for Pydantic network types

Author: rmasters

docs/advanced/column-types.md

@@ -112,8 +112,13 @@ In addition, the following types are stored as `VARCHAR`:
 * ipaddress.IPv6Address
 * ipaddress.IPv6Network
 * pathlib.Path
+* pydantic.networks.IPvAnyAddress
+* pydantic.networks.IPvAnyInterface
+* pydantic.networks.IPvAnyNetwork
 * pydantic.EmailStr
 
+Note that while the column types for these are `VARCHAR`, values are not converted to and from strings.   
+
 ### 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.

docs_src/advanced/column_types/tutorial003.py

@@ -1,15 +1,14 @@
-import ipaddress
 from datetime import UTC, datetime
 from pathlib import Path
 from uuid import UUID, uuid4
 
-from pydantic import EmailStr
-from sqlmodel import Field, SQLModel, create_engine
+from pydantic import EmailStr, IPvAnyAddress
+from sqlmodel import Field, Session, SQLModel, create_engine, select
 
 
 class Avatar(SQLModel, table=True):
     id: UUID = Field(default_factory=uuid4, primary_key=True)
-    source_ip_address: ipaddress.IPv4Address
+    source_ip_address: IPvAnyAddress
     upload_location: Path
     uploaded_at: datetime = Field(default=datetime.now(tz=UTC))
     author_email: EmailStr
@@ -20,4 +19,55 @@ class Avatar(SQLModel, table=True):
 
 engine = create_engine(sqlite_url, echo=True)
 
-SQLModel.metadata.create_all(engine)
+
+def create_db_and_tables():
+    SQLModel.metadata.create_all(engine)
+
+
+def create_avatars():
+    avatar_1 = Avatar(
+        source_ip_address="127.0.0.1",
+        upload_location="/uploads/1/123456789.jpg",
+        author_email="[email protected]",
+    )
+
+    avatar_2 = Avatar(
+        source_ip_address="192.168.0.1",
+        upload_location="/uploads/9/987654321.png",
+        author_email="[email protected]",
+    )
+
+    with Session(engine) as session:
+        session.add(avatar_1)
+        session.add(avatar_2)
+
+        session.commit()
+
+
+def read_avatars():
+    with Session(engine) as session:
+        statement = select(Avatar).where(Avatar.author_email == "[email protected]")
+        result = session.exec(statement)
+        avatar_1: Avatar = result.one()
+
+    print(
+        "Avatar 1:",
+        {
+            "email": avatar_1.author_email,
+            "email_type": type(avatar_1.author_email),
+            "ip_address": avatar_1.source_ip_address,
+            "ip_address_type": type(avatar_1.source_ip_address),
+            "upload_location": avatar_1.upload_location,
+            "upload_location_type": type(avatar_1.upload_location),
+        },
+    )
+
+
+def main():
+    create_db_and_tables()
+    create_avatars()
+    read_avatars()
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -56,7 +56,7 @@ typer-cli = "^0.0.13"
 mkdocs-markdownextradata-plugin = ">=0.1.7,<0.3.0"
 # For column type tests
 wonderwords = "^2.2.0"
-geoalchemy2 = "^0.14.3"
+pydantic = {extras = ["email"], version = ">=1.10.13,<3.0.0"}
 
 [build-system]
 requires = ["poetry-core"]

sqlmodel/main.py

@@ -24,8 +24,9 @@
     overload,
 )
 
-from pydantic import BaseModel, EmailStr
+from pydantic import BaseModel
 from pydantic.fields import FieldInfo as PydanticFieldInfo
+from pydantic.networks import EmailStr, IPvAnyAddress, IPvAnyInterface, IPvAnyNetwork
 from sqlalchemy import (
     Boolean,
     Column,
@@ -600,6 +601,12 @@ def get_sqlalchemy_type(field: Any) -> Any:
         return AutoString
     if issubclass(type_, ipaddress.IPv6Network):
         return AutoString
+    if issubclass(type_, IPvAnyAddress):
+        return AutoString
+    if issubclass(type_, IPvAnyInterface):
+        return AutoString
+    if issubclass(type_, IPvAnyNetwork):
+        return AutoString
     if issubclass(type_, Path):
         return AutoString
     if issubclass(type_, EmailStr):

tests/test_advanced/test_column_types/test_tutorial003.py

@@ -0,0 +1,33 @@
+from unittest.mock import patch
+
+from sqlmodel import create_engine
+
+from ...conftest import get_testing_print_function
+
+expected_calls = [
+    [
+        "Avatar 1:",
+        {
+            "email": "[email protected]",
+            "email_type": str,
+            "ip_address": "127.0.0.1",
+            "ip_address_type": str,
+            "upload_location": "/uploads/1/123456789.jpg",
+            "upload_location_type": str,
+        },
+    ],
+]
+
+
+def test_tutorial(clear_sqlmodel):
+    from docs_src.advanced.column_types import tutorial003 as mod
+
+    mod.sqlite_url = "sqlite://"
+    mod.engine = create_engine(mod.sqlite_url)
+    calls = []
+
+    new_print = get_testing_print_function(calls)
+
+    with patch("builtins.print", new=new_print):
+        mod.main()
+    assert calls == expected_calls