zrb 1.0.0a2__py3-none-any.whl → 1.0.0a4__py3-none-any.whl

zrb/builtin/project/add/fastapp_template/common/db_engine.py

@@ -0,0 +1,5 @@
+from fastapp_template.config import APP_DB_URL
+from sqlmodel import create_engine
+
+connect_args = {"check_same_thread": False}
+engine = create_engine(APP_DB_URL, connect_args=connect_args)

zrb/builtin/project/add/fastapp_template/common/db_repository.py

@@ -0,0 +1,134 @@
+from typing import Any, Callable, Generic, Type, TypeVar
+
+from fastapp_template.common.error import NotFoundError
+from sqlalchemy import Engine
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
+from sqlmodel import Session, SQLModel, select
+
+DBModel = TypeVar("DBModel", bound=SQLModel)
+ResponseModel = TypeVar("Model", bound=SQLModel)
+CreateModel = TypeVar("CreateModel", bound=SQLModel)
+UpdateModel = TypeVar("UpdateModel", bound=SQLModel)
+
+
+class BaseDBRepository(Generic[DBModel, ResponseModel, CreateModel, UpdateModel]):
+    db_model: Type[DBModel]
+    response_model: Type[ResponseModel]
+    create_model: Type[CreateModel]
+    update_model: Type[UpdateModel]
+    entity_name: str = "entity"
+    column_preprocessors: dict[str, Callable[[Any], Any]] = {}
+
+    def __init__(self, engine: Engine | AsyncEngine):
+        self.engine = engine
+        self.is_async = isinstance(engine, AsyncEngine)
+
+    def _to_response(self, db_instance: DBModel) -> ResponseModel:
+        return self.response_model(**db_instance.model_dump())
+
+    async def create(self, data: CreateModel) -> ResponseModel:
+        data_dict = data.model_dump(exclude_unset=True)
+        for key, preprocessor in self.column_preprocessors.items():
+            if key in data_dict:
+                data_dict[key] = preprocessor(data_dict[key])
+        db_instance = self.db_model(**data_dict)
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                session.add(db_instance)
+                await session.commit()
+                await session.refresh(db_instance)
+        else:
+            with Session(self.engine) as session:
+                session.add(db_instance)
+                session.commit()
+                session.refresh(db_instance)
+        return self._to_response(db_instance)
+
+    async def get_by_id(self, item_id: str) -> ResponseModel:
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                db_instance = await session.get(self.db_model, item_id)
+        else:
+            with Session(self.engine) as session:
+                db_instance = session.get(self.db_model, item_id)
+        if not db_instance:
+            raise NotFoundError(f"{self.entity_name} not found")
+        return self._to_response(db_instance)
+
+    async def get_all(self, page: int = 1, page_size: int = 10) -> list[ResponseModel]:
+        offset = (page - 1) * page_size
+        statement = select(self.db_model).offset(offset).limit(page_size)
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                result = await session.execute(statement)
+                results = result.scalars().all()
+        else:
+            with Session(self.engine) as session:
+                results = session.exec(statement).all()
+        return [self._to_response(instance) for instance in results]
+
+    async def update(self, item_id: str, data: UpdateModel) -> ResponseModel:
+        update_data = data.model_dump(exclude_unset=True)
+        for key, value in update_data.items():
+            if key in self.column_preprocessors:
+                update_data[key] = self.column_preprocessors[key](value)
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                db_instance = await session.get(self.db_model, item_id)
+                if not db_instance:
+                    raise NotFoundError(f"{self.entity_name} not found")
+                for key, value in update_data.items():
+                    setattr(db_instance, key, value)
+                session.add(db_instance)
+                await session.commit()
+                await session.refresh(db_instance)
+        else:
+            with Session(self.engine) as session:
+                db_instance = session.get(self.db_model, item_id)
+                if not db_instance:
+                    raise NotFoundError(f"{self.entity_name} not found")
+                for key, value in update_data.items():
+                    setattr(db_instance, key, value)
+                session.add(db_instance)
+                session.commit()
+                session.refresh(db_instance)
+        return self._to_response(db_instance)
+
+    async def delete(self, item_id: str) -> ResponseModel:
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                db_instance = await session.get(self.db_model, item_id)
+                if not db_instance:
+                    raise NotFoundError(f"{self.entity_name} not found")
+                await session.delete(db_instance)
+                await session.commit()
+        else:
+            with Session(self.engine) as session:
+                db_instance = session.get(self.db_model, item_id)
+                if not db_instance:
+                    raise NotFoundError(f"{self.entity_name} not found")
+                session.delete(db_instance)
+                session.commit()
+        return self._to_response(db_instance)
+
+    async def create_bulk(self, data_list: list[CreateModel]) -> list[ResponseModel]:
+        db_instances = []
+        for data in data_list:
+            data_dict = data.model_dump(exclude_unset=True)
+            for key, preprocessor in self.column_preprocessors.items():
+                if key in data_dict:
+                    data_dict[key] = preprocessor(data_dict[key])
+            db_instances.append(self.db_model(**data_dict))
+        if self.is_async:
+            async with AsyncSession(self.engine) as session:
+                session.add_all(db_instances)
+                await session.commit()
+                for instance in db_instances:
+                    await session.refresh(instance)
+        else:
+            with Session(self.engine) as session:
+                session.add_all(db_instances)
+                session.commit()
+                for instance in db_instances:
+                    session.refresh(instance)
+        return [self._to_response(instance) for instance in db_instances]

