half-orm-gen 1.0.0a1__py3-none-any.whl

half_orm_gen/templates_fastapi.py

@@ -0,0 +1,264 @@
+"""
+FastAPI template strings for the generated api/app.py.
+
+Used by `half_orm litestar generate --fastapi`.
+Only auto-CRUD routes (CRUD_ACCESS) are supported; @api_* decorators are
+Litestar-specific and are ignored in FastAPI mode.
+"""
+
+from half_orm_gen.templates import CRUD_HELPERS, CRUD_MODULE_IMPORT
+
+FRAMEWORK = 'fastapi'
+
+HEADER = """\
+# This file is generated by `half_orm litestar generate --fastapi`. Do not edit.
+from typing import Optional, List, Any
+import typing
+import datetime
+import uuid
+import os
+import sys
+from contextlib import asynccontextmanager
+
+cur_dir = os.path.dirname(os.path.abspath(__file__))
+sys.path.insert(0, cur_dir)
+par_dir = os.path.join(cur_dir, os.path.pardir)
+sys.path.insert(0, par_dir)
+
+from fastapi import FastAPI, APIRouter, HTTPException, Request
+from pydantic import BaseModel
+
+from {module} import ho_baseclasses
+from {module} import ho_typeddicts
+from {module} import MODEL
+
+try:
+    from api.custom.routes import router as _custom_router
+    _has_custom = True
+except ImportError:
+    _has_custom = False
+
+router = APIRouter()
+
+"""
+
+FOOTER = '''
+_HO_WARN = """
+======================================================================
+  halfORM DEV HELPERS ACTIVE — NOT FOR PRODUCTION
+======================================================================
+  /ho_roles  : exposes all declared roles (no authentication)
+  /ho_access : exposes the full access map filtered by role
+  _get_roles : bearer token used directly as a role name
+               (no signature verification)
+  ho_dev     : super-role with full access to all resources
+               (Authorization: Bearer ho_dev)
+
+  Replace the Authorization middleware with a real JWT implementation
+  before deploying to production.
+======================================================================
+"""
+
+_HO_WARN_SHOWN = False
+
+@asynccontextmanager
+async def _ho_lifespan(app: FastAPI):
+    global _HO_WARN_SHOWN
+    import sys
+    await MODEL.aconnect()
+    if MODEL._production_mode:
+        raise RuntimeError(
+            "halfORM DEV HELPERS are active (ho_roles, ho_access, _get_roles fallback). "
+            "These routes and the bearer-token-as-role fallback are not safe for production. "
+            "Secure or remove them before deploying."
+        )
+    if not _HO_WARN_SHOWN:
+        print(_HO_WARN, file=sys.stderr, flush=True)
+        _HO_WARN_SHOWN = True
+    yield
+
+application = FastAPI(lifespan=_ho_lifespan{openapi_config})
+application.include_router(router)
+if _has_custom:
+    application.include_router(_custom_router)
+'''
+
+OPENAPI_CONFIG = """, title="{title}", version="{version}" """
+
+HO_ACCESS_ROUTE = (
+    '\n_STATIC_ACCESS_MAP = {json_str}\n'
+    '\n_ACCESS_MAP = get_access_map()\n\n'
+    '@router.get("{version_prefix}/ho_access")\n'
+    'async def _crud_access_map(request: Request) -> dict:\n'
+    '    authorized_roles = _get_roles(request)\n'
+    '    return _filter_access_for_roles(_ACCESS_MAP, authorized_roles)\n'
+)
+
+HO_ROLES_ROUTE = (
+    '\n_ROLES = {roles_json}\n\n'
+    '@router.get("{version_prefix}/ho_roles")\n'
+    'async def _crud_roles_list() -> list:\n'
+    '    return _ROLES\n'
+)
+
+WS_HELPERS = """
+import json as _json
+from fastapi import WebSocket as _WS, WebSocketDisconnect as _WSD
+
+class _ConnectionManager:
+    def __init__(self):
+        self._sockets: set = set()
+
+    async def connect(self, ws: _WS) -> None:
+        await ws.accept()
+        self._sockets.add(ws)
+
+    def disconnect(self, ws: _WS) -> None:
+        self._sockets.discard(ws)
+
+    async def broadcast(self, message: dict) -> None:
+        dead = set()
+        for s in set(self._sockets):
+            try:
+                await s.send_text(_json.dumps(message, default=str))
+            except Exception:
+                dead.add(s)
+        self._sockets -= dead
+
+_manager = _ConnectionManager()
+
+@router.websocket("{version_prefix}/ws")
+async def _ws_handler(ws: _WS) -> None:
+    await _manager.connect(ws)
+    try:
+        while True:
+            await ws.receive_text()
+    except _WSD:
+        pass
+    finally:
+        _manager.disconnect(ws)
+"""
+
+CRUD_GET_LIST = """
+@router.get("{path}", description="{access_description}")
+async def {handler_name}(
+    request: Request,
+{filter_params}    fields: Optional[List[str]] = None,
+    limit: Optional[int] = None,
+    offset: Optional[int] = None,
+) -> list:
+    api_excluded = getattr({module_alias}, 'API_EXCLUDED_FIELDS', [])
+    roles = _get_roles(request)
+    filter_kwargs = {{{filter_dict}}}
+    role_filter = _get_role_filter(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "GET", roles)
+    authorized = _effective_out_fields(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "GET", roles, api_excluded)
+    if fields:
+        projection = [f for f in fields if not authorized or f in authorized]
+    else:
+        projection = authorized
+    return await {module_alias}.{class_name}(**{{**filter_kwargs, **role_filter}}).ho_aselect(
+        *projection, limit=limit, offset=offset
+    )
+"""
+
+CRUD_GET_ONE = """
+@router.get("{path}/{{id}}", description="{access_description}")
+async def {handler_name}_get(
+    request: Request,
+    id: {pk_py_type},
+) -> dict:
+    api_excluded = getattr({module_alias}, 'API_EXCLUDED_FIELDS', [])
+    roles = _get_roles(request)
+    role_filter = _get_role_filter(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "GET", roles)
+    authorized = _effective_out_fields(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "GET", roles, api_excluded)
+    rows = await {module_alias}.{class_name}({pk_instance_filter}, **role_filter).ho_aselect(*authorized)
+    if not rows:
+        raise HTTPException(status_code=404)
+    return rows[0]
+"""
+
+CRUD_POST = """
+@router.post("{path}", description="{access_description}")
+async def {handler_name}_create(
+    request: Request,
+    data: {in_typedict},
+) -> dict:
+    api_excluded = getattr({module_alias}, 'API_EXCLUDED_FIELDS', [])
+    in_fields = _effective_in_fields(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "POST", _get_roles(request), api_excluded)
+    payload = {{k: v for k, v in data.model_dump(exclude_none=True).items() if not in_fields or k in in_fields}}
+    result = await {module_alias}.{class_name}(**payload).ho_ainsert()
+    await _manager.broadcast({{"event": "create", "resource": "{resource}", "id": {pk_broadcast_expr}}})
+    return result
+"""
+
+CRUD_PUT = """
+@router.put("{path}/{{id}}", description="{access_description}")
+async def {handler_name}_update(
+    request: Request,
+    id: {pk_py_type},
+    data: {in_typedict},
+) -> dict:
+    api_excluded = getattr({module_alias}, 'API_EXCLUDED_FIELDS', [])
+    in_fields = _effective_in_fields(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "PUT", _get_roles(request), api_excluded)
+    payload = {{k: v for k, v in data.model_dump(exclude_none=True).items() if not in_fields or k in in_fields}}
+    authorized = _effective_out_fields(getattr({module_alias}, 'CRUD_ACCESS', {{}}), "PUT", _get_roles(request), api_excluded)
+    result = await {module_alias}.{class_name}({pk_instance_filter}).ho_aupdate(*(authorized or ['*']), **payload)
+    if not result:
+        raise HTTPException(status_code=404)
+    await _manager.broadcast({{"event": "update", "resource": "{resource}", "id": id}})
+    return result[0]
+"""
+
+CRUD_DELETE = """
+@router.delete("{path}/{{id}}", description="{access_description}")
+async def {handler_name}_delete(
+    request: Request,
+    id: {pk_py_type},
+) -> None:
+    await _ws_broadcast_cascade(
+        {module_alias}.{class_name}({pk_instance_filter}), "{resource}", id
+    )
+    result = await {module_alias}.{class_name}({pk_instance_filter}).ho_adelete('*')
+    if not result:
+        raise HTTPException(status_code=404)
+    await _manager.broadcast({{"event": "delete", "resource": "{resource}", "id": id}})
+"""
+
+WS_CASCADE_HELPER = """
+_WS_RMAP: dict = {{
+{resource_entries}
+}}
+
+async def _ws_broadcast_cascade(inst, resource: str, pk_val, _seen: set | None = None) -> None:
+    if _seen is None:
+        _seen = set()
+    _key = (resource, str(pk_val))
+    if _key in _seen:
+        return
+    _seen.add(_key)
+    for _fk in inst._ho_fkeys.values():
+        if not _fk.is_reverse or len(_fk.fk_names) != 1:
+            continue
+        _fk_field = _fk.fk_names[0]
+        _fqtn     = _fk.remote['fqtn']
+        _r        = f"{{_fqtn[0].replace('.', '_')}}/{{_fqtn[1]}}"
+        if _r not in _WS_RMAP:
+            continue
+        _cls, _pk = _WS_RMAP[_r]
+        for _row in await _cls(**{{_fk_field: pk_val}}).ho_aselect(_pk):
+            _rid = _row[_pk]
+            await _ws_broadcast_cascade(_cls(**{{_pk: _rid}}), _r, _rid, _seen)
+            await _manager.broadcast({{"event": "delete", "resource": _r, "id": _rid}})
+"""
+
+
+def typedict_block(class_name: str, field_names: list, all_fields: dict) -> str:
+    from half_orm_gen.crud_routes import _py_type_str
+    lines = [f'class {class_name}(BaseModel):']
+    valid = [(f, all_fields[f]) for f in field_names if f in all_fields]
+    if not valid:
+        lines.append('    pass')
+    else:
+        for fname, fobj in valid:
+            lines.append(f'    {fname}: Optional[{_py_type_str(fobj.py_type)}] = None')
+    return '\n'.join(lines)

