activemodel 0.5.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

activemodel/_session_manager.py

@@ -1,153 +0,0 @@
-"""
-Adapted from: https://github.com/fastapiutils/fastapi-utils/blob/master/fastapi_utils/session.py
-"""
-
-from contextlib import contextmanager
-
-import sqlalchemy as sa
-from sqlalchemy.orm import Session
-
-
-class FastSessionMaker:
-    """
-    A convenience class for managing a (cached) sqlalchemy ORM engine and sessionmaker.
-
-    Intended for use creating ORM sessions injected into endpoint functions by FastAPI.
-    """
-
-    def __init__(self, database_uri: str):
-        """
-        `database_uri` should be any sqlalchemy-compatible database URI.
-
-        In particular, `sqlalchemy.create_engine(database_uri)` should work to create an engine.
-
-        Typically, this would look like:
-
-            "<scheme>://<user>:<password>@<host>:<port>/<database>"
-
-        A concrete example looks like "postgresql://db_user:password@db:5432/app"
-        """
-        self.database_uri = database_uri
-
-        self._cached_engine: sa.engine.Engine | None = None
-        self._cached_sessionmaker: sa.orm.sessionmaker | None = None
-
-    @property
-    def cached_engine(self) -> sa.engine.Engine:
-        """
-        Returns a lazily-cached sqlalchemy engine for the instance's database_uri.
-        """
-        engine = self._cached_engine
-        if engine is None:
-            engine = self.get_new_engine()
-            self._cached_engine = engine
-        return engine
-
-    @property
-    def cached_sessionmaker(self) -> sa.orm.sessionmaker:
-        """
-        Returns a lazily-cached sqlalchemy sessionmaker using the instance's (lazily-cached) engine.
-        """
-        sessionmaker = self._cached_sessionmaker
-        if sessionmaker is None:
-            sessionmaker = self.get_new_sessionmaker(self.cached_engine)
-            self._cached_sessionmaker = sessionmaker
-        return sessionmaker
-
-    def get_new_engine(self) -> sa.engine.Engine:
-        """
-        Returns a new sqlalchemy engine using the instance's database_uri.
-        """
-        return get_engine(self.database_uri)
-
-    def get_new_sessionmaker(
-        self, engine: sa.engine.Engine | None
-    ) -> sa.orm.sessionmaker:
-        """
-        Returns a new sessionmaker for the provided sqlalchemy engine. If no engine is provided, the
-        instance's (lazily-cached) engine is used.
-        """
-        engine = engine or self.cached_engine
-        return get_sessionmaker_for_engine(engine)
-
-    def get_db(self) -> Iterator[Session]:
-        """
-        A generator function that yields a sqlalchemy orm session and cleans up the session once resumed after yielding.
-
-        Can be used directly as a context-manager FastAPI dependency, or yielded from inside a separate dependency.
-        """
-        yield from _get_db(self.cached_sessionmaker)
-
-    @contextmanager
-    def context_session(self) -> Iterator[Session]:
-        """
-        A context-manager wrapped version of the `get_db` method.
-
-        This makes it possible to get a context-managed orm session for the relevant database_uri without
-        needing to rely on FastAPI's dependency injection.
-
-        Usage looks like:
-
-            session_maker = FastAPISessionMaker(database_uri)
-            with session_maker.context_session() as session:
-                session.query(...)
-                ...
-        """
-        yield from self.get_db()
-
-    def reset_cache(self) -> None:
-        """
-        Resets the engine and sessionmaker caches.
-
-        After calling this method, the next time you try to use the cached engine or sessionmaker,
-        new ones will be created.
-        """
-        self._cached_engine = None
-        self._cached_sessionmaker = None
-
-
-def get_engine(uri: str) -> sa.engine.Engine:
-    """
-    Returns a sqlalchemy engine with pool_pre_ping enabled.
-
-    This function may be updated over time to reflect recommended engine configuration for use with FastAPI.
-    """
-    return sa.create_engine(uri, pool_pre_ping=True)
-
-
-def get_sessionmaker_for_engine(engine: sa.engine.Engine) -> sa.orm.sessionmaker:
-    """
-    Returns a sqlalchemy sessionmaker for the provided engine with recommended configuration settings.
-
-    This function may be updated over time to reflect recommended sessionmaker configuration for use with FastAPI.
-    """
-    return sa.orm.sessionmaker(autocommit=False, autoflush=False, bind=engine)
-
-
-@contextmanager
-def context_session(engine: sa.engine.Engine) -> Iterator[Session]:
-    """
-    This contextmanager yields a managed session for the provided engine.
-
-    Usage is similar to `FastAPISessionMaker.context_session`, except that you have to provide the engine to use.
-
-    A new sessionmaker is created for each call, so the FastAPISessionMaker.context_session
-    method may be preferable in performance-sensitive contexts.
-    """
-    sessionmaker = get_sessionmaker_for_engine(engine)
-    yield from _get_db(sessionmaker)
-
-
-def _get_db(sessionmaker: sa.orm.sessionmaker) -> Iterator[Session]:
-    """
-    A generator function that yields an ORM session using the provided sessionmaker, and cleans it up when resumed.
-    """
-    session = sessionmaker()
-    try:
-        yield session
-        session.commit()
-    except Exception as exc:
-        session.rollback()
-        raise exc
-    finally:
-        session.close()

activemodel-0.5.0.dist-info/METADATA