zrb/builtin/project/add/fastapp_template/common/error.py

@@ -0,0 +1,8 @@
+from typing import Dict
+
+from fastapi import HTTPException
+
+
+class NotFoundError(HTTPException):
+    def __init__(self, message: str, headers: Dict[str, str] | None = None) -> None:
+        super().__init__(404, {"message": message}, headers)

zrb/builtin/project/add/fastapp_template/common/schema.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class BasicResponse(BaseModel):
+    message: str

zrb/builtin/project/add/fastapp_template/common/usecase.py

@@ -0,0 +1,232 @@
+from enum import Enum
+from functools import partial, wraps
+from typing import Any, Callable, Sequence
+
+import httpx
+from fastapi import APIRouter, params
+from fastapi.routing import APIRoute
+from fastapi.types import IncEx
+from fastapi.utils import generate_unique_id
+from starlette.responses import JSONResponse, Response
+
+
+class RouteParam:
+    def __init__(
+        self,
+        path: str,
+        response_model: Any,
+        status_code: int | None = None,
+        tags: list[str | Enum] | None = None,
+        dependencies: Sequence[params.Depends] | None = None,
+        summary: str | None = None,
+        description: str = "",
+        response_description: str = "",
+        responses: dict[int | str, dict[str, Any]] | None = None,
+        deprecated: bool | None = None,
+        methods: set[str] | list[str] | None = None,
+        operation_id: str | None = None,
+        response_model_include: IncEx | None = None,
+        response_model_exclude: IncEx | None = None,
+        response_model_by_alias: bool = True,
+        response_model_exclude_unset: bool = False,
+        response_model_exclude_defaults: bool = False,
+        response_model_exclude_none: bool = False,
+        include_in_schema: bool = True,
+        response_class: type[Response] = Response,
+        name: str | None = None,
+        openapi_extra: dict[str, Any] | None = None,
+        generate_unique_id_function: Callable[[APIRoute], str] | None = None,
+        func: Callable | None = None,
+    ):
+        self.path = path
+        self.response_model = response_model
+        self.status_code = status_code
+        self.tags = tags
+        self.dependencies = dependencies
+        self.summary = summary
+        self.description = description
+        self.response_description = response_description
+        self.responses = responses
+        self.deprecated = deprecated
+        self.methods = methods
+        self.operation_id = operation_id
+        self.response_model_include = response_model_include
+        self.response_model_exclude = response_model_exclude
+        self.response_model_by_alias = response_model_by_alias
+        self.response_model_exclude_unset = response_model_exclude_unset
+        self.response_model_exclude_defaults = response_model_exclude_defaults
+        self.response_model_exclude_none = response_model_exclude_none
+        self.include_in_schema = include_in_schema
+        self.response_class = response_class
+        self.name = name
+        self.openapi_extra = openapi_extra
+        self.generate_unique_id_function = generate_unique_id_function
+        self.func = func
+
+
+class BaseUsecase:
+    _route_params: dict[str, RouteParam] = {}
+
+    @classmethod
+    def route(
+        cls,
+        path: str,
+        *,
+        response_model: Any = None,
+        status_code: int | None = None,
+        tags: list[str | Enum] | None = None,
+        dependencies: Sequence[params.Depends] | None = None,
+        summary: str | None = None,
+        description: str = None,
+        response_description: str = "Successful Response",
+        responses: dict[int | str, dict[str, Any]] | None = None,
+        deprecated: bool | None = None,
+        methods: set[str] | list[str] | None = None,
+        operation_id: str | None = None,
+        response_model_include: IncEx | None = None,
+        response_model_exclude: IncEx | None = None,
+        response_model_by_alias: bool = True,
+        response_model_exclude_unset: bool = False,
+        response_model_exclude_defaults: bool = False,
+        response_model_exclude_none: bool = False,
+        include_in_schema: bool = True,
+        response_class: type[Response] = JSONResponse,
+        name: str | None = None,
+        openapi_extra: dict[str, Any] | None = None,
+        generate_unique_id_function: Callable[[APIRoute], str] = generate_unique_id,
+    ):
+        """
+        Decorator to register a method with its HTTP details.
+        """
+
+        def decorator(func: Callable):
+            cls._route_params[func.__name__] = RouteParam(
+                path=path,
+                response_model=response_model,
+                status_code=status_code,
+                tags=tags,
+                dependencies=dependencies,
+                summary=summary,
+                description=description,
+                response_description=response_description,
+                responses=responses,
+                deprecated=deprecated,
+                methods=methods,
+                operation_id=operation_id,
+                response_model_include=response_model_include,
+                response_model_exclude=response_model_exclude,
+                response_model_by_alias=response_model_by_alias,
+                response_model_exclude_unset=response_model_exclude_unset,
+                response_model_exclude_defaults=response_model_exclude_defaults,
+                response_model_exclude_none=response_model_exclude_none,
+                include_in_schema=include_in_schema,
+                response_class=response_class,
+                name=name,
+                openapi_extra=openapi_extra,
+                generate_unique_id_function=generate_unique_id_function,
+                func=func,
+            )
+
+            @wraps(func)
+            async def wrapped(*args, **kwargs):
+                return await func(*args, **kwargs)
+
+            return wrapped
+
+        return decorator
+
+    def as_direct_client(self):
+        """
+        Dynamically create a direct client class.
+        """
+        _methods = self._route_params
+        DirectClient = create_client_class("DirectClient")
+        for name, details in _methods.items():
+            func = details.func
+            client_method = create_direct_client_method(func, self)
+            setattr(DirectClient, name, client_method.__get__(DirectClient))
+        return DirectClient
+
+    def as_api_client(self, base_url: str):
+        """
+        Dynamically create an API client class.
+        """
+        _methods = self._route_params
+        APIClient = create_client_class("APIClient")
+        # Dynamically generate methods
+        for name, param in _methods.items():
+            client_method = create_api_client_method(param, base_url)
+            setattr(APIClient, name, client_method.__get__(APIClient))
+        return APIClient
+
+    def serve_route(self, app: APIRouter):
+        """
+        Dynamically add routes to FastAPI.
+        """
+        for _, route_param in self._route_params.items():
+            bound_func = partial(route_param.func, self)
+            bound_func.__name__ = route_param.func.__name__
+            bound_func.__doc__ = route_param.func.__doc__
+            app.add_api_route(
+                path=route_param.path,
+                endpoint=bound_func,
+                response_model=route_param.response_model,
+                status_code=route_param.status_code,
+                tags=route_param.tags,
+                dependencies=route_param.dependencies,
+                summary=route_param.summary,
+                description=route_param.description,
+                response_description=route_param.response_description,
+                responses=route_param.responses,
+                deprecated=route_param.deprecated,
+                methods=route_param.methods,
+                operation_id=route_param.operation_id,
+                response_model_include=route_param.response_model_include,
+                response_model_exclude=route_param.response_model_exclude,
+                response_model_by_alias=route_param.response_model_by_alias,
+                response_model_exclude_unset=route_param.response_model_exclude_unset,
+                response_model_exclude_defaults=route_param.response_model_exclude_defaults,
+                response_model_exclude_none=route_param.response_model_exclude_none,
+                include_in_schema=route_param.include_in_schema,
+                response_class=route_param.response_class,
+                name=route_param.name,
+                openapi_extra=route_param.openapi_extra,
+                generate_unique_id_function=route_param.generate_unique_id_function,
+            )
+
+
+def create_client_class(name):
+    class Client:
+        pass
+
+    Client.__name__ = name
+    return Client
+
+
+def create_direct_client_method(func: Callable, usecase: BaseUsecase):
+    async def client_method(self, *args, **kwargs):
+        return await func(usecase, *args, **kwargs)
+
+    return client_method
+
+
+def create_api_client_method(param: RouteParam, base_url: str):
+    _url = param.path
+    _methods = [method.lower() for method in param.methods]
+
+    async def client_method(self, *args, **kwargs):
+        async with httpx.AsyncClient() as client:
+            url = base_url + _url.format(**kwargs)
+            if "post" in _methods:
+                response = await client.post(url, json=kwargs)
+            elif "put" in _methods:
+                response = await client.put(url, json=kwargs)
+            elif "delete" in _methods:
+                response = await client.delete(url, json=kwargs)
+            else:
+                response = await client.get(url, params=kwargs)
+            # Add more HTTP methods as needed
+            response.raise_for_status()
+            return response.json()
+
+    return client_method

