activemodel 0.10.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

activemodel/base_model.py

@@ -2,10 +2,11 @@ import json
 import typing as t
 from uuid import UUID
 
-import pydash
 import sqlalchemy as sa
 import sqlmodel as sm
+import textcase
 from sqlalchemy import Connection, event
+from sqlalchemy.dialects.postgresql import insert as postgres_insert
 from sqlalchemy.orm import Mapper, declared_attr
 from sqlalchemy.orm.attributes import flag_modified as sa_flag_modified
 from sqlalchemy.orm.base import instance_state
@@ -19,7 +20,6 @@ from . import get_column_from_field_patch  # noqa: F401
 from .logger import logger
 from .query_wrapper import QueryWrapper
 from .session_manager import get_session
-from sqlalchemy.dialects.postgresql import insert as postgres_insert
 
 POSTGRES_INDEXES_NAMING_CONVENTION = {
     "ix": "%(column_0_label)s_idx",
@@ -152,19 +152,19 @@ class BaseModel(SQLModel):
     @declared_attr
     def __tablename__(cls) -> str:
         """
-        Automatically generates the table name for the model by converting the class name from camel case to snake case.
-        This is the recommended format for table names:
+        Automatically generates the table name for the model by converting the model's class name from camel case to snake case.
+        This is the recommended text case style for table names:
 
         https://wiki.postgresql.org/wiki/Don%27t_Do_This#Don.27t_use_upper_case_table_or_column_names
 
-        By default, the class is lower cased which makes it harder to read.
+        By default, the model's class name is lower cased which makes it harder to read.
 
-        Many snake_case libraries struggle with snake case for names like LLMCache, which is why we are using a more
-        complicated implementation from pydash.
+        Also, many text case conversion libraries struggle handling words like "LLMCache", this is why we are using
+        a more precise library which processes such acronyms: [`textcase`](https://pypi.org/project/textcase/).
 
         https://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case
         """
-        return pydash.strings.snake_case(cls.__name__)
+        return textcase.snake(cls.__name__)
 
     @classmethod
     def foreign_key(cls, **kwargs):
@@ -196,12 +196,13 @@ class BaseModel(SQLModel):
         "convenience method to avoid having to write .select().where() in order to add conditions"
         return cls.select().where(*args)
 
+    # TODO we should add an instance method for this as well
     @classmethod
     def upsert(
         cls,
         data: dict[str, t.Any],
         unique_by: str | list[str],
-    ) -> None:
+    ) -> t.Self:
         """
         This method will insert a new record if it doesn't exist, or update the existing record if it does.
 
@@ -233,6 +234,8 @@ class BaseModel(SQLModel):
         return result
 
     def delete(self):
+        "Delete record completely from the database"
+
         with get_session() as session:
             if old_session := Session.object_session(self):
                 old_session.expunge(self)
@@ -403,6 +406,19 @@ class BaseModel(SQLModel):
         with get_session() as session:
             return session.exec(statement).first()
 
+    @classmethod
+    def one_or_none(cls, *args: t.Any, **kwargs: t.Any):
+        """
+        Gets a single record from the database. Pass an PK ID or a kwarg to filter by.
+        Returns None if no record is found. Throws an error if more than one record is found.
+        """
+
+        args, kwargs = cls.__process_filter_args__(*args, **kwargs)
+        statement = select(cls).filter(*args).filter_by(**kwargs)
+
+        with get_session() as session:
+            return session.exec(statement).one_or_none()
+
     @classmethod
     def one(cls, *args: t.Any, **kwargs: t.Any):
         """

activemodel/cli/__init__.py

