dwyeapi 0.5.1__tar.gz → 0.5.2__tar.gz

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dwyeapi
-Version: 0.5.1
+Version: 0.5.2
 Summary: Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger
 License: MIT
 Requires-Python: >=3.11

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/README.md

@@ -23,14 +23,18 @@ pip install dwyeapi
 
 ## Environment (dev / prod)
 
-`BaseSettings` 暴露顶层 `environment` 字段,可选值 `"dev" | "prod"`,**默认 `"prod"`**(保守派,误配置时也按 prod 行为)。
+`BaseSettings` 暴露顶层 `environment` 字段,可选值 `"dev" | "prod"`,**默认 `"prod"`**(保守派,误配置时也按 prod 行为)。eapi **不再提供 `debug` 字段** —— 所有"调试开关"统一判断 `is_dev()`,避免两个维度互相冲突。
 
 ```bash
 # .env
 ENVIRONMENT=dev          # 开发环境;留空或 prod 即生产
 ```
 
-业务代码通过 `dwyeapi.is_dev()` / `dwyeapi.is_prod()` / `dwyeapi.get_environment()` 读当前环境,典型用法:
+业务代码通过 `dwyeapi.is_dev()` / `dwyeapi.is_prod()` / `dwyeapi.get_environment()` 读当前环境。
+
+### FastAPI docs/redoc/openapi 仅 dev 暴露
+
+非 dev 环境必须关闭 Swagger/ReDoc/OpenAPI schema 三个端点,避免线上暴露路由和字段元信息:
 
 ```python
 from dwyeapi import is_dev
@@ -45,6 +49,9 @@ app = FastAPI(
     redoc_url="/redoc" if is_dev() else None,
     openapi_url="/openapi.json" if is_dev() else None,
 )
+
+# SQL echo、慢路由 profiling、中间件堆栈打印等调试性质开关也统一用 is_dev() 守护
+engine = create_async_engine_factory(settings.database_url, echo=is_dev())
 ```
 
 ### Mock provider 仅 dev 可用

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dwyeapi"
-version = "0.5.1"
+version = "0.5.2"
 description = "Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger"
 requires-python = ">=3.11"
 license = {text = "MIT"}

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/src/dwyeapi/__init__.py

@@ -18,4 +18,4 @@ from . import logger
 from .config import BaseSettings, get_environment, is_dev, is_prod
 
 __all__ = ["BaseSettings", "get_environment", "is_dev", "is_prod", "logger"]
-__version__ = "0.5.1"
+__version__ = "0.5.2"

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/src/dwyeapi/config.py

@@ -53,7 +53,6 @@ class BaseSettings(PydanticBaseSettings):
     jwt_algorithm: str = "HS256"
     access_token_expire_minutes: int = 30
     environment: Environment = "prod"
-    debug: bool = False
     allowed_origins: list[str] = Field(default_factory=list)
 
     # Task module settings (task_ prefix)

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/src/dwyeapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dwyeapi
-Version: 0.5.1
+Version: 0.5.2
 Summary: Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger
 License: MIT
 Requires-Python: >=3.11

{dwyeapi-0.5.1 → dwyeapi-0.5.2}/tests/test_config.py

@@ -29,12 +29,13 @@ class TestBaseSettings:
         assert s.redis_url == "redis://localhost:6379/0"
         assert s.secret_key == "test-secret"
 
-    def test_debug_defaults_false(self, monkeypatch):
+    def test_debug_field_removed(self, monkeypatch):
+        """debug 字段已废弃,请用 environment + is_dev()/is_prod() 代替。"""
         monkeypatch.setenv("DATABASE_URL", "postgresql+asyncpg://u:p@localhost/db")
         monkeypatch.setenv("REDIS_URL", "redis://localhost:6379/0")
         monkeypatch.setenv("SECRET_KEY", "s")
         s = BaseSettings()
-        assert s.debug is False
+        assert not hasattr(s, "debug")
 
     def test_allowed_origins_defaults_empty(self, monkeypatch):
         monkeypatch.setenv("DATABASE_URL", "postgresql+asyncpg://u:p@localhost/db")