zrb/builtin/project/add/fastapp_template/config.py

@@ -0,0 +1,29 @@
+import os
+
+APP_PATH = os.path.dirname(__file__)
+
+APP_MODE = os.getenv("APP_NAME_MODE", "monolith")
+APP_MODULES = [
+    module.strip()
+    for module in os.getenv("APP_NAME_MODULES", "").split(",")
+    if module.strip() != ""
+]
+APP_PORT = int(os.getenv("APP_NAME_PORT", "3000"))
+APP_COMMUNICATION = os.getenv(
+    "APP_NAME_COMMUNICATION", "direct" if APP_MODE == "monolith" else "api"
+)
+APP_REPOSITORY_TYPE = os.getenv("APP_REPOSITORY_TYPE", "db")
+APP_DB_URL = os.getenv(
+    "APP_DB_URL",
+    (
+        f"sqlite:///{APP_PATH}/monolith.db"
+        if APP_MODE == "monolith" or len(APP_MODULES) == 0
+        else f"sqlite:///{APP_PATH}/{APP_MODULES[0]}_microservices.db"
+    ),
+)
+APP_AUTH_SUPER_USER = os.getenv("APP_NAME_AUTH_SUPER_USER", "admin")
+APP_AUTH_SUPER_USER_PASSWORD = os.getenv(
+    "APP_NAME_AUTH_SUPER_USER_PASSWORD", "secure-password"
+)
+
+APP_AUTH_BASE_URL = os.getenv("APP_NAME_AUTH_BASE_URL", "http://localhost:3001")