@@ -0,0 +1,147 @@
+"""
+This module provides utilities for generating Protocol type definitions for SQLAlchemy's
+SelectOfScalar methods, as well as formatting and fixing Python files using ruff.
+"""
+
+import inspect
+import logging
+import os
+import subprocess
+from pathlib import Path
+from typing import Any  # already imported in header of generated file
+
+import sqlmodel as sm
+from sqlmodel.sql.expression import SelectOfScalar
+
+from test.test_wrapper import QueryWrapper
+
+# Set up logging
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+QUERY_WRAPPER_CLASS_NAME = QueryWrapper.__name__
+
+
+def format_python_file(file_path: str | Path) -> bool:
+    """
+    Format a Python file using ruff.
+
+    Args:
+        file_path: Path to the Python file to format
+
+    Returns:
+        bool: True if formatting was successful, False otherwise
+    """
+    try:
+        subprocess.run(["ruff", "format", str(file_path)], check=True)
+        logger.info(f"Formatted file using ruff at {file_path}")
+        return True
+    except subprocess.CalledProcessError as e:
+        logger.error(f"Error running ruff to format the file: {e}")
+        return False
+
+
+def fix_python_file(file_path: str | Path) -> bool:
+    """
+    Fix linting issues in a Python file using ruff.
+
+    Args:
+        file_path: Path to the Python file to fix
+
+    Returns:
+        bool: True if fixing was successful, False otherwise
+    """
+    try:
+        subprocess.run(["ruff", "check", str(file_path), "--fix"], check=True)
+        logger.info(f"Fixed linting issues using ruff at {file_path}")
+        return True
+    except subprocess.CalledProcessError as e:
+        logger.error(f"Error running ruff to fix the file: {e}")
+        return False
+
+
+def generate_sqlalchemy_protocol():
+    """Generate Protocol type definitions for SQLAlchemy SelectOfScalar methods"""
+    logger.info("Starting SQLAlchemy protocol generation")
+
+    header = """
+# IMPORTANT: This file is auto-generated. Do not edit directly.
+
+from typing import Protocol, TypeVar, Any, Generic
+import sqlmodel as sm
+from sqlalchemy.sql.base import _NoArg
+
+T = TypeVar('T', bound=sm.SQLModel, covariant=True)
+
+class SQLAlchemyQueryMethods(Protocol, Generic[T]):
+    \"""Protocol defining SQLAlchemy query methods forwarded by QueryWrapper.__getattr__\"""
+"""
+    # Initialize output list for generated method signatures
+    output: list = []
+
+    try:
+        # Get all methods from SelectOfScalar
+        methods = inspect.getmembers(SelectOfScalar)
+        logger.debug(f"Discovered {len(methods)} methods from SelectOfScalar")
+
+        for name, method in methods:
+            # Skip private/dunder methods
+            if name.startswith("_"):
+                continue
+
+            if not inspect.isfunction(method) and not inspect.ismethod(method):
+                logger.debug(f"Skipping non-method: {name}")
+                continue
+
+            logger.debug(f"Processing method: {name}")
+            try:
+                signature = inspect.signature(method)
+                params = []
+
+                # Process parameters, skipping 'self'
+                for param_name, param in list(signature.parameters.items())[1:]:
+                    if param.kind == param.VAR_POSITIONAL:
+                        params.append(f"*{param_name}: Any")
+                    elif param.kind == param.VAR_KEYWORD:
+                        params.append(f"**{param_name}: Any")
+                    else:
+                        if param.default is inspect.Parameter.empty:
+                            params.append(f"{param_name}: Any")
+                        else:
+                            default_repr = repr(param.default)
+                            params.append(f"{param_name}: Any = {default_repr}")
+
+                params_str = ", ".join(params)
+                output.append(
+                    f'    def {name}(self, {params_str}) -> "{QUERY_WRAPPER_CLASS_NAME}[T]": ...'
+                )
+            except (ValueError, TypeError) as e:
+                logger.warning(f"Could not get signature for {name}: {e}")
+                # Some methods might not have proper signatures
+                output.append(
+                    f'    def {name}(self, *args: Any, **kwargs: Any) -> "{QUERY_WRAPPER_CLASS_NAME}[T]": ...'
+                )
+
+        # Write the output to a file
+        protocol_path = (
+            Path(__file__).parent.parent / "types" / "sqlalchemy_protocol.py"
+        )
+
+        # Ensure directory exists
+        os.makedirs(protocol_path.parent, exist_ok=True)
+
+        with open(protocol_path, "w") as f:
+            f.write(header + "\n".join(output))
+
+        logger.info(f"Generated SQLAlchemy protocol at {protocol_path}")
+
+        # Format and fix the generated file with ruff
+        format_python_file(protocol_path)
+        fix_python_file(protocol_path)
+    except Exception as e:
+        logger.error(f"Error generating SQLAlchemy protocol: {e}", exc_info=True)
+        raise
+
+
+if __name__ == "__main__":
+    generate_sqlalchemy_protocol()

activemodel/mixins/timestamps.py

@@ -20,7 +20,10 @@ class TimestampsMixin:
     >>> class MyModel(TimestampsMixin, SQLModel):
     >>>    pass
 
