fastapi-rtk 0.2.27__py3-none-any.whl → 1.0.13__py3-none-any.whl

fastapi_rtk/cli/{db.py → commands/db/__init__.py}

@@ -1,28 +1,30 @@
-from pathlib import Path
+import os
 from typing import Annotated, Union
 
+import alembic
+import alembic.command
+import alembic.config
 import typer
 
-from .commands import branches as _branches
-from .commands import check as _check
-from .commands import current as _current
-from .commands import downgrade as _downgrade
-from .commands import edit as _edit
-from .commands import heads as _heads
-from .commands import history as _history
-from .commands import init as _init
-from .commands import list_templates as _list_templates
-from .commands import merge as _merge
-from .commands import migrate as _migrate
-from .commands import path_callback
-from .commands import revision as _revision
-from .commands import show as _show
-from .commands import stamp as _stamp
-from .commands import upgrade as _upgrade
-from .commands import version_callback
-from .decorators import ensure_fastapi_rtk_tables_exist
+from ...cli import app
+from ...decorators import ensure_fastapi_rtk_tables_exist
+from .. import version_callback
+
+
+class Config(alembic.config.Config):
+    def __init__(self, *args, **kwargs):
+        self.template_directory = kwargs.pop("template_directory", None)
+        super().__init__(*args, **kwargs)
+
+    def get_template_directory(self):
+        if self.template_directory:
+            return self.template_directory
+        package_dir = os.path.abspath(os.path.dirname(__file__))
+        return os.path.join(package_dir, "templates")
+
 
 db_app = typer.Typer(rich_markup_mode="rich")
+app.add_typer(db_app, name="db")
 
 
 @db_app.callback()
@@ -45,7 +47,14 @@ def callback(
 @db_app.command()
 def list_templates():
     """List available templates."""
-    _list_templates()
+    config = Config()
+    config.print_stdout("Available templates:\n")
+    for tempname in sorted(os.listdir(config.get_template_directory())):
+        with open(
+            os.path.join(config.get_template_directory(), tempname, "README")
+        ) as readme:
+            synopsis = next(readme).strip()
+        config.print_stdout("%s - %s", tempname, synopsis)
 
 
 @db_app.command()
@@ -76,7 +85,17 @@ def init(
     ] = False,
 ):
     """Creates a new migration repository"""
-    _init(directory, multidb, template, package)
+    template_directory = None
+    if "/" in template or "\\" in template:
+        template_directory, template = os.path.split(template)
+    config = Config(template_directory=template_directory)
+    config.set_main_option("script_location", directory)
+    config.config_file_name = os.path.join(directory, "alembic.ini")
+    # TODO: Fix this
+    # config = current_app.extensions["migrate"].migrate.call_configure_callbacks(config)
+    if multidb and template == "fastapi":
+        template = "fastapi-multidb"
+    alembic.command.init(config, directory, template=template, package=package)
 
 
 @db_app.command()
@@ -129,16 +148,21 @@ def revision(
     ] = None,
 ):
     """Create a new revision file."""
-    _revision(
-        directory,
+    opts = ["autogenerate"] if autogenerate else None
+    config = Config()
+    config.set_main_option("script_location", directory)
+    config.cmd_opts = opts
+    # config = current_app.extensions["migrate"].migrate.get_config(directory, opts=opts)
+    alembic.command.revision(
+        config,
         message,
-        autogenerate,
-        sql,
-        head,
-        splice,
-        branch_label,
-        version_path,
-        rev_id,
+        autogenerate=autogenerate,
+        sql=sql,
+        head=head,
+        splice=splice,
+        branch_label=branch_label,
+        version_path=version_path,
+        rev_id=rev_id,
     )
 
 
@@ -186,15 +210,16 @@ def migrate(
     ] = None,
 ):
     """Alias for `revision` command with --autogenerate."""