half_orm_gen/tools.py

@@ -0,0 +1,66 @@
+"""
+Decorators for exposing halfORM class methods as Litestar API routes.
+
+Usage in a halfORM relation class::
+
+    from half_orm_gen import tools
+
+    class MyRelation(MODEL.get_relation_class('schema.table')):
+        @tools.api_get('/items/{id: uuid}', guards=['connected'])
+        async def get_item(self, request: "Request"):
+            ...
+
+        @tools.api_post('/items', guards=['connected'])
+        async def create_item(self, request: "Request"):
+            ...
+
+The decorated methods are discovered by ``half_orm litestar generate`` which
+produces the ``api/main.py`` Litestar application file.
+"""
+
+import inspect
+from functools import wraps
+from typing import Callable
+from litestar import get, post, put, delete, patch
+
+
+def create_api_decorator(http_method: str, litestar_decorator: Callable):
+    """Create an api_* decorator that mirrors the signature of the given Litestar decorator."""
+    litestar_sig = inspect.signature(litestar_decorator)
+
+    def api_decorator(*args, **kwargs):
+        bound_args = litestar_sig.bind(*args, **kwargs)
+        bound_args.apply_defaults()
+
+        def wrapper(func: Callable) -> Callable:
+            @wraps(func)
+            def inner(*func_args, **func_kwargs):
+                return func(*func_args, **func_kwargs)
+
+            inner.is_api_route = True
+            inner.http_method = http_method
+            inner.litestar_params = dict(bound_args.arguments)
+            inner.metadata = {
+                'signature': inspect.signature(func),
+                'documentation': func.__doc__ or '',
+                'litestar_decorator': litestar_decorator,
+                'bound_arguments': bound_args,
+            }
+            return inner
+
+        return wrapper
+
+    api_decorator.__signature__ = litestar_sig
+    api_decorator.__name__ = f"api_{http_method.lower()}"
+    api_decorator.__doc__ = (
+        f"API decorator for {http_method} routes. "
+        f"Accepts the same arguments as litestar.{http_method.lower()}."
+    )
+    return api_decorator
+
+
+api_get    = create_api_decorator('GET',    get)
+api_post   = create_api_decorator('POST',   post)
+api_put    = create_api_decorator('PUT',    put)
+api_delete = create_api_decorator('DELETE', delete)
+api_patch  = create_api_decorator('PATCH',  patch)

