Skip to content

Commit d916c52

Browse files
authored
chore(docs): update imports and types (#478)
1 parent 53cb348 commit d916c52

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

docs/usage/types.rst

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Here's a short example using multiple types:
1515

1616
.. code-block:: python
1717
18+
from typing import Optional
19+
from uuid import UUID
20+
from datetime import datetime
1821
from sqlalchemy.orm import Mapped, mapped_column
1922
from advanced_alchemy.base import DefaultBase
2023
from advanced_alchemy.types import (
@@ -23,6 +26,7 @@ Here's a short example using multiple types:
2326
GUID,
2427
JsonB,
2528
StoredObject,
29+
FileObject,
2630
)
2731
2832
class User(DefaultBase):
@@ -34,8 +38,8 @@ Here's a short example using multiple types:
3438
avatar: Mapped[Optional[FileObject]] = mapped_column(StoredObject(backend="local_store"))
3539
3640
37-
DateTimeUTC
38-
-----------
41+
DateTime UTC
42+
------------
3943

4044
- Ensures all datetime values are stored in UTC
4145
- Requires timezone information for input values
@@ -44,6 +48,7 @@ DateTimeUTC
4448

4549
.. code-block:: python
4650
51+
from datetime import datetime
4752
from sqlalchemy.orm import Mapped, mapped_column
4853
from advanced_alchemy.base import DefaultBase
4954
from advanced_alchemy.types import DateTimeUTC
@@ -114,8 +119,8 @@ A platform-independent GUID/UUID type that adapts to different database backends
114119
__tablename__ = "my_model"
115120
id: Mapped[UUID] = mapped_column(GUID, primary_key=True)
116121
117-
BigIntIdentity
118-
--------------
122+
BigInt Identity
123+
---------------
119124

120125
A BigInteger type that automatically falls back to Integer for SQLite:
121126

@@ -161,7 +166,7 @@ A type for storing password hashes with configurable backends. Currently suppor
161166
from sqlalchemy.orm import Mapped, mapped_column
162167
from advanced_alchemy.base import DefaultBase
163168
from advanced_alchemy.types import PasswordHash
164-
from advanced_alchemy.types.password_hash.passlib import PasslibHasher
169+
from advanced_alchemy.types.password_hash.pwdlib import PwdlibHasher
165170
from pwdlib.hashers.argon2 import Argon2Hasher as PwdlibArgon2Hasher
166171
167172
class MyModel(DefaultBase):
@@ -180,9 +185,10 @@ Basic Usage
180185

181186
.. code-block:: python
182187
183-
from sqlalchemy.orm import Mapped, mapped_column
188+
from typing import Optional
184189
from advanced_alchemy.base import UUIDBase
185-
from advanced_alchemy.types.file_object import FileObject, StoredObject
190+
from advanced_alchemy.types.file_object import FileObject, FileObjectList, StoredObject
191+
from sqlalchemy.orm import Mapped, mapped_column
186192
187193
class Document(UUIDBase):
188194
__tablename__ = "documents"
@@ -216,15 +222,15 @@ The FSSpec backend uses the `fsspec <https://filesystem-spec.readthedocs.io/>`_
216222
from advanced_alchemy.types.file_object import storages
217223
218224
# Local filesystem
219-
storages.register(FSSpecBackend(fs=fsspec.filesystem("file"), key="local"))
225+
storages.register_backend(FSSpecBackend(fs=fsspec.filesystem("file"), key="local"))
220226
# S3 storage
221227
fs = fsspec.S3FileSystem(
222228
anon=False,
223229
key="your-access-key",
224230
secret="your-secret-key",
225231
endpoint_url="https://your-s3-endpoint",
226232
)
227-
storages.register(FSSpecBackend(fs=fs, key="s3", prefix="your-bucket"))
233+
storages.register_backend(FSSpecBackend(fs=fs, key="s3", prefix="your-bucket"))
228234
229235
Obstore Backend
230236
^^^^^^^^^^^^^^^
@@ -237,13 +243,13 @@ The Obstore backend provides a simple interface for object storage:
237243
from advanced_alchemy.types.file_object import storages
238244
239245
# Local storage
240-
storages.register(ObstoreBackend(
246+
storages.register_backend(ObstoreBackend(
241247
key="local",
242248
fs="file:///path/to/storage",
243249
))
244250
245251
# S3 storage
246-
storages.register(ObstoreBackend(
252+
storages.register_backend(ObstoreBackend(
247253
key="s3",
248254
fs="s3://your-bucket/",
249255
aws_access_key_id="your-access-key",

0 commit comments

Comments
 (0)