-    _migrate(
-        directory,
-        message,
-        sql,
-        head,
-        splice,
-        branch_label,
-        version_path,
-        rev_id,
+    return revision(
+        directory=directory,
+        message=message,
+        autogenerate=True,
+        sql=sql,
+        head=head,
+        splice=splice,
+        branch_label=branch_label,
+        version_path=version_path,
+        rev_id=rev_id,
     )
 
 
@@ -208,7 +233,9 @@ def edit(
     ] = "current",
 ):
     """Edit the revision."""
-    _edit(directory, revision)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.edit(config, revision)
 
 
 @db_app.command()
@@ -234,7 +261,15 @@ def merge(
     ] = None,
 ):
     """Merge two revisions together."""
-    _merge(directory, revisions, message, branch_label, rev_id)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.merge(
+        config,
+        revisions,
+        message=message,
+        branch_label=branch_label,
+        rev_id=rev_id,
+    )
 
 
 @db_app.command()
@@ -259,7 +294,9 @@ def upgrade(
     ] = None,
 ):
     """Upgrade to a later version."""
-    _upgrade(directory, revision, sql, tag)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.upgrade(config, revision, sql=sql, tag=tag)
 
 
 @db_app.command()
@@ -284,7 +321,9 @@ def downgrade(
     ] = None,
 ):
     """Downgrade to a previous version."""
-    _downgrade(directory, revision, sql, tag)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.downgrade(config, revision, sql=sql, tag=tag)
 
 
 @db_app.command()
@@ -295,7 +334,9 @@ def show(
     revision: Annotated[str, typer.Option(help="Target revision to show.")] = "head",
 ):
     """Show the revision."""
-    _show(directory, revision)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.show(config, revision)
 
 
 @db_app.command()
@@ -320,7 +361,11 @@ def history(
     ] = False,
 ):
     """List changeset scripts in chronological order."""
-    _history(directory, rev_range, verbose, indicate_current)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.history(
+        config, rev_range, verbose=verbose, indicate_current=indicate_current
+    )
 
 
 @db_app.command()
@@ -342,7 +387,11 @@ def heads(
     ] = False,
 ):
     """Show current available heads in the script directory."""
-    _heads(directory, verbose, resolve_dependencies)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.heads(
+        config, verbose=verbose, resolve_dependencies=resolve_dependencies
+    )
 
 
 @db_app.command()
@@ -358,7 +407,9 @@ def branches(
     ] = False,
 ):
     """Show current branch points in the script directory."""
-    _branches(directory, verbose)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.branches(config, verbose=verbose)
 
 
 @db_app.command()
@@ -374,7 +425,9 @@ def current(
     ] = False,
 ):
     """Display the current revision for each database."""
-    _current(directory, verbose)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.current(config, verbose=verbose)
 
 
 @db_app.command()
@@ -403,7 +456,9 @@ def stamp(
     ] = False,
 ):
     """Stamp the revision table with the given revision."""
-    _stamp(directory, revision, sql, tag, purge)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.stamp(config, revision, sql=sql, tag=tag, purge=purge)
 
 
 @db_app.command()
@@ -413,4 +468,6 @@ def check(
     ] = "migrations",
 ):
     """Check the current revision."""
-    _check(directory)
+    config = Config()
+    config.set_main_option("script_location", directory)
+    alembic.command.check(config)

fastapi_rtk/cli/{templates → commands/db/templates}/fastapi/env.py

@@ -1,9 +1,8 @@
-import asyncio
 import logging
 from logging.config import fileConfig
 
 from alembic import context
-from fastapi_rtk import Setting, metadata
+from fastapi_rtk import Setting, metadata, smart_run_sync
 from fastapi_rtk.const import FASTAPI_RTK_TABLES
 from fastapi_rtk.db import DatabaseSessionManager
 from sqlalchemy import Connection
@@ -114,7 +113,7 @@ async def run_async_migrations() -> None:
 def run_migrations_online() -> None:
     """Run migrations in 'online' mode."""
 