@@ -1,66 +0,0 @@
-Metadata-Version: 2.1
-Name: activemodel
-Version: 0.5.0
-Summary: Make SQLModel more like an a real ORM
-Author-email: Michael Bianco <iloveitaly@gmail.com>
-Project-URL: Repository, https://github.com/iloveitaly/activemodel
-Keywords: sqlmodel,orm,activerecord,activemodel,sqlalchemy
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pydash>=8.0.4
-Requires-Dist: python-decouple-typed>=3.11.0
-Requires-Dist: sqlmodel>=0.0.22
-Requires-Dist: typeid-python>=0.3.1
-
-# ActiveModel: ORM Wrapper for SQLModel
-
-No, this isn't *really* [ActiveModel](https://guides.rubyonrails.org/active_model_basics.html). It's just a wrapper around SQLModel that provides a more ActiveRecord-like interface.
-
-SQLModel is *not* an ORM. It's a SQL query builder and a schema definition tool.
-
-This package provides a thin wrapper around SQLModel that provides a more ActiveRecord-like interface with things like:
-
-* Timestamp column mixins
-* Lifecycle hooks
-
-## Limitations
-
-### Validation
-
-SQLModel does not currently support pydantic validations (when `table=True`). This is very surprising, but is actually the intended functionality:
-
-* https://github.com/fastapi/sqlmodel/discussions/897
-* https://github.com/fastapi/sqlmodel/pull/1041
-* https://github.com/fastapi/sqlmodel/issues/453
-* https://github.com/fastapi/sqlmodel/issues/52#issuecomment-1311987732
-
-For validation:
-
-* When consuming API data, use a separate shadow model to validate the data with `table=False` and then inherit from that model in a model with `table=True`.
-* When validating ORM data, use SQL Alchemy hooks.
-
-<!--
-
-This looks neat
-https://github.com/DarylStark/my_data/blob/a17b8b3a8463b9953821b89fee895e272f94d2a4/src/my_model/model.py#L155
-        schema_extra={
-            'pattern': r'^[a-z0-9_\-\.]+\@[a-z0-9_\-\.]+\.[a-z\.]+$'
-        },
-
-extra constraints
-
-https://github.com/DarylStark/my_data/blob/a17b8b3a8463b9953821b89fee895e272f94d2a4/src/my_model/model.py#L424C1-L426C6
--->
-## Related Projects
-
-* https://github.com/woofz/sqlmodel-basecrud
-
-## Inspiration
-
-* https://github.com/peterdresslar/fastapi-sqlmodel-alembic-pg
-* [Albemic instructions](https://github.com/fastapi/sqlmodel/pull/899/files)
-* https://github.com/fastapiutils/fastapi-utils/
-* https://github.com/fastapi/full-stack-fastapi-template
-* https://github.com/DarylStark/my_data/
-* https://github.com/petrgazarov/FastAPI-app/tree/main/fastapi_app

activemodel-0.5.0.dist-info/RECORD

@@ -1,20 +0,0 @@
-activemodel/__init__.py,sha256=lO75TeJeSm7spmP4P1_Z5oIXBHlL7kKjr1LS2Z4dNUA,109
-activemodel/_session_manager.py,sha256=ojFIpK_fl1-JZsj98zn-zp4RIK1_eyDl-Ga4F1XXbVw,5249
-activemodel/base_model.py,sha256=y8gLmowqk950AELE67u69YJAT9pJSmm67apjOd1g2yo,8081
-activemodel/logger.py,sha256=vU7QiGSy_AJuJFmClUocqIJ-Ltku_8C24ZU8L6fLJR0,53
-activemodel/query_wrapper.py,sha256=zqaA3yAHPTfGLrkzZ6ge6byedV497C7YG1QJe_4ah7Q,2100
-activemodel/session_manager.py,sha256=zU4Eu3YeKSlZrYEBkN70XAHJOHka40Rl4qMBZvEgNwA,1822
-activemodel/utils.py,sha256=dY6wvAS2RCqMVMQfnpXGJxgWRBet0jV5ZXxGIRX1iRw,476
-activemodel/mixins/__init__.py,sha256=VAVLc96oSSultP0BNAlaE3ZBNGlcuVD0JjS1FMCno7k,72
-activemodel/mixins/timestamps.py,sha256=Q-IFljeVVJQqw3XHdOi7dkqzefiVg1zhJvq_bldpmjg,992
-activemodel/mixins/typeid.py,sha256=0TOJ74As9JL4WVvlRm0yuZB49xHAcX0n1fzwKpgdpys,894
-activemodel/pytest/__init__.py,sha256=W9KKQHbPkyq0jrMXaiL8hG2Nsbjy_LN9HhvgGm8W_7g,98
-activemodel/pytest/transaction.py,sha256=rrsoHnbu79kNdnI5fZeOZr5hzrLB-cQH10MueQp5jV4,1670
-activemodel/pytest/truncate.py,sha256=BdltCtLQNPDgRSxpBnGYGSjB_7DAceV5kHdQ_vLrw74,1583
-activemodel/types/typeid.py,sha256=rcr9tSiu5rowD_WOcF4zzBpEUy2izmYEPteDQgCIbhs,1799
-activemodel-0.5.0.dist-info/LICENSE,sha256=L8mmpX47rB-xtJ_HsK0zpfO6viEjxbLYGn70BMp8os4,1071
-activemodel-0.5.0.dist-info/METADATA,sha256=4nieriFioXBxTPOIuxul3RXzNMwKPiDgSYX4KMkwSbQ,2429
-activemodel-0.5.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-activemodel-0.5.0.dist-info/entry_points.txt,sha256=YLX62TP_hR-n3HMBkdBex4W7XRiyOtIPkwy22puIjjQ,61
-activemodel-0.5.0.dist-info/top_level.txt,sha256=JCMUN_seFIi6GXtnTQRWfxXDx6Oj1uok8qapQWbWKDM,12
-activemodel-0.5.0.dist-info/RECORD,,

activemodel-0.5.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-activemodel