half_orm_gen/version.txt

@@ -0,0 +1 @@
+1.0.0-a1

half_orm_gen-1.0.0a1.dist-info/METADATA

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: half_orm_gen
+Version: 1.0.0a1
+Summary: API and frontend backoffice generation for halfORM projects.
+Author-email: Joël Maïzi <joel.maizi@collorg.org>
+License-Expression: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/half-orm/half-orm-gen
+Keywords: litestar,half-orm,rest,api,postgresql,code-generation,asgi,orm,svelte,angular
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: half-orm<1.1.0,>=1.0.0rc13
+Requires-Dist: half-orm-dev<1.1.0,>=1.0.0a32
+Requires-Dist: litestar>=2.0.0
+Dynamic: license-file
+
+# half-orm-gen
+
+A [halfORM](https://github.com/half-orm/half-orm) extension that generates a
+[Litestar](https://litestar.dev) or [FastAPI](https://fastapi.tiangolo.com) REST API
+**and** a frontend backoffice ([SvelteKit 5](https://svelte.dev) or
+[Angular](https://angular.dev)) from your halfORM project.
+
+## Installation
+
+```bash
+pip install half-orm-gen
+```
+
+---
+
+## API
+
+```bash
+# Litestar
+half_orm gen api --litestar
+litestar --app api.app:application run --reload
+
+# FastAPI
+half_orm gen api --fastapi
+uvicorn api.app:application --reload
+```
+
+---
+
+## Frontend backoffice
+
+```bash
+# SvelteKit 5
+half_orm gen frontend --svelte
+cd frontend/svelte && npm install && npm run dev
+
+# Angular
+half_orm gen frontend --angular
+cd frontend/angular && npm install && npm start
+```
+
+---
+
+## See also
+
+- [half-orm](https://github.com/half-orm/half-orm) — the PostgreSQL ORM at the core
+- [half-orm-dev](https://github.com/half-orm/half-orm-dev) — the development framework

half_orm_gen-1.0.0a1.dist-info/RECORD

@@ -0,0 +1,29 @@
+half_orm_gen/__init__.py,sha256=gsIzNnl38-e4XqYc4ud04wZTvebMnzfHer8K5ISvVi0,448
+half_orm_gen/api_routes.py,sha256=wm90JWm5U2lTabfIFXXBKkIFvutjMb6I6qOkanNgdk4,7954
+half_orm_gen/cli_extension.py,sha256=BNALyL3aR3jkPDB9OWIvc5BOUSBnSkYul9tcV7ParXQ,6266
+half_orm_gen/crud_routes.py,sha256=GwF7mTXSeXjmZ7TxDntMAn0uEzCStiK3MSHKhssP1W8,20641
+half_orm_gen/generate.py,sha256=gPlfFuUIbwh47QHadehkbTNYe0f-F02i5y4oI5aoaKM,4094
+half_orm_gen/scaffold.py,sha256=iVRk81YoylJeeQJ9yz56KpzXXqTkJIYrGzC_LLeMCgM,1303
+half_orm_gen/templates.py,sha256=Zdfi_SDnZVOzhiTM7myoDO5bhbpyeaxUcVfkWimr_Os,15542
+half_orm_gen/templates_fastapi.py,sha256=yYauOFha1ehsQyaKbnnnS-wEHo5l59uOmQj1OqNQ6g0,9172
+half_orm_gen/tools.py,sha256=0e557C-rifjurzlOyD2B8UHO7eMrAkaGXfYFCpow5OY,2278
+half_orm_gen/version.txt,sha256=V7I2VeuW_SCn04qwchb5-EAwEtzMEiDRAlYord5iGng,9
+half_orm_gen/gen_app/__init__.py,sha256=OW0tcuXBQUdHwuDBVj7Bo0Xse8U4f3tgukBfhgxsZsM,730
+half_orm_gen/gen_app/angular.py,sha256=6FLSBV9CJV5a-l1tcngANkzKt6-yxECHtjPAmfLJejs,66718
+half_orm_gen/gen_app/svelte.py,sha256=upqduNPimoPfbsRw66H0V93fG8N-lilvvb3jIuGhrj0,50823
+half_orm_gen/gen_store/__init__.py,sha256=Ww3v9nuZNUI-GR5FyzmjSrokRydDt-NhNmKoR11Zd24,844
+half_orm_gen/gen_store/base.py,sha256=mBkoF8X4pEDv2n3ol9-Nqyu3LVGvgOEGDZej_Qv9gbU,3390
+half_orm_gen/gen_store/svelte.py,sha256=G-qIqjEkAbAO3reZL6J-bIK_OEqUwmhf6f64BwWB3_8,12207
+half_orm_gen/scaffolding/api_init.py,sha256=VLdSX8mfJ3P9ul_XOw50g0TzapwfFtErpVIus8ET4pA,13
+half_orm_gen/scaffolding/custom_authorization.py,sha256=3V7BtO5EBE0RxVZ7hUpzyLOAEcNhmWNUZuZfRIQykxg,1435
+half_orm_gen/scaffolding/custom_init.py,sha256=mzymXvpfT4uM2G226Cc48FDa2dY0zbvNO1KC4QwVwUw,20
+half_orm_gen/scaffolding/custom_middlewares_init.py,sha256=oWxx6F34oVC7Hj7qGIBxy3QQcZl7hrGRMIItMeq-XzY,395
+half_orm_gen/scaffolding/custom_routes.py,sha256=YomUbbssjGKhD5wgQoUvW8fEkZcY1LyLa7eH3SEH-PA,362
+half_orm_gen/scaffolding/guards.py,sha256=Z48COmmfXcBDcL4AgwUdofuuXvj8oud5Qi5ZYRTnbw8,1257
+half_orm_gen/scaffolding/roles_core.py,sha256=V6mO33e_DXaCBK4964B4nr3XUfAj7WtDjF4we1k3Wyk,2048
+half_orm_gen-1.0.0a1.dist-info/licenses/AUTHORS,sha256=EaXsDPeylv3aZMFUOd5OJAqS3ZNCIKlj5nTQcjaSZ48,108
+half_orm_gen-1.0.0a1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+half_orm_gen-1.0.0a1.dist-info/METADATA,sha256=oxg1N98PuYqoTLw-ZFM6axODhkOqG3WSJR6eHbcvDB4,2036
+half_orm_gen-1.0.0a1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+half_orm_gen-1.0.0a1.dist-info/top_level.txt,sha256=bF9PTTtutOHtVCTiw62Ih0hqk4M_Ze9smNXdh32i4O0,13
+half_orm_gen-1.0.0a1.dist-info/RECORD,,

half_orm_gen-1.0.0a1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

half_orm_gen-1.0.0a1.dist-info/licenses/AUTHORS

@@ -0,0 +1,3 @@
+# This is the list of half_orm's significant contributors.
+# Hopefully, it will become larger...
+Joël Maizi