app.py 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. # -*- coding: utf-8 -*-
  2. r"""算法服务(FastAPI):把 `app_algorithmModel` 的既有函数包成 HTTP 接口 + OpenAPI。
  3. 启动:
  4. python scripts/algorithm_service.py --host 127.0.0.1 --port 18050
  5. (或 `python -m app_algorithmModel.app_algorithmModel_guanlan.service.app --port 18050`)
  6. 接口(全部 GET,只读):
  7. /healthz 存活与版本
  8. /api/endpoints 端点自述(登记表)
  9. /api/{端点名} 见 service/registry.py(判级矩阵/可靠性/可用率/融合面/变桨面/曲线…)
  10. /docs · /openapi.json Swagger UI 与 OpenAPI 文档(FastAPI 自带)
  11. **只读保证**:带写盘副作用的参数在登记表里被固定成只读值(如 curves 的 write=False),
  12. 不会因为调一次接口改了盘上产物。
  13. """
  14. from __future__ import annotations
  15. import argparse
  16. import json
  17. import pathlib
  18. import sys
  19. import time
  20. from typing import Any
  21. _HERE = pathlib.Path(__file__).resolve()
  22. try: # 走公共层的安装根(包结构异常时按位置上跳)
  23. from app_common.app_common_guanlan.api import install_root as _install_root
  24. except ImportError: # pragma: no cover
  25. def _install_root(_f):
  26. return _HERE.parents[4]
  27. ROOT = _install_root(__file__)
  28. if str(ROOT) not in sys.path:
  29. sys.path.insert(0, str(ROOT))
  30. from . import jsonable, registry # noqa: E402
  31. from .deps import ensure_fastapi # noqa: E402
  32. fastapi, uvicorn = ensure_fastapi()
  33. from fastapi import FastAPI, HTTPException, Query, Request # noqa: E402
  34. from fastapi.responses import JSONResponse, PlainTextResponse, Response # noqa: E402
  35. try: # 版本走公共层公开面(模块边界:不直连旧路径壳)
  36. from app_common.app_common_guanlan.api import version as V
  37. _VER = V.VERSION
  38. except Exception: # noqa: BLE001
  39. _VER = 'unknown'
  40. CACHE_TTL = 300.0 # 秒;判级矩阵这类重算是"按窗口"的,缓存与页面的按窗缓存同源
  41. _cached: dict[str, tuple[float, str]] = {}
  42. def create_app() -> FastAPI:
  43. app = FastAPI(title='观澜 · 算法服务', version=_VER,
  44. description='算法层的 HTTP 封装(P10):判级矩阵、可靠性、可用率、融合面、变桨面、曲线检查。'
  45. '数据来源与页面同源,只读不写盘。',
  46. docs_url='/docs', redoc_url='/redoc', openapi_url='/openapi.json')
  47. @app.get('/healthz', summary='存活与版本')
  48. def healthz():
  49. return {'ok': True, 'version': _VER, 'service': 'guanlan-algorithm',
  50. 'endpoints': len(registry.ENDPOINTS), 'time': time.strftime('%Y-%m-%d %H:%M:%S')}
  51. @app.get('/api/endpoints', summary='端点自述')
  52. def endpoints():
  53. return {'count': len(registry.ENDPOINTS), 'items': registry.spec_list()}
  54. @app.get('/api/rpt_export_raw', summary='报告导出(docx/xlsx 字节)')
  55. def rpt_export_raw(fmt: str = 'docx', blocks: str = '', aud: str = 'in', win: str = '2026年',
  56. narr: str | None = None):
  57. """报告导出:返回字节(非 JSON);组装逻辑见 service/report_views.py。"""
  58. from urllib.parse import quote
  59. from . import report_views
  60. data, mime, fn = report_views.export_bytes(fmt=fmt, blocks=blocks, aud=aud, win=win, narr=narr)
  61. return Response(content=data, media_type=mime,
  62. headers={'Content-Disposition': "attachment; filename*=UTF-8''" + quote(fn)})
  63. @app.get('/api/{name}', summary='算法端点(见 /api/endpoints)')
  64. def algorithm(name: str, request: Request,
  65. ttl: float | None = Query(None, description='缓存秒数(默认 300;0 = 不走缓存)')):
  66. """通用取数:**按登记表声明的参数**从查询串透传(P12 起不再写死参数名)。
  67. 实逮:原先把参数写死成 span/since/month_from/all_turbines,新增端点(如 ont_list 的 type/t/limit)
  68. 就只能改代码;改为按 spec 解析后,登记表成为唯一需要维护的清单。
  69. """
  70. spec = registry.ENDPOINTS.get(name)
  71. if not spec:
  72. raise HTTPException(status_code=404,
  73. detail=f'未登记端点 {name!r};可用: {", ".join(sorted(registry.ENDPOINTS))}')
  74. params: dict[str, Any] = {}
  75. for qname, (typ, fname, fixed) in (spec.get('args') or {}).items():
  76. if fixed is not None:
  77. continue
  78. if qname not in request.query_params:
  79. continue
  80. raw = request.query_params.get(qname)
  81. try:
  82. params[fname] = raw if typ == 'str' else (int(raw) if typ == 'int' else raw.lower() in ('1', 'true', 'yes'))
  83. except Exception: # noqa: BLE001
  84. raise HTTPException(status_code=400, detail=f'参数 {qname} 类型应为 {typ}')
  85. key = name + '|' + json.dumps(params, sort_keys=True)
  86. ttl = CACHE_TTL if ttl is None else max(0.0, ttl)
  87. now = time.time()
  88. if ttl and key in _cached:
  89. ts, body = _cached[key]
  90. if now - ts < ttl:
  91. return JSONResponse(content=json.loads(body), headers={'x-guanlan-cache': 'hit'})
  92. t0 = time.time()
  93. try:
  94. payload = registry.call(name, params)
  95. except Exception as e: # noqa: BLE001
  96. raise HTTPException(status_code=500, detail=f'{type(e).__name__}: {e}') from e
  97. text = jsonable.dumps(payload)
  98. if ttl:
  99. _cached[key] = (now, text)
  100. return JSONResponse(content=json.loads(text),
  101. headers={'x-guanlan-cache': 'miss', 'x-guanlan-seconds': '%.2f' % (time.time() - t0)})
  102. @app.get('/api/{name}/raw', summary='同一端点的确定性 JSON 文本(对拍用)',
  103. response_class=PlainTextResponse)
  104. def algorithm_raw(name: str):
  105. if name not in registry.ENDPOINTS:
  106. raise HTTPException(status_code=404, detail=f'未登记端点 {name!r}')
  107. return jsonable.dumps(registry.call(name, {}))
  108. return app
  109. app = create_app()
  110. def main(argv: list[str] | None = None) -> int:
  111. ap = argparse.ArgumentParser(description='观澜 · 算法服务(FastAPI)')
  112. ap.add_argument('--host', default='127.0.0.1')
  113. ap.add_argument('--port', type=int, default=18050)
  114. ap.add_argument('--reload', action='store_true')
  115. ap.add_argument('--log-level', default='info')
  116. a = ap.parse_args(argv)
  117. # 统一日志格式(用户令 2):stdout/stderr 每行加 `时间戳 级别 组件` 前缀 ——
  118. # 与其它服务(serve/detail/cms/gateway/static_server)同一套设施。不这么做,日志门禁会报
  119. # "logs/xxx.log 末尾 N 行都不符合统一格式"(2026-09-29 实逮)。
  120. try:
  121. from app_common.app_common_guanlan.api import logfile as _lf
  122. _lf.prefix_stdout('algorithm')
  123. except Exception: # noqa: BLE001
  124. pass
  125. print(f'观澜 · 算法服务 v{_VER} → http://{a.host}:{a.port}/docs ({len(registry.ENDPOINTS)} 个端点)', flush=True)
  126. uvicorn.run(app if not a.reload else 'app_algorithmModel.app_algorithmModel_guanlan.service.app:app',
  127. host=a.host, port=a.port, reload=a.reload, log_level=a.log_level)
  128. return 0
  129. if __name__ == '__main__':
  130. sys.exit(main())