feat: file object data type

.pre-commit-config.yaml

@@ -22,7 +22,7 @@ repos:
       - id: unasyncd
         additional_dependencies: ["ruff"]
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.9.7"
+    rev: "v0.9.9"
     hooks:
       # Run the linter.
     - id: ruff

advanced_alchemy/_serialization.py

@@ -5,7 +5,7 @@
 from typing_extensions import runtime_checkable
 
 try:
-    from pydantic import BaseModel  # type: ignore # noqa: PGH003
+    from pydantic import BaseModel  # type: ignore
 
     PYDANTIC_INSTALLED = True
 except ImportError:

advanced_alchemy/alembic/templates/asyncio/env.py

@@ -20,7 +20,7 @@
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
-config: "AlembicCommandConfig" = context.config  # type: ignore  # noqa: PGH003
+config: "AlembicCommandConfig" = context.config  # type: ignore
 writer = rewriter.Rewriter()
 
 

advanced_alchemy/alembic/templates/asyncio/script.py.mako

@@ -12,7 +12,7 @@ from typing import TYPE_CHECKING
 
 import sqlalchemy as sa
 from alembic import op
-from advanced_alchemy.types import EncryptedString, EncryptedText, GUID, ORA_JSONB, DateTimeUTC
+from advanced_alchemy.types import EncryptedString, EncryptedText, GUID, ORA_JSONB, DateTimeUTC, ObjectStore
 from sqlalchemy import Text  # noqa: F401
 ${imports if imports else ""}
 if TYPE_CHECKING:
@@ -25,6 +25,7 @@ sa.DateTimeUTC = DateTimeUTC
 sa.ORA_JSONB = ORA_JSONB
 sa.EncryptedString = EncryptedString
 sa.EncryptedText = EncryptedText
+as.ObjectStore = ObjectStore
 
 # revision identifiers, used by Alembic.
 revision = ${repr(up_revision)}

advanced_alchemy/alembic/templates/sync/env.py

@@ -18,7 +18,7 @@
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
-config: "AlembicCommandConfig" = context.config  # type: ignore  # noqa: PGH003
+config: "AlembicCommandConfig" = context.config  # type: ignore
 writer = rewriter.Rewriter()
 
 

advanced_alchemy/alembic/templates/sync/script.py.mako

@@ -12,7 +12,7 @@ from typing import TYPE_CHECKING
 
 import sqlalchemy as sa
 from alembic import op
-from advanced_alchemy.types import EncryptedString, EncryptedText, GUID, ORA_JSONB, DateTimeUTC
+from advanced_alchemy.types import EncryptedString, EncryptedText, GUID, ORA_JSONB, DateTimeUTC, ObjectStore
 from sqlalchemy import Text  # noqa: F401
 ${imports if imports else ""}
 if TYPE_CHECKING:
@@ -25,6 +25,7 @@ sa.DateTimeUTC = DateTimeUTC
 sa.ORA_JSONB = ORA_JSONB
 sa.EncryptedString = EncryptedString
 sa.EncryptedText = EncryptedText
+as.ObjectStore = ObjectStore
 
 # revision identifiers, used by Alembic.
 revision: str = ${repr(up_revision)}

advanced_alchemy/base.py

@@ -40,7 +40,7 @@
 from advanced_alchemy.mixins import (
     UUIDv7PrimaryKey as _UUIDv7PrimaryKey,
 )
-from advanced_alchemy.types import GUID, DateTimeUTC, JsonB
+from advanced_alchemy.types import GUID, DateTimeUTC, JsonB, ObjectStore, StoredObject
 from advanced_alchemy.utils.dataclass import DataclassProtocol
 from advanced_alchemy.utils.deprecation import warn_deprecation
 
@@ -291,6 +291,7 @@ def create_registry(
         dict[str, Any]: JsonB,
         dict[str, str]: JsonB,
         DataclassProtocol: JsonB,
+        StoredObject: ObjectStore,
     }
     with contextlib.suppress(ImportError):
         from pydantic import AnyHttpUrl, AnyUrl, EmailStr, IPvAnyAddress, IPvAnyInterface, IPvAnyNetwork, Json

advanced_alchemy/extensions/litestar/dto.py

@@ -318,7 +318,7 @@ def generate_field_definitions(cls, model_type: type[DeclarativeBase]) -> Genera
             should_skip_descriptor = False
             dto_field: Optional[DTOField] = None
             if hasattr(orm_descriptor, "property"):  # pyright: ignore[reportUnknownArgumentType]
-                dto_field = orm_descriptor.property.info.get(DTO_FIELD_META_KEY)  # pyright: ignore  # noqa: PGH003
+                dto_field = orm_descriptor.property.info.get(DTO_FIELD_META_KEY)  # pyright: ignore
 
             # Case 1
             is_field_marked_not_private = dto_field and dto_field.mark is not Mark.PRIVATE  # pyright: ignore[reportUnknownVariableType,reportUnknownMemberType]
@@ -358,7 +358,7 @@ def detect_nested_field(cls, field_definition: FieldDefinition) -> bool:
 
 def _detect_defaults(elem: ElementType) -> tuple[Any, Any]:
     default: Any = Empty
-    default_factory: Any = None  # pyright:ignore  # noqa: PGH003
+    default_factory: Any = None  # pyright:ignore
     if sqla_default := getattr(elem, "default", None):
         if sqla_default.is_scalar:
             default = sqla_default.arg