-    asyncio.run(run_async_migrations())
+    smart_run_sync(run_async_migrations)
 
 
 if context.is_offline_mode():

fastapi_rtk/cli/{templates → commands/db/templates}/fastapi-multidb/env.py

@@ -1,10 +1,9 @@
-import asyncio
 import logging
 from logging.config import fileConfig
 
 from alembic import context
-from fastapi_rtk import Setting, metadatas
-from fastapi_rtk.const import FASTAPI_RTK_TABLES
+from fastapi_rtk import Setting, metadatas, smart_run_sync
+from fastapi_rtk.const import DEFAULT_METADATA_KEY, FASTAPI_RTK_TABLES
 from fastapi_rtk.db import DatabaseSessionManager
 from sqlalchemy import Connection, MetaData
 
@@ -29,17 +28,19 @@ logger = logging.getLogger("alembic.env")
 #       'URL1':mymodel.metadata1,
 #       'engine2':mymodel.metadata2
 # }
-target_metadata = {}
+target_metadata = dict[str, MetaData]()
 
 MAIN_DATABASE = Setting.SQLALCHEMY_DATABASE_URI
 if not MAIN_DATABASE:
     raise Exception("SQLALCHEMY_DATABASE_URI not set in config")
-target_metadata["default"] = metadatas["default"]
+target_metadata[DEFAULT_METADATA_KEY] = metadatas[DEFAULT_METADATA_KEY]
 
 BINDS = Setting.SQLALCHEMY_BINDS or {}
 for name in BINDS.keys():
-    if name == "default":
-        raise Exception("SQLALCHEMY_BINDS cannot have a key named 'default'")
+    if name == DEFAULT_METADATA_KEY:
+        raise Exception(
+            f"SQLALCHEMY_BINDS cannot have a key named '{DEFAULT_METADATA_KEY}'"
+        )
     target_metadata[name] = metadatas[name]
 
 # other values from the config, defined by the needs of env.py,
@@ -158,7 +159,7 @@ async def run_async_migrations() -> None:
 
     for name, metadata in target_metadata.items():
         logger.info("Migrating database %s" % name)
