Docstrings

Author: pentest-gg

fastapi_users_db_dynamodb/__init__.py

@@ -1,13 +1,14 @@
 """FastAPI Users database adapter for AWS DynamoDB.
 
 This adapter mirrors the SQLAlchemy adapter's public API and return types as closely
-as reasonably possible while using DynamoDB via aiopynamodb.
+as reasonably possible while using DynamoDB via `aiopynamodb`.
 
 Usage notes:
 - This adapter is expected to function correctly, but it is still advisable to exercise
   caution in production environments (yet).
-- This will create non existent tables by default. You can tweak the creation inside generics.py
-- This will require ON-DEMAND mode, since traffic is unpredictable in all auth tables!
+- The Database will create non existent tables by default. You can customize the configuration
+  inside `config.py` using the `get` and `set` methods.
+- For now, tables will require ON-DEMAND mode, since traffic is unpredictable in all auth tables!
 """
 
 import uuid
@@ -23,10 +24,9 @@
 from . import config
 from ._generics import UUID_ID
 from .attributes import GUID, TransformingUnicodeAttribute
+from .config import __version__  # noqa: F401
 from .tables import ensure_tables_exist
 
-__version__: str = "1.0.0"
-
 
 class DynamoDBBaseUserTable(Model, Generic[ID]):
     """Base user table schema for DynamoDB."""
@@ -252,10 +252,10 @@ async def add_oauth_account(self, user: UP, create_dict: dict[str, Any]) -> UP:
         except PutError as e:
             if e.cause_response_code == "ConditionalCheckFailedException":
                 raise ValueError(
-                    "OAuth account could not be updated because it already exists."
+                    "OAuth account could not be added because it already exists."
                 ) from e
             raise ValueError(
-                "OAuth account could not be updated because the table does not exist."
+                "OAuth account could not be added because the table does not exist."
             ) from e
 
         return user

fastapi_users_db_dynamodb/config.py

@@ -1,6 +1,8 @@
 from enum import StrEnum
 from typing import Any, Literal, TypedDict
 
+__version__: str = "1.0.0"
+
 
 # Right now, only ON-DEMAND mode is supported!
 class BillingMode(StrEnum):

fastapi_users_db_dynamodb/tables.py

@@ -11,6 +11,10 @@
 
 
 class CreatableTable(Protocol):
+    """
+    A protocol class representing PynamoDB tables (`Model`) which can be created.
+    """
+
     @classmethod
     async def exists(cls) -> CoroutineType[Any, Any, bool] | bool: ...
 
@@ -23,7 +27,8 @@ async def create_table(
     ) -> CoroutineType[Any, Any, Any] | Any: ...
 
 
-def _check_creatable_table(cls: type[Any]):
+def __check_creatable_table(cls: type[Any]):
+    """Check if an object is of type `CreatableTable`"""
     if not issubclass(cls, Model):
         raise TypeError(f"{cls.__name__} must be a subclass of Model")
     if not hasattr(cls, "exists") or not hasattr(cls, "create_table"):
@@ -38,7 +43,7 @@ async def ensure_tables_exist(*tables: type[CreatableTable]) -> None:
     global __tables_cache
 
     for table_cls in tables:
-        _check_creatable_table(table_cls)
+        __check_creatable_table(table_cls)
         if table_cls not in __tables_cache:
             if not await table_cls.exists():
                 await table_cls.create_table(