advanced_alchemy/extensions/sanic/extension.py

@@ -16,9 +16,9 @@
     SANIC_INSTALLED = True
 except ModuleNotFoundError:  # pragma: no cover
     SANIC_INSTALLED = False  # pyright: ignore[reportConstantRedefinition]
-    Extension = type("Extension", (), {})  # type: ignore  # noqa: PGH003
-    Extend = type("Extend", (), {})  # type: ignore  # noqa: PGH003
-    Default = type("Default", (), {})  # type: ignore  # noqa: PGH003
+    Extension = type("Extension", (), {})  # type: ignore
+    Extend = type("Extend", (), {})  # type: ignore
+    Default = type("Default", (), {})  # type: ignore
     _default = Default()
 
 if TYPE_CHECKING:

advanced_alchemy/repository/_async.py

@@ -855,7 +855,7 @@ async def delete_where(
                 )
                 result = await self.session.execute(statement)
                 row_count = getattr(result, "rowcount", -2)
-                if sanity_check and row_count >= 0 and len(instances) != row_count:  # pyright: ignore  # noqa: PGH003
+                if sanity_check and row_count >= 0 and len(instances) != row_count:  # pyright: ignore
                     # backends will return a -1 if they can't determine impacted rowcount
                     # only compare length of selected instances to results if it's >= 0
                     await self.session.rollback()
@@ -2172,7 +2172,7 @@ async def count(self, statement: Select[Any], **kwargs: Any) -> int:
             )
             statement = self._filter_statement_by_kwargs(statement, **kwargs)
             results = await self.execute(statement)
-            return results.scalar_one()  # type: ignore  # noqa: PGH003
+            return results.scalar_one()  # type: ignore
 
     async def list_and_count(
         self,

advanced_alchemy/repository/_sync.py

@@ -856,7 +856,7 @@ def delete_where(
                 )
                 result = self.session.execute(statement)
                 row_count = getattr(result, "rowcount", -2)
-                if sanity_check and row_count >= 0 and len(instances) != row_count:  # pyright: ignore  # noqa: PGH003
+                if sanity_check and row_count >= 0 and len(instances) != row_count:  # pyright: ignore
                     # backends will return a -1 if they can't determine impacted rowcount
                     # only compare length of selected instances to results if it's >= 0
                     self.session.rollback()
@@ -2169,7 +2169,7 @@ def count(self, statement: Select[Any], **kwargs: Any) -> int:
             )
             statement = self._filter_statement_by_kwargs(statement, **kwargs)
             results = self.execute(statement)
-            return results.scalar_one()  # type: ignore  # noqa: PGH003
+            return results.scalar_one()  # type: ignore
 
     def list_and_count(
         self,

advanced_alchemy/repository/memory/_async.py

@@ -329,11 +329,11 @@ def _apply_filters(
                 )
 
             elif isinstance(filter_, NotInCollectionFilter):
-                if filter_.values is not None:  # pyright: ignore  # noqa: PGH003
-                    result = self._filter_not_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore  # noqa: PGH003
+                if filter_.values is not None:  # pyright: ignore
+                    result = self._filter_not_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore
             elif isinstance(filter_, CollectionFilter):
-                if filter_.values is not None:  # pyright: ignore  # noqa: PGH003
-                    result = self._filter_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore  # noqa: PGH003
+                if filter_.values is not None:  # pyright: ignore
+                    result = self._filter_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore
             elif isinstance(filter_, OrderBy):
                 result = self._order_by(
                     result,

advanced_alchemy/repository/memory/_sync.py

@@ -330,11 +330,11 @@ def _apply_filters(
                 )
 
             elif isinstance(filter_, NotInCollectionFilter):
-                if filter_.values is not None:  # pyright: ignore  # noqa: PGH003
-                    result = self._filter_not_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore  # noqa: PGH003
+                if filter_.values is not None:  # pyright: ignore
+                    result = self._filter_not_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore
             elif isinstance(filter_, CollectionFilter):
-                if filter_.values is not None:  # pyright: ignore  # noqa: PGH003
-                    result = self._filter_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore  # noqa: PGH003
+                if filter_.values is not None:  # pyright: ignore
+                    result = self._filter_in_collection(result, filter_.field_name, filter_.values)  # pyright: ignore
             elif isinstance(filter_, OrderBy):
                 result = self._order_by(
                     result,

advanced_alchemy/types/__init__.py

@@ -6,11 +6,13 @@
     FernetBackend,
     PGCryptoBackend,
 )
+from advanced_alchemy.types.file_object import FSSPEC_INSTALLED, ObjectStore, StoredObject
 from advanced_alchemy.types.guid import GUID, NANOID_INSTALLED, UUID_UTILS_INSTALLED
 from advanced_alchemy.types.identity import BigIntIdentity
 from advanced_alchemy.types.json import ORA_JSONB, JsonB
 
 __all__ = (
+    "FSSPEC_INSTALLED",
     "GUID",
     "NANOID_INSTALLED",
     "ORA_JSONB",
@@ -22,5 +24,8 @@
     "EncryptionBackend",
     "FernetBackend",
     "JsonB",
+    "ObjectStore",
+    "ObjectStore",
     "PGCryptoBackend",
+    "StoredObject",
 )