-    Originally pulled from: https://github.com/tiangolo/sqlmodel/issues/252
+    Notes:
+    
+    - Originally pulled from: https://github.com/tiangolo/sqlmodel/issues/252
+    - Related issue: https://github.com/fastapi/sqlmodel/issues/539
     """
 
     created_at: datetime | None = Field(

activemodel/mixins/typeid.py

@@ -1,6 +1,7 @@
 from sqlmodel import Column, Field
 from typeid import TypeID
 
+from activemodel.types import typeid_patch  # noqa: F401
 from activemodel.types.typeid import TypeIDType
 
 # global list of prefixes to ensure uniqueness
@@ -8,11 +9,15 @@ _prefixes: list[str] = []
 
 
 def TypeIDMixin(prefix: str):
+    """
+    Mixin that adds a TypeID primary key field to a SQLModel. Specify the prefix to use for the TypeID.
+    """
+
     # make sure duplicate prefixes are not used!
     # NOTE this will cause issues on code reloads
     assert prefix
     assert prefix not in _prefixes, (
-        f"prefix {prefix} already exists, pick a different one"
+        f"TypeID prefix '{prefix}' already exists, pick a different one"
     )
 
     class _TypeIDMixin:
@@ -23,9 +28,12 @@ def TypeIDMixin(prefix: str):
                 TypeIDType(prefix),
                 primary_key=True,
                 nullable=False,
+                # default on the sa_column level ensures that an ID is generated when creating a new record, even when
+                # raw SQLAlchemy operations are used instead of activemodel operations
                 default=lambda: TypeID(prefix),
             ),
-            # default_factory=lambda: TypeID(prefix),
+            # add a database comment to document the prefix, since it's not stored in the DB otherwise
+            description=f"TypeID with prefix: {prefix}",
         )
 
     _prefixes.append(prefix)

activemodel/pytest/__init__.py

@@ -1,2 +1,2 @@
-from .transaction import database_reset_transaction
+from .transaction import database_reset_transaction, test_session
 from .truncate import database_reset_truncate

activemodel/pytest/factories.py

@@ -0,0 +1,102 @@
+"""
+Notes on polyfactory:
+
+1. is_supported_type validates that the class can be used to generate a factory
+https://github.com/litestar-org/polyfactory/issues/655#issuecomment-2727450854
+"""
+
+import typing as t
+
+from polyfactory.factories.pydantic_factory import ModelFactory
+from polyfactory.field_meta import FieldMeta
+from typeid import TypeID
+
+from activemodel.session_manager import global_session
+
+# TODO not currently used
+# def type_id_provider(cls, field_meta):
+#     # TODO this doesn't work well with __ args:
+#     # https://github.com/litestar-org/polyfactory/pull/666/files
+#     return str(TypeID("hi"))
+
+
+# BaseFactory.add_provider(TypeIDType, type_id_provider)
+
+
+class SQLModelFactory[T](ModelFactory[T]):
+    """
+    Base factory for SQLModel models:
+
+    1. Ability to ignore all relationship fks
+    2. Option to ignore all pks
+    """
+
+    __is_base_factory__ = True
+
+    @classmethod
+    def should_set_field_value(cls, field_meta: FieldMeta, **kwargs: t.Any) -> bool:
+        # TODO what is this checking for?
+        has_object_override = hasattr(cls, field_meta.name)
+
+        # TODO this should be more intelligent, it's goal is to detect all of the relationship field and avoid settings them
+        if not has_object_override and (
+            field_meta.name == "id" or field_meta.name.endswith("_id")
+        ):
+            return False
+
+        return super().should_set_field_value(field_meta, **kwargs)
+
+
+# TODO we need to think through how to handle relationships and autogenerate them
+class ActiveModelFactory[T](SQLModelFactory[T]):
+    __is_base_factory__ = True
+    __sqlalchemy_session__ = None
+
+    # TODO we shouldn't have to type this, but `save()` typing is not working
+    @classmethod
+    def save(cls, *args, **kwargs) -> T:
+        """
+        Where this gets tricky, is this can be called multiple times within the same callstack. This can happen when
+        a factory uses other factories to create relationships.
+
+        In a truncation strategy, the __sqlalchemy_session__ is set to None.
+        """
+        with global_session(cls.__sqlalchemy_session__):
+            return cls.build(*args, **kwargs).save()
+
+    @classmethod
+    def foreign_key_typeid(cls):
+        """
+        Return a random type id for the foreign key on this model.
+
+        This is helpful for generating TypeIDs for testing 404s, parsing, manually settings, etc
+        """
+        # TODO right now assumes the model is typeid, maybe we should assert against this?
+        primary_key_name = cls.__model__.primary_key_column().name
+        return TypeID(
+            cls.__model__.model_fields[primary_key_name].sa_column.type.prefix
+        )
+
+    @classmethod
+    def should_set_field_value(cls, field_meta: FieldMeta, **kwargs: t.Any) -> bool:
+        # do not default deleted at mixin to deleted!
+        # TODO should be smarter about detecting if the mixin is in place
+        if field_meta.name in ["deleted_at", "updated_at", "created_at"]:
+            return False
+
+        return super().should_set_field_value(field_meta, **kwargs)
+
+    # @classmethod
+    # def build(
+    #     cls,
+    #     factory_use_construct: bool | None = None,
+    #     sqlmodel_save: bool = False,
+    #     **kwargs: t.Any,
+    # ) -> T:
+    #     result = super().build(factory_use_construct=factory_use_construct, **kwargs)
+
+    #     # TODO allow magic dunder method here
+    #     if sqlmodel_save:
+    #         result.save()
+
+    #     return result

activemodel/pytest/plugin.py

@@ -0,0 +1,81 @@
+"""Pytest plugin integration for activemodel.
+
+Currently provides:
+
+* ``db_session`` fixture – quick access to a database session (see ``test_session``)
+* ``activemodel_preserve_tables`` ini option – configure tables to preserve when using
+  ``database_reset_truncate`` (comma separated list or multiple lines depending on config style)
+
+Configuration examples:
+
+pytest.ini::
+
+    [pytest]
+    activemodel_preserve_tables = alembic_version,zip_code,seed_table
+
+pyproject.toml::
+
+    [tool.pytest.ini_options]
+    activemodel_preserve_tables = [
+      "alembic_version",
+      "zip_code",
+      "seed_table",
+    ]
+
+The list always implicitly includes ``alembic_version`` even if not specified.
+"""
+
+from activemodel.session_manager import global_session
+import pytest
+
+from .transaction import set_factory_session, set_polyfactory_session, test_session
+
+
+def pytest_addoption(
+    parser: pytest.Parser,
+) -> None:  # pragma: no cover - executed during collection
+    """Register custom ini options.
+
+    We treat this as a *linelist* so pyproject.toml list syntax works. Comma separated works too because
+    pytest splits lines first; users can still provide one line with commas.
+    """
+
+    parser.addini(
+        "activemodel_preserve_tables",
+        help=(
+            "Tables to preserve when calling activemodel.pytest.database_reset_truncate. "
+        ),
+        type="linelist",
+        default=["alembic_version"],
+    )
+
+
+@pytest.fixture(scope="function")
+def db_session():
+    """
+    Helpful for tests that are more similar to unit tests. If you doing a routing or integration test, you
+    probably don't need this. If your unit test is simple (you are just creating a couple of models) you
+    can most likely skip this.
+
+    This is helpful if you are doing a lot of lazy-loaded params or need a database session to be in place
+    for testing code that will run within a celery worker or something similar.
+
+    >>> def the_test(db_session):
+    """
+    with test_session() as session:
+        yield session
+
+
+@pytest.fixture(scope="function")
+def db_truncate_session():
+    """
+    Provides a database session for testing when using a truncation cleaning strategy.
+
+    When not using a transaction cleaning strategy, no global test session is set
+    """
+    with global_session() as session:
+        # set global database sessions for model factories to avoid lazy loading issues
+        set_factory_session(session)
+        set_polyfactory_session(session)
+
+        yield session

activemodel/pytest/transaction.py

@@ -1,19 +1,107 @@
+import contextlib
+import contextvars
+
+from sqlmodel import Session
 from activemodel import SessionManager
+from activemodel.session_manager import global_session
 
 from ..logger import logger
 
+try:
+    import factory as factory_exists
+except ImportError:
+    factory_exists = None
+
+try:
+    import polyfactory as polyfactory_exists
+except ImportError:
+    polyfactory_exists = None
+
+
+_test_session = contextvars.ContextVar[Session | None]("test_session", default=None)
+
+
+def set_factory_session(session):
+    if not factory_exists:
+        return
+    from factory.alchemy import SQLAlchemyModelFactory
+
+    # Ensure that all factories use the same session
+    for factory in SQLAlchemyModelFactory.__subclasses__():
+        factory._meta.sqlalchemy_session = factory_session
+        factory._meta.sqlalchemy_session_persistence = "commit"
+
+
+def set_polyfactory_session(session):
+    if not polyfactory_exists:
+        return
+
+    from .factories import ActiveModelFactory
+
+    ActiveModelFactory.__sqlalchemy_session__ = session
+
+
+@contextlib.contextmanager
+def test_session():
+    """
+    Configures a session-global database session for a test.
+
+    Use this as a fixture using `db_session`. This method is meant to be used as a context manager.
+
+    This is useful for tests that need to interact with the database multiple times before calling application code
+    that uses the objects. This is intended to be used outside of an integration test. Integration tests generally
+    do not use database transactions to clean the database and instead use truncation. The transaction fixture
+    configures a session, which is then used here. This method requires that this global test session is already
+    configured. If the transaction fixture is not used, then there is no session available for use and this will fail.
+
+    ActiveModelFactory.save() does this automatically, but if you need to manually create objects
+    and persist them to a DB, you can run into issues with the simple `expunge()` call
+    used to reassociate an object with a new session. If there are more complex relationships
+    this approach will fail and give you detached object errors.
+
+    >>> from activemodel.pytest import test_session
+    >>> def test_the_thing():
+    >>>     with test_session():
+    ...         obj = MyModel(name="test").save()
+    ...         obj2 = MyModelFactory.save()
+
+    More information: https://grok.com/share/bGVnYWN5_c21dd39f-84a7-44cf-a05b-9b26c8febb0b
+    """
+
+    if model_factory_session := _test_session.get():
+        with global_session(model_factory_session) as session:
+            yield session
+    else:
+        raise ValueError("No test session available")
+
+
+def database_truncate_session():
+    """
+    Provides a database session for testing when using a truncation cleaning strategy.
+
+    When not using a transaction cleaning strategy, no global test session is set
+    """
+    with test_session() as session:
+        yield session
+
 
 def database_reset_transaction():
     """
     Wrap all database interactions for a given test in a nested transaction and roll it back after the test.
 
