chore: add base config and package structure

This commit is contained in:
ila
2026-07-04 23:24:51 +08:00
parent 5a7ea348e5
commit 79c57a63c5
14 changed files with 96 additions and 6 deletions
+5
View File
@@ -0,0 +1,5 @@
CHIS_BASE_URL=
CHIS_PUBLIC_KEY=
REDIS_URL=redis://localhost:6379/0
LOG_DIR=logs
ARCHIVE_DIR=archives
+4
View File
@@ -1,8 +1,12 @@
from flask import Flask from flask import Flask
from app.config import BaseConfig, load_config_from_env
def create_app(config_object=None): def create_app(config_object=None):
app = Flask(__name__) app = Flask(__name__)
app.config.from_object(BaseConfig)
app.config.update(load_config_from_env())
if config_object: if config_object:
if isinstance(config_object, dict): if isinstance(config_object, dict):
+1
View File
@@ -0,0 +1 @@
"""CHIS integration layer."""
+14
View File
@@ -1,2 +1,16 @@
import os
class BaseConfig: class BaseConfig:
JSON_AS_ASCII = False JSON_AS_ASCII = False
def load_config_from_env(environ=None):
source = environ or os.environ
return {
"CHIS_BASE_URL": source.get("CHIS_BASE_URL", ""),
"CHIS_PUBLIC_KEY": source.get("CHIS_PUBLIC_KEY", ""),
"REDIS_URL": source.get("REDIS_URL", "redis://localhost:6379/0"),
"LOG_DIR": source.get("LOG_DIR", "logs"),
"ARCHIVE_DIR": source.get("ARCHIVE_DIR", "archives"),
}
+1
View File
@@ -0,0 +1 @@
"""Data mapping layer."""
+1
View File
@@ -0,0 +1 @@
"""Request middleware helpers."""
+1
View File
@@ -0,0 +1 @@
"""Persistence and cache repositories."""
+1
View File
@@ -0,0 +1 @@
"""Application service layer."""
+1
View File
@@ -0,0 +1 @@
"""Request validators."""
+1 -1
View File
@@ -19,7 +19,7 @@
| ID | 任务 | 依赖 | 验收要点 | 状态 | | ID | 任务 | 依赖 | 验收要点 | 状态 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| T-001 | 初始化 Flask 项目骨架 | - | 使用当前系统 Python 3.8,不创建虚拟环境;创建 `requirements.txt` 并固定 `Flask==3.0.3`;使用 application factory 模式实现 `create_app(config_object=None)`;本地 health check API 可启动;真实命令同步到技术栈和当前状态 | DONE | | T-001 | 初始化 Flask 项目骨架 | - | 使用当前系统 Python 3.8,不创建虚拟环境;创建 `requirements.txt` 并固定 `Flask==3.0.3`;使用 application factory 模式实现 `create_app(config_object=None)`;本地 health check API 可启动;真实命令同步到技术栈和当前状态 | DONE |
| T-002 | 建立基础配置与目录 | T-001 | 目录符合架构文档;配置从环境变量读取;无真实密钥 | TODO | | T-002 | 建立基础配置与目录 | T-001 | 目录符合架构文档;配置从环境变量读取;无真实密钥 | DONE |
| T-003 | 建立最小测试框架 | T-001 | pytest 可运行;至少有 `create_app` / health check 测试,能通过测试配置创建 Flask app | TODO | | T-003 | 建立最小测试框架 | T-001 | pytest 可运行;至少有 `create_app` / health check 测试,能通过测试配置创建 Flask app | TODO |
## Phase 1 · CHIS 登录与会话 ## Phase 1 · CHIS 登录与会话
+13 -4
View File
@@ -7,8 +7,8 @@
- 日期:2026-07-04 - 日期:2026-07-04
- 阶段:MVP 起步 / Flask 地基已初始化 - 阶段:MVP 起步 / Flask 地基已初始化
- 技术栈:当前系统 Python 3.8、Flask 3.0.3 application factory;不创建虚拟环境 - 技术栈:当前系统 Python 3.8、Flask 3.0.3 application factory;不创建虚拟环境
- 生产代码:`app/__init__.py`、`app/api/health.py`、`app/config.py`、`run.py` - 生产代码:`app/__init__.py`、`app/api/health.py`、`app/config.py`、`run.py`,以及 `app/middleware/`、`app/services/`、`app/mappers/`、`app/chis/`、`app/repositories/`、`app/validators/` 包目录
- 测试:`tests/test_app_factory.py` - 测试:`tests/test_app_factory.py`、`tests/test_config_and_structure.py`
- 数据 / 资料:`reverse_file/` 下已有 CHIS HAR、前端脚本和 schema;`D:\hans\chupd\chis\login_client_v2.py` 可作为登录链路参考 - 数据 / 资料:`reverse_file/` 下已有 CHIS HAR、前端脚本和 schema;`D:\hans\chupd\chis\login_client_v2.py` 可作为登录链路参考
- 标准启动路径:`python run.py` - 标准启动路径:`python run.py`
- 标准验证路径:`python -m unittest discover -s tests` - 标准验证路径:`python -m unittest discover -s tests`
@@ -23,22 +23,31 @@
| `reverse_file/20260704_query_health_check.har` | 已有 | 体检详情只读查询 HAR,包含 `getHMNIListOfHTML` 和 `getCheckInfoDetail` | | `reverse_file/20260704_query_health_check.har` | 已有 | 体检详情只读查询 HAR,包含 `getHMNIListOfHTML` 和 `getCheckInfoDetail` |
| `D:\hans\chupd\chis\login_client_v2.py` | 外部参考 | CHIS 登录、SM2 加密、角色选择、cookie 拼接、`getLanderInfo` 会话验证 | | `D:\hans\chupd\chis\login_client_v2.py` | 外部参考 | CHIS 登录、SM2 加密、角色选择、cookie 拼接、`getLanderInfo` 会话验证 |
| `app/` | 已有 | Flask application factory 和 health check API | | `app/` | 已有 | Flask application factory 和 health check API |
| `app/chis/` | 已有 | CHIS integration layer 包目录 |
| `app/mappers/` | 已有 | 数据转换层包目录 |
| `app/middleware/` | 已有 | 中间件包目录 |
| `app/repositories/` | 已有 | 存储 / 缓存包目录 |
| `app/services/` | 已有 | 应用服务层包目录 |
| `app/validators/` | 已有 | 请求校验包目录 |
| `tests/` | 已有 | `unittest` 测试 | | `tests/` | 已有 | `unittest` 测试 |
| `requirements.txt` | 已有 | Python 依赖,固定 `Flask==3.0.3` | | `requirements.txt` | 已有 | Python 依赖,固定 `Flask==3.0.3` |
| `.env.example` | 已有 | 环境变量占位示例,不含真实密钥 |
## 任务看板状态 ## 任务看板状态
任务状态以 [06-tasks.md](06-tasks.md) 为准。 任务状态以 [06-tasks.md](06-tasks.md) 为准。
- 已完成:DOC-001 建立 harness coding 项目文档;DOC-002 更新 CHIS 登录与只读查询验证路线;DOC-003 明确使用系统 Python 3.8;DOC-004 明确 Flask factory 模式;DOC-005 明确日志与请求归档方案;T-001 初始化 Flask 项目骨架。详见 [../progress.md](../progress.md)。 - 已完成:DOC-001 建立 harness coding 项目文档;DOC-002 更新 CHIS 登录与只读查询验证路线;DOC-003 明确使用系统 Python 3.8;DOC-004 明确 Flask factory 模式;DOC-005 明确日志与请求归档方案;T-001 初始化 Flask 项目骨架;T-002 建立基础配置与目录。详见 [../progress.md](../progress.md)。
- 正在进行:无。 - 正在进行:无。
- 下一个可领取任务:T-002 建立基础配置与目录。 - 下一个可领取任务:T-003 建立最小测试框架。
## 已确认技术事实 ## 已确认技术事实
- CHIS public key 可通过配置文件或环境变量提供。 - CHIS public key 可通过配置文件或环境变量提供。
- 使用当前系统 Python 3.8 环境,不创建虚拟环境;T-001 创建 `requirements.txt` 固定依赖。 - 使用当前系统 Python 3.8 环境,不创建虚拟环境;T-001 创建 `requirements.txt` 固定依赖。
- Flask 应用使用 application factory 模式,`app/__init__.py` 暴露 `create_app(config_object=None)`。 - Flask 应用使用 application factory 模式,`app/__init__.py` 暴露 `create_app(config_object=None)`。
- 基础配置通过环境变量读取:`CHIS_BASE_URL`、`CHIS_PUBLIC_KEY`、`REDIS_URL`、`LOG_DIR`、`ARCHIVE_DIR`。
- `.env.example` 只保留占位符和非敏感默认值,不写真实密钥。
- 登录链路参考 `login_client_v2.py`:`myRoles` -> 选择 `责任医生助理` / `责任医生` -> `myApps` -> 拼接 cookie。 - 登录链路参考 `login_client_v2.py`:`myRoles` -> 选择 `责任医生助理` / `责任医生` -> `myApps` -> 拼接 cookie。
- SM2 加密参考 `hans_chis.sm2.sm2_encrypt`:`gmssl.sm2.CryptSM2(mode=0)`,返回带 `04` 前缀密文。 - SM2 加密参考 `hans_chis.sm2.sm2_encrypt`:`gmssl.sm2.CryptSM2(mode=0)`,返回带 `04` 前缀密文。
- 会话验证可用 `chis.myPageService / getLanderInfo`。 - 会话验证可用 `chis.myPageService / getLanderInfo`。
+9
View File
@@ -79,3 +79,12 @@
- 阻塞:无。 - 阻塞:无。
- 决策:T-001 采用标准库 `unittest` 做最小 factory / health check 验证;后续 T-003 再建立 pytest 测试框架。 - 决策:T-001 采用标准库 `unittest` 做最小 factory / health check 验证;后续 T-003 再建立 pytest 测试框架。
- 下一步:T-002 建立基础配置与目录。 - 下一步:T-002 建立基础配置与目录。
## 2026-07-04 T-002 建立基础配置与目录
- 状态:DONE
- 变更:新增 `app/middleware/`、`app/services/`、`app/mappers/`、`app/chis/`、`app/repositories/`、`app/validators/` 包目录;新增 `.env.example`;更新 `app/config.py` 从环境变量读取基础配置;更新 `create_app` 加载基础配置;新增 `tests/test_config_and_structure.py`;更新任务和当前状态文档。
- 验证:先执行 `python -m unittest discover -s tests` 看到 `CHIS_BASE_URL` 缺失和架构包不可导入;实现后执行 `python -m unittest discover -s tests` 结果 `Ran 3 tests ... OK`;临时启动 `python run.py` 后请求 `/health` 返回 `{"ok":true}`;执行 `git diff --check` 未发现空白错误;检查 `.env.example` 仅包含占位符和非敏感默认值。
- 阻塞:无。
- 决策:T-002 只建立基础配置和包目录,不引入真实密钥、不连接 Redis、不实现 CHIS 业务逻辑。
- 下一步:T-003 建立最小测试框架。
+1 -1
View File
@@ -11,7 +11,7 @@ MVP 起步。当前仓库已具备逆向资料和项目文档,尚未初始化
| ID | 任务 | 状态 | | ID | 任务 | 状态 |
| --- | --- | --- | | --- | --- | --- |
| T-001 | 初始化 Flask 项目骨架 | DONE | | T-001 | 初始化 Flask 项目骨架 | DONE |
| T-002 | 建立基础配置与目录 | TODO | | T-002 | 建立基础配置与目录 | DONE |
| T-003 | 建立最小测试框架 | TODO | | T-003 | 建立最小测试框架 | TODO |
| T-101 | 迁移 CHIS 登录链路 | TODO | | T-101 | 迁移 CHIS 登录链路 | TODO |
| T-102 | 接入账号信息查询验证会话 | TODO | | T-102 | 接入账号信息查询验证会话 | TODO |
+43
View File
@@ -0,0 +1,43 @@
import importlib
import unittest
from unittest.mock import patch
from app import create_app
class ConfigAndStructureTest(unittest.TestCase):
def test_create_app_loads_environment_config(self):
env = {
"CHIS_BASE_URL": "http://chis.example.test/chis",
"CHIS_PUBLIC_KEY": "PUBLIC_KEY_PLACEHOLDER",
"REDIS_URL": "redis://localhost:6379/0",
"LOG_DIR": "logs",
"ARCHIVE_DIR": "archives",
}
with patch.dict("os.environ", env, clear=False):
app = create_app({"TESTING": True})
self.assertEqual(app.config["CHIS_BASE_URL"], env["CHIS_BASE_URL"])
self.assertEqual(app.config["CHIS_PUBLIC_KEY"], env["CHIS_PUBLIC_KEY"])
self.assertEqual(app.config["REDIS_URL"], env["REDIS_URL"])
self.assertEqual(app.config["LOG_DIR"], env["LOG_DIR"])
self.assertEqual(app.config["ARCHIVE_DIR"], env["ARCHIVE_DIR"])
def test_architecture_packages_are_importable(self):
package_names = [
"app.middleware",
"app.services",
"app.mappers",
"app.chis",
"app.repositories",
"app.validators",
]
for package_name in package_names:
with self.subTest(package_name=package_name):
self.assertIsNotNone(importlib.import_module(package_name))
if __name__ == "__main__":
unittest.main()