zrb/builtin/project/add/fastapp_template/main.py

@@ -0,0 +1,7 @@
+from fastapp_template.common.app import app
+from fastapp_template.module.auth import route as auth_route
+from fastapp_template.module.gateway import route as gateway_route
+
+assert app
+assert gateway_route
+assert auth_route

zrb/builtin/project/add/fastapp_template/migrate.py

@@ -0,0 +1,3 @@
+from fastapp_template.module.auth import migration as auth_migration
+
+assert auth_migration

zrb/builtin/project/add/fastapp_template/module/auth/alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = migration
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = ../..
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migration/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migration/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

zrb/builtin/project/add/fastapp_template/module/auth/client/api_client.py

@@ -0,0 +1,7 @@
+from fastapp_template.config import APP_AUTH_BASE_URL
+from fastapp_template.module.auth.client.base_client import BaseClient
+from fastapp_template.module.auth.service.user.usecase import user_usecase
+
+
+class APIClient(user_usecase.as_api_client(base_url=APP_AUTH_BASE_URL), BaseClient):
+    pass

zrb/builtin/project/add/fastapp_template/module/auth/client/base_client.py

@@ -0,0 +1,27 @@
+from abc import ABC, abstractmethod
+
+from fastapp_template.schema.user import UserCreate, UserResponse, UserUpdate
+
+
+class BaseClient(ABC):
+    @abstractmethod
+    async def get_user_by_id(self, user_id: str) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def get_all_users(self) -> list[UserResponse]:
+        pass
+
+    @abstractmethod
+    async def create_user(
+        self, data: UserCreate | list[UserCreate]
+    ) -> UserResponse | list[UserResponse]:
+        pass
+
+    @abstractmethod
+    async def update_user(self, user_id: str, data: UserUpdate) -> UserResponse:
+        pass
+
+    @abstractmethod
+    async def delete_user(self, user_id: str) -> UserResponse:
+        pass

zrb/builtin/project/add/fastapp_template/module/auth/client/direct_client.py

@@ -0,0 +1,6 @@
+from fastapp_template.module.auth.client.base_client import BaseClient
+from fastapp_template.module.auth.service.user.usecase import user_usecase
+
+
+class DirectClient(user_usecase.as_direct_client(), BaseClient):
+    pass

zrb/builtin/project/add/fastapp_template/module/auth/client/factory.py

@@ -0,0 +1,9 @@
+from fastapp_template.config import APP_COMMUNICATION
+from fastapp_template.module.auth.client.api_client import APIClient
+from fastapp_template.module.auth.client.base_client import BaseClient
+from fastapp_template.module.auth.client.direct_client import DirectClient
+
+if APP_COMMUNICATION == "direct":
+    client: BaseClient = DirectClient()
+elif APP_COMMUNICATION == "api":
+    client: BaseClient = APIClient()

zrb/builtin/project/add/fastapp_template/module/auth/migration/README

@@ -0,0 +1 @@
+Generic single-database configuration.