+    This is provided as a function, not a fixture, since you'll need to determine when a integration test is run. Here's
+    an example of how to build a fixture from this method:
+
     >>> from activemodel.pytest import database_reset_transaction
     >>> database_reset_transaction = pytest.fixture(scope="function", autouse=True)(database_reset_transaction)
 
-    Transaction-based DB cleaning does *not* work if the DB mutations are happening in a separate process, which should
-    use spawn, because the same session is not shared across processes. Note that using `fork` is dangerous.
+    Transaction-based DB cleaning does *not* work if the DB mutations are happening in a separate process because the
+    same session is not shared across python processes. For this scenario, use the truncate method.
 
-    In this case, you should use the truncate.
+    Note that using `fork` as a multiprocess start method is dangerous. Use spawn. This link has more documentation
+    around this topic:
+
+    https://github.com/iloveitaly/python-starter-template/blob/master/app/configuration/lang.py
 
     References:
 
@@ -28,30 +116,29 @@ def database_reset_transaction():
 
     engine = SessionManager.get_instance().get_engine()
 
-    logger.info("starting global database transaction")
+    logger.debug("starting global database transaction")
 
     with engine.begin() as connection:
         transaction = connection.begin_nested()
 
         if SessionManager.get_instance().session_connection is not None:
-            logger.warning("session override already exists")
-            # TODO should we throw an exception here?
+            raise ValueError("global session already set")
 
+        # NOTE we very intentionally do NOT
         SessionManager.get_instance().session_connection = connection
 
         try:
-            with SessionManager.get_instance().get_session() as factory_session:
-                try:
-                    from factory.alchemy import SQLAlchemyModelFactory
+            with SessionManager.get_instance().get_session() as model_factory_session:
+                # set global database sessions for model factories to avoid lazy loading issues
+                set_factory_session(model_factory_session)
+                set_polyfactory_session(model_factory_session)
 
-                    # Ensure that all factories use the same session
-                    for factory in SQLAlchemyModelFactory.__subclasses__():
-                        factory._meta.sqlalchemy_session = factory_session
-                        factory._meta.sqlalchemy_session_persistence = "commit"
-                except ImportError:
-                    pass
+                test_session_token = _test_session.set(model_factory_session)
 
-                yield
+                try:
+                    yield
+                finally:
+                    _test_session.reset(test_session_token)
         finally:
             logger.debug("rolling back transaction")