-        async with db.connect(name.replace("default", "")) as connection:
+        async with db.connect(name) as connection:
             if isinstance(connection, Connection):
                 do_run_migrations(
                     connection, f"{name}_upgrades", f"{name}_downgrades", metadata, name
@@ -221,7 +222,7 @@ async def run_async_migrations() -> None:
 def run_migrations_online() -> None:
     """Run migrations in 'online' mode."""
 
-    asyncio.run(run_async_migrations())
+    smart_run_sync(run_async_migrations)
 
 
 if context.is_offline_mode():

fastapi_rtk/cli/{templates → commands/db/templates}/fastapi-multidb/script.py.mako

@@ -12,6 +12,7 @@ from typing import Sequence, Union
 
 from alembic import op
 import sqlalchemy as sa
+import fastapi_rtk.types
 ${imports if imports else ""}
 
 # revision identifiers, used by Alembic.
@@ -30,13 +31,14 @@ def downgrade(engine_name: str) -> None:
 
 <%
     from fastapi_rtk import Setting
+    from fastapi_rtk.const import DEFAULT_METADATA_KEY
     bind_names = []
 
     MAIN_DATABASE = Setting.SQLALCHEMY_DATABASE_URI
     BINDS = Setting.SQLALCHEMY_BINDS
     BINDS = list(BINDS.keys())
 
-    db_names = ["default"] + BINDS
+    db_names = [DEFAULT_METADATA_KEY] + BINDS
 %>
 
 ## generate an "upgrade_<xyz>() / downgrade_<xyz>()" function

fastapi_rtk/cli/{export.py → commands/export.py}

@@ -5,9 +5,9 @@ import typing
 import jsonschema2md
 import typer
 
-from ..api.model_rest_api import ModelRestApi
-from ..backends.sqla.model import metadatas
-from ..const import (
+from ...api.model_rest_api import ModelRestApi
+from ...backends.sqla.model import metadatas
+from ...const import (
     ACCESSTOKEN_TABLE,
     API_TABLE,
     ASSOC_PERMISSION_API_ROLE_TABLE,
@@ -18,12 +18,12 @@ from ..const import (
     ROLE_TABLE,
     USER_TABLE,
 )
-from ..db import db
-from ..globals import g
-from .commands import version_callback
-from .const import logger
-from .decorators import ensure_fastapi_rtk_tables_exist
-from .types import (
+from ...db import db
+from ...globals import g
+from ..cli import app
+from ..const import logger
+from ..decorators import ensure_fastapi_rtk_tables_exist
+from ..types import (
     APIDataDocs,
     APIDocs,
     APIMetadataDocs,
@@ -34,9 +34,11 @@ from .types import (
     DBTableDocs,
     TableDocumentation,
 )
-from .utils import json_to_markdown, run_in_current_event_loop
+from ..utils import json_to_markdown, run_in_current_event_loop
+from . import version_callback
 
 export_app = typer.Typer(rich_markup_mode="rich")
+app.add_typer(export_app, name="export")
 
 table_documentation: collections.defaultdict[str, TableDocumentation] = (
     collections.defaultdict(lambda: TableDocumentation(description="", columns={}))

fastapi_rtk/cli/{security.py → commands/security.py}

@@ -1,16 +1,20 @@
+import typing
 from typing import Annotated, Union
 
+import sqlalchemy
 import typer
 
-from ..globals import g
-from .commands import cleanup as _cleanup
-from .commands import create_user as _create_user
-from .commands import export_data, version_callback
-from .commands import reset_password as _reset_password
-from .decorators import ensure_fastapi_rtk_tables_exist
-from .utils import run_in_current_event_loop
+from ...db import db
+from ...globals import g
+from ...security.sqla.models import Role
+from ...utils.run_utils import safe_call
+from ..cli import app
+from ..decorators import ensure_fastapi_rtk_tables_exist
+from ..utils import run_in_current_event_loop
+from . import version_callback
 
 security_app = typer.Typer(rich_markup_mode="rich")
+app.add_typer(security_app, name="security")
 
 
 @security_app.callback()
@@ -225,3 +229,65 @@ def cleanup():
     run_in_current_event_loop(_cleanup())
 
     typer.echo("Cleanup complete.")
+
+
+async def _check_roles(name: str, create: bool = False):
+    async with db.session() as session:
+        stmt = sqlalchemy.select(Role).where(Role.name == name)
+        role = (await safe_call(session.execute(stmt))).scalar_one_or_none()
+        if not role:
+            if not create:
+                raise Exception(f"Role {name} does not exist")
+            await g.current_app.sm.create_role(name=name, session=session)
+
+
+async def _create_user(
+    username: str,
+    email: str,
+    password: str,
+    first_name: str = "",
+    last_name: str = "",
+    role: str = "",
+    create_role: bool = False,
+):
+    """
+    Create an admin user.
+    """
+    if role:
+        await _check_roles(role, create=create_role)
+    return await g.current_app.sm.create_user(
+        email=email,
+        username=username,
+        password=password,
+        first_name=first_name,
+        last_name=last_name,
+        roles=[role] if role else None,
+    )
+
+
+async def _reset_password(email_or_username: str, password: str):
+    """
+    Reset user password.
+    """
+    user = await g.current_app.sm.get_user(email_or_username)
+    return await g.current_app.sm.reset_password(user, password)
+
+
+async def export_data(
+    file_path: str,
+    data: typing.Literal["users", "roles"],
+    type: typing.Literal["json", "csv"] = "json",
+):
+    """
+    Export data.
+    """
+    data = await g.current_app.sm.export_data(data, type)
+    with open(file_path, "w") as f:
+        f.write(data)
+
+
+async def _cleanup():
+    """
+    Cleanup unused permissions from apis and roles.
+    """
+    await g.current_app.sm.cleanup()