dwyeapi 0.8.2__tar.gz → 0.9.0__tar.gz

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dwyeapi
-Version: 0.8.2
+Version: 0.9.0
 Summary: Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger
 License: MIT
 Requires-Python: >=3.11
@@ -16,15 +16,8 @@ Provides-Extra: tasks
 Requires-Dist: arq>=0.26.0; extra == "tasks"
 Provides-Extra: email-resend
 Requires-Dist: resend[async]>=2.29.0; extra == "email-resend"
-Provides-Extra: email-aliyun
-Requires-Dist: alibabacloud_dm20151123>=1.0.0; extra == "email-aliyun"
-Provides-Extra: sms-aliyun
-Requires-Dist: alibabacloud_dysmsapi20170525>=2.0.0; extra == "sms-aliyun"
 Provides-Extra: email
 Requires-Dist: resend[async]>=2.29.0; extra == "email"
-Requires-Dist: alibabacloud_dm20151123>=1.0.0; extra == "email"
-Provides-Extra: sms
-Requires-Dist: alibabacloud_dysmsapi20170525>=2.0.0; extra == "sms"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/README.md

@@ -19,7 +19,7 @@ pip install dwyeapi
 - `response` — Unified API response helpers
 - `pagination` — PaginationParams + paginate helper
 - `logger` — Facade logger (loguru-backed) with daily + size rotation and stdlib interception; downstream code depends on `dwyeapi.logger.Logger`, not loguru directly
-- `providers.email` / `providers.sms` — pluggable 验证码 Provider 工厂 (mock / resend / aliyun)
+- `providers.email` — 邮件验证码 Provider 工厂(内置 resend;支持业务通过 `register_email_provider` 注入自定义实现)
 
 ## Environment (dev / prod)
 
@@ -54,6 +54,3 @@ app = FastAPI(
 engine = create_async_engine_factory(settings.database_url, echo=is_dev())
 ```
 
-### Mock provider 仅 dev 可用
-
-`providers.email` / `providers.sms` 的 `provider="mock"` 只在 `ENVIRONMENT=dev` 下可用。prod 环境下调用 `make_email_provider()` / `make_sms_provider()` 会抛 `ValueError`,保证正式环境一旦误配置 `EMAIL__PROVIDER=mock` 会启动失败(fail fast),而不会静默吞掉真实验证码。

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dwyeapi"
-version = "0.8.2"
+version = "0.9.0"
 description = "Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger"
 requires-python = ">=3.11"
 license = {text = "MIT"}
@@ -23,14 +23,9 @@ tasks = [
 # Email Provider 实现 — 按需安装
 # resend[async] 会拉入 httpx 以启用 Emails.send_async 原生异步 API
 email-resend = ["resend[async]>=2.29.0"]
-email-aliyun = ["alibabacloud_dm20151123>=1.0.0"]
-
-# SMS Provider 实现 — 按需安装
-sms-aliyun = ["alibabacloud_dysmsapi20170525>=2.0.0"]
 
 # 聚合 extras(按模块)
-email = ["resend[async]>=2.29.0", "alibabacloud_dm20151123>=1.0.0"]
-sms = ["alibabacloud_dysmsapi20170525>=2.0.0"]
+email = ["resend[async]>=2.29.0"]
 
 dev = [
     "pytest>=8.0.0",

dwyeapi-0.9.0/src/dwyeapi/providers/email/__init__.py

@@ -0,0 +1,62 @@
+"""Email Provider 模块 -- 提供可插拔的邮件验证码发送能力。
+
+模块由 Protocol 抽象 + 抽象基类 + 配置类 + 工厂函数 + 内置 resend 实现组成。
+内置仅 resend 一种 provider;业务项目可通过 `register_email_provider` 注入自定义 provider
+(继承 `EmailProviderBase` 实现 `_send`,即可复用 Redis 验证码 + 品牌化模板)。
+
+典型用法 -- 内置 resend:
+    from dwyeapi.providers.email import EmailSettings, make_email_provider
+
+    class Settings(DwyBaseSettings):
+        email: EmailSettings = EmailSettings()
+
+    settings = Settings()
+    provider = make_email_provider(settings.email)
+    await provider.send_code("user@example.com")
+
+典型用法 -- 注册自定义 provider:
+    from dwyeapi.providers.email import (
+        EmailProvider,
+        EmailProviderBase,
+        EmailSettings,
+        register_email_provider,
+    )
+
+    class TencentSesProvider(EmailProviderBase):
+        async def _send(self, target: str, code: str) -> bool:
+            html = self._render_code_html(code)
+            text = self._render_code_text(code)
+            # 调腾讯云 SES API 发送 ...
+            return True
+
+    def _build(s: EmailSettings) -> EmailProvider:
+        from app.config import settings as app_settings
+        return TencentSesProvider(
+            secret_id=app_settings.tencent.secret_id,
+            code_ttl=s.code_ttl,
+            brand_name=s.brand_name,
+            ...,
+        )
+
+    register_email_provider("tencent_ses", _build)
+    # .env: EMAIL__PROVIDER=tencent_ses
+"""
+
+from dwyeapi.providers.email.base import EmailProviderBase
+from dwyeapi.providers.email.config import EmailSettings, ResendConfig
+from dwyeapi.providers.email.factory import (
+    EmailProviderFactory,
+    make_email_provider,
+    register_email_provider,
+)
+from dwyeapi.providers.email.protocol import EmailProvider
+
+__all__ = [
+    "EmailProvider",
+    "EmailProviderBase",
+    "EmailProviderFactory",
+    "EmailSettings",
+    "ResendConfig",
+    "make_email_provider",
+    "register_email_provider",
+]

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/src/dwyeapi/providers/email/config.py

@@ -1,7 +1,5 @@
 """Email Provider 配置模型。"""
 
-from typing import Literal
-
 from pydantic import BaseModel, Field
 
 
@@ -26,35 +24,6 @@ class ResendConfig(BaseModel):
     )
 
 
-class AliyunEmailConfig(BaseModel):
-    """阿里云邮件推送 Provider 配置。
-
-    EMAIL__PROVIDER=aliyun 时生效;空串默认仅为 pydantic 嵌套实例化需要,
-    真正启用时凭证 + account_name 必须通过 .env 显式提供。
-    """
-
-    access_key_id: str = Field(
-        default="",
-        description="[必填: aliyun] 阿里云 AccessKey ID",
-    )
-    access_key_secret: str = Field(
-        default="",
-        description="[必填: aliyun] 阿里云 AccessKey Secret",
-    )
-    account_name: str = Field(
-        default="",
-        description="[必填: aliyun] 发信地址,需在阿里云邮件推送控制台预先配置",
-    )
-    from_alias: str = Field(
-        default="",
-        description="发件人显示名,留空则展示 account_name",
-    )
-    subject: str = Field(
-        default="验证码",
-        description="验证码邮件主题",
-    )
-
-
 class EmailSettings(BaseModel):
     """Email 模块配置 -- 业务项目嵌入 Settings 的入口。
 
@@ -70,9 +39,12 @@ class EmailSettings(BaseModel):
         EMAIL__RESEND__API_KEY=re_xxx
     """
 
-    provider: Literal["mock", "resend", "aliyun"] = Field(
-        default="mock",
-        description='Email Provider 选择:"mock"(dev 限定,打印到日志)/ "resend" / "aliyun"',
+    provider: str = Field(
+        default="resend",
+        description=(
+            "Email Provider 名称。内置仅支持 'resend';"
+            "业务可通过 register_email_provider(name, factory) 注册自定义 provider 后填入对应名称"
+        ),
     )
     code_ttl: int = Field(
         default=300,
@@ -106,7 +78,3 @@ class EmailSettings(BaseModel):
         default_factory=ResendConfig,
         description="Resend 配置,provider=resend 时必填",
     )
-    aliyun: AliyunEmailConfig = Field(
-        default_factory=AliyunEmailConfig,
-        description="阿里云邮件推送配置,provider=aliyun 时必填",
-    )

dwyeapi-0.9.0/src/dwyeapi/providers/email/factory.py

@@ -0,0 +1,80 @@
+"""Email Provider 工厂 -- 内置 resend,支持外部注册自定义 provider。"""
+
+from collections.abc import Callable
+
+from dwyeapi.logger import get_logger
+from dwyeapi.providers.email.config import EmailSettings
+from dwyeapi.providers.email.protocol import EmailProvider
+
+logger = get_logger(__name__)
+
+EmailProviderFactory = Callable[[EmailSettings], EmailProvider]
+
+_BUILTIN_RESEND = "resend"
+_PROVIDER_REGISTRY: dict[str, EmailProviderFactory] = {}
+
+
+def register_email_provider(name: str, factory: EmailProviderFactory) -> None:
+    """注册自定义 Email Provider。
+
+    业务项目继承 `EmailProviderBase` 实现 `_send` 后,通过此函数注册到工厂,
+    `.env` 设 `EMAIL__PROVIDER=<name>` 即可启用。
+
+    Args:
+        name: provider 名称,与 EMAIL__PROVIDER 环境变量值对应。
+        factory: 工厂函数,接收 EmailSettings 返回 EmailProvider 实例。
+
+    Raises:
+        ValueError: 名称为空或与内置名称冲突。
+    """
+    if not name:
+        raise ValueError("provider 名称不能为空")
+    if name == _BUILTIN_RESEND:
+        raise ValueError(f"'{name}' 为内置 provider 名称,不可覆盖")
+    if name in _PROVIDER_REGISTRY:
+        logger.warning("Email provider %s 被覆盖注册", name)
+    _PROVIDER_REGISTRY[name] = factory
+
+
+def make_email_provider(settings: EmailSettings) -> EmailProvider:
+    """根据 `settings.provider` 构造对应的 Email Provider 实例。
+
+    Args:
+        settings: Email 模块配置(项目 Settings 的嵌套字段)。
+
+    Returns:
+        实现了 `EmailProvider` Protocol 的实例。
+
+    Raises:
+        ValueError: 未知 provider 或必填配置缺失。
+        ImportError: resend extra 未安装。
+    """
+    common = {
+        "code_ttl": settings.code_ttl,
+        "code_length": settings.code_length,
+        "brand_name": settings.brand_name,
+        "brand_tagline": settings.brand_tagline,
+        "brand_url": settings.brand_url,
+        "brand_slogan": settings.brand_slogan,
+        "support_email": settings.support_email,
+    }
+
+    if settings.provider == _BUILTIN_RESEND:
+        from dwyeapi.providers.email.resend import ResendEmailProvider
+
+        if not settings.resend.api_key:
+            raise ValueError("EMAIL__RESEND__API_KEY 未配置")
+        return ResendEmailProvider(
+            api_key=settings.resend.api_key,
+            from_email=settings.resend.from_email,
+            subject=settings.resend.subject,
+            **common,
+        )
+
+    if settings.provider in _PROVIDER_REGISTRY:
+        return _PROVIDER_REGISTRY[settings.provider](settings)
+
+    raise ValueError(
+        f"未知 email provider: {settings.provider};"
+        f"内置仅支持 'resend',自定义 provider 需先调用 register_email_provider 注册"
+    )

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/src/dwyeapi/providers/email/protocol.py

@@ -6,7 +6,7 @@ from typing import Protocol
 class EmailProvider(Protocol):
     """邮箱验证码服务抽象接口。
 
-    实现类:MockEmailProvider(开发)、ResendEmailProvider(生产)、AliyunEmailProvider(生产备选)。
+    内置实现:ResendEmailProvider;业务可通过 `register_email_provider` 注入自定义实现。
     通过 `dwyeapi.providers.email.make_email_provider(settings.email)` 工厂根据配置选择实现。
     """
 

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/src/dwyeapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dwyeapi
-Version: 0.8.2
+Version: 0.9.0
 Summary: Lightweight FastAPI infrastructure — exceptions, database, config, security, cache, pagination, logger
 License: MIT
 Requires-Python: >=3.11
@@ -16,15 +16,8 @@ Provides-Extra: tasks
 Requires-Dist: arq>=0.26.0; extra == "tasks"
 Provides-Extra: email-resend
 Requires-Dist: resend[async]>=2.29.0; extra == "email-resend"
-Provides-Extra: email-aliyun
-Requires-Dist: alibabacloud_dm20151123>=1.0.0; extra == "email-aliyun"
-Provides-Extra: sms-aliyun
-Requires-Dist: alibabacloud_dysmsapi20170525>=2.0.0; extra == "sms-aliyun"
 Provides-Extra: email
 Requires-Dist: resend[async]>=2.29.0; extra == "email"
-Requires-Dist: alibabacloud_dm20151123>=1.0.0; extra == "email"
-Provides-Extra: sms
-Requires-Dist: alibabacloud_dysmsapi20170525>=2.0.0; extra == "sms"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/src/dwyeapi.egg-info/SOURCES.txt

@@ -20,20 +20,11 @@ src/dwyeapi.egg-info/requires.txt
 src/dwyeapi.egg-info/top_level.txt
 src/dwyeapi/providers/__init__.py
 src/dwyeapi/providers/email/__init__.py
-src/dwyeapi/providers/email/aliyun.py
 src/dwyeapi/providers/email/base.py
 src/dwyeapi/providers/email/config.py
 src/dwyeapi/providers/email/factory.py
-src/dwyeapi/providers/email/mock.py
 src/dwyeapi/providers/email/protocol.py
 src/dwyeapi/providers/email/resend.py
-src/dwyeapi/providers/sms/__init__.py
-src/dwyeapi/providers/sms/aliyun.py
-src/dwyeapi/providers/sms/base.py
-src/dwyeapi/providers/sms/config.py
-src/dwyeapi/providers/sms/factory.py
-src/dwyeapi/providers/sms/mock.py
-src/dwyeapi/providers/sms/protocol.py
 src/dwyeapi/tasks/__init__.py
 src/dwyeapi/tasks/context.py
 src/dwyeapi/tasks/model.py

{dwyeapi-0.8.2 → dwyeapi-0.9.0}/src/dwyeapi.egg-info/requires.txt

@@ -18,19 +18,9 @@ fakeredis>=2.0.0
 
 [email]
 resend[async]>=2.29.0
-alibabacloud_dm20151123>=1.0.0
-
-[email-aliyun]
-alibabacloud_dm20151123>=1.0.0
 
 [email-resend]
 resend[async]>=2.29.0
 
-[sms]
-alibabacloud_dysmsapi20170525>=2.0.0
-
-[sms-aliyun]
-alibabacloud_dysmsapi20170525>=2.0.0
-
 [tasks]
 arq>=0.26.0

dwyeapi-0.8.2/src/dwyeapi/providers/email/__init__.py

@@ -1,29 +0,0 @@
-"""Email Provider 模块 -- 提供可插拔的邮件验证码发送能力。
-
-提供 Protocol 抽象 + 配置类 + 工厂函数 + 多种实现(mock/resend/aliyun)。
-业务项目通过 `pip install dwyeapi[email-resend]` 等 extras 按需安装 provider 依赖。
-
-典型用法:
-    from dwyeapi.providers.email import EmailSettings, make_email_provider
-
-    class Settings(DwyBaseSettings):
-        email: EmailSettings = EmailSettings()
-
-    settings = Settings()
-    provider = make_email_provider(settings.email)
-    await provider.send_code("user@example.com")
-"""
-
-from dwyeapi.providers.email.base import EmailProviderBase
-from dwyeapi.providers.email.config import AliyunEmailConfig, EmailSettings, ResendConfig
-from dwyeapi.providers.email.factory import make_email_provider
-from dwyeapi.providers.email.protocol import EmailProvider
-
-__all__ = [
-    "AliyunEmailConfig",
-    "EmailProvider",
-    "EmailProviderBase",
-    "EmailSettings",
-    "ResendConfig",
-    "make_email_provider",
-]

dwyeapi-0.8.2/src/dwyeapi/providers/email/aliyun.py

@@ -1,61 +0,0 @@
-"""阿里云邮件推送 Email Provider -- 占位实现。
-
-需要 `pip install dwyeapi[email-aliyun]` 才能使用。实际调用待首次接入项目时补全。
-"""
-
-import redis.asyncio as aioredis
-
-from dwyeapi.providers.email.base import DEFAULT_CODE_LENGTH, DEFAULT_CODE_TTL, EmailProviderBase
-
-
-class AliyunEmailProvider(EmailProviderBase):
-    """基于阿里云邮件推送的 Email Provider(占位)。
-
-    首次接入项目时基于 `alibabacloud_dm20151123` SDK 实现 `_send()`,
-    调用时使用 `self._render_code_html(code)` / `self._render_code_text(code)` 复用品牌模板。
-    """
-
-    def __init__(
-        self,
-        access_key_id: str,
-        access_key_secret: str,
-        account_name: str,
-        from_alias: str = "",
-        subject: str = "验证码",
-        code_ttl: int = DEFAULT_CODE_TTL,
-        code_length: int = DEFAULT_CODE_LENGTH,
-        brand_name: str = "",
-        brand_tagline: str = "",
-        brand_url: str = "",
-        brand_slogan: str = "",
-        support_email: str = "",
-        redis: aioredis.Redis | None = None,
-    ) -> None:
-        """初始化。
-
-        Raises:
-            ImportError: 未安装 alibabacloud_dm20151123 时抛出。
-        """
-        super().__init__(
-            code_ttl=code_ttl,
-            code_length=code_length,
-            brand_name=brand_name,
-            brand_tagline=brand_tagline,
-            brand_url=brand_url,
-            brand_slogan=brand_slogan,
-            support_email=support_email,
-            redis=redis,
-        )
-        try:
-            import alibabacloud_dm20151123  # noqa: F401
-        except ImportError as e:
-            raise ImportError("使用 AliyunEmailProvider 需要安装: pip install dwyeapi[email-aliyun]") from e
-        self._access_key_id = access_key_id
-        self._access_key_secret = access_key_secret
-        self._account_name = account_name
-        self._from_alias = from_alias or brand_name
-        self._subject = subject
-
-    async def _send(self, target: str, code: str) -> bool:
-        """调用阿里云 DirectMail API 发送邮件。"""
-        raise NotImplementedError("AliyunEmailProvider 暂未实现,首次接入项目时补全 _send")

dwyeapi-0.8.2/src/dwyeapi/providers/email/factory.py

@@ -1,69 +0,0 @@
-"""Email Provider 工厂 -- 根据配置选择实现。"""
-
-from dwyeapi.config import is_prod
-from dwyeapi.providers.email.config import EmailSettings
-from dwyeapi.providers.email.protocol import EmailProvider
-
-
-def make_email_provider(settings: EmailSettings) -> EmailProvider:
-    """根据 `settings.provider` 构造对应的 Email Provider 实例。
-
-    Args:
-        settings: Email 模块配置(项目 Settings 的嵌套字段)。
-
-    Returns:
-        实现了 `EmailProvider` Protocol 的实例。
-
-    Raises:
-        ValueError: 未知 provider、必填配置缺失,或 prod 环境下选择 mock provider。
-        ImportError: provider 对应的 extra 未安装。
-    """
-    common = {
-        "code_ttl": settings.code_ttl,
-        "code_length": settings.code_length,
-        "brand_name": settings.brand_name,
-        "brand_tagline": settings.brand_tagline,
-        "brand_url": settings.brand_url,
-        "brand_slogan": settings.brand_slogan,
-        "support_email": settings.support_email,
-    }
-
-    match settings.provider:
-        case "mock":
-            if is_prod():
-                raise ValueError(
-                    "EMAIL__PROVIDER=mock 在 prod 环境下被禁止;"
-                    "请设置 ENVIRONMENT=dev 或改用真实 provider(resend/aliyun)"
-                )
-            from dwyeapi.providers.email.mock import MockEmailProvider
-
-            return MockEmailProvider(**common)
-
-        case "resend":
-            from dwyeapi.providers.email.resend import ResendEmailProvider
-
-            if not settings.resend.api_key:
-                raise ValueError("EMAIL__RESEND__API_KEY 未配置")
-            return ResendEmailProvider(
-                api_key=settings.resend.api_key,
-                from_email=settings.resend.from_email,
-                subject=settings.resend.subject,
-                **common,
-            )
-
-        case "aliyun":
-            from dwyeapi.providers.email.aliyun import AliyunEmailProvider
-
-            if not settings.aliyun.access_key_id or not settings.aliyun.access_key_secret:
-                raise ValueError("EMAIL__ALIYUN__ACCESS_KEY_ID/SECRET 未配置")
-            return AliyunEmailProvider(
-                access_key_id=settings.aliyun.access_key_id,
-                access_key_secret=settings.aliyun.access_key_secret,
-                account_name=settings.aliyun.account_name,
-                from_alias=settings.aliyun.from_alias,
-                subject=settings.aliyun.subject,
-                **common,
-            )
-
-        case _:
-            raise ValueError(f"未知 email provider: {settings.provider}")

dwyeapi-0.8.2/src/dwyeapi/providers/email/mock.py

@@ -1,15 +0,0 @@
-"""Mock Email Provider -- 开发/测试环境使用,日志打印验证码不真实发送。"""
-
-from dwyeapi.logger import get_logger
-from dwyeapi.providers.email.base import EmailProviderBase
-
-logger = get_logger(__name__)
-
-
-class MockEmailProvider(EmailProviderBase):
-    """Mock 邮箱验证码 Provider。"""
-
-    async def _send(self, target: str, code: str) -> bool:
-        """打印验证码到日志,始终返回 True。"""
-        logger.info("Mock Email sent: target=%s code=%s", target, code)
-        return True

dwyeapi-0.8.2/src/dwyeapi/providers/sms/__init__.py

@@ -1,28 +0,0 @@
-"""SMS Provider 模块 -- 提供可插拔的短信验证码发送能力。
-
-提供 Protocol 抽象 + 配置类 + 工厂函数 + 多种实现(mock/aliyun)。
-业务项目通过 `pip install dwyeapi[sms-aliyun]` 等 extras 按需安装 provider 依赖。
-
-典型用法:
-    from dwyeapi.providers.sms import SmsSettings, make_sms_provider
-
-    class Settings(DwyBaseSettings):
-        sms: SmsSettings = SmsSettings()
-
-    settings = Settings()
-    provider = make_sms_provider(settings.sms)
-    await provider.send_code("13800138000")
-"""
-
-from dwyeapi.providers.sms.base import SmsProviderBase
-from dwyeapi.providers.sms.config import AliyunSmsConfig, SmsSettings
-from dwyeapi.providers.sms.factory import make_sms_provider
-from dwyeapi.providers.sms.protocol import SmsProvider
-
-__all__ = [
-    "AliyunSmsConfig",
-    "SmsProvider",
-    "SmsProviderBase",
-    "SmsSettings",
-    "make_sms_provider",
-]

dwyeapi-0.8.2/src/dwyeapi/providers/sms/aliyun.py

@@ -1,46 +0,0 @@
-"""阿里云短信 Provider -- 占位实现。
-
-需要 `pip install dwyeapi[sms-aliyun]` 才能使用。实际调用待首次接入项目时补全。
-"""
-
-import redis.asyncio as aioredis
-
-from dwyeapi.providers.sms.base import DEFAULT_CODE_LENGTH, DEFAULT_CODE_TTL, SmsProviderBase
-
-
-class AliyunSmsProvider(SmsProviderBase):
-    """基于阿里云 dysmsapi 的 SMS Provider(占位)。
-
-    首次接入项目时基于 `alibabacloud_dysmsapi20170525` SDK 实现 `_send()`。
-    """
-
-    def __init__(
-        self,
-        access_key_id: str,
-        access_key_secret: str,
-        sign_name: str,
-        template_code: str,
-        region_id: str = "cn-hangzhou",
-        code_ttl: int = DEFAULT_CODE_TTL,
-        code_length: int = DEFAULT_CODE_LENGTH,
-        redis: aioredis.Redis | None = None,
-    ) -> None:
-        """初始化。
-
-        Raises:
-            ImportError: 未安装 alibabacloud_dysmsapi20170525 时抛出。
-        """
-        super().__init__(code_ttl=code_ttl, code_length=code_length, redis=redis)
-        try:
-            import alibabacloud_dysmsapi20170525  # noqa: F401
-        except ImportError as e:
-            raise ImportError("使用 AliyunSmsProvider 需要安装: pip install dwyeapi[sms-aliyun]") from e
-        self._access_key_id = access_key_id
-        self._access_key_secret = access_key_secret
-        self._sign_name = sign_name
-        self._template_code = template_code
-        self._region_id = region_id
-
-    async def _send(self, target: str, code: str) -> bool:
-        """调用阿里云短信 API 发送验证码。"""
-        raise NotImplementedError("AliyunSmsProvider 暂未实现,首次接入项目时补全 _send")

dwyeapi-0.8.2/src/dwyeapi/providers/sms/base.py

@@ -1,71 +0,0 @@
-"""SMS Provider 基类 -- 封装 Redis 验证码存取逻辑。"""
-
-import secrets
-from abc import ABC, abstractmethod
-
-import redis.asyncio as aioredis
-
-from dwyeapi.cache import get_redis
-
-CODE_KEY_PREFIX = "dwyeapi:sms:code:"
-DEFAULT_CODE_TTL = 300
-DEFAULT_CODE_LENGTH = 6
-
-
-class SmsProviderBase(ABC):
-    """SMS Provider 抽象基类。
-
-    共享验证码生成 + Redis 存取 + 一次性校验逻辑;子类只实现 `_send()` 发送动作。
-    """
-
-    def __init__(
-        self,
-        code_ttl: int = DEFAULT_CODE_TTL,
-        code_length: int = DEFAULT_CODE_LENGTH,
-        redis: aioredis.Redis | None = None,
-    ) -> None:
-        """初始化。
-
-        Args:
-            code_ttl: 验证码有效期(秒),默认 300。
-            code_length: 验证码位数,默认 6。
-            redis: 可选显式注入的 Redis 连接;为 None 时 fallback 到 dwyeapi.cache.get_redis()。
-        """
-        self._ttl = code_ttl
-        self._length = code_length
-        self._redis = redis
-
-    async def _get_redis(self) -> aioredis.Redis:
-        """获取 Redis 连接,优先使用注入的,否则取全局单例。"""
-        if self._redis is not None:
-            return self._redis
-        return await get_redis()
-
-    def _generate_code(self) -> str:
-        """生成指定位数的数字验证码。"""
-        return "".join(secrets.choice("0123456789") for _ in range(self._length))
-
-    async def send_code(self, target: str) -> bool:
-        """生成验证码存 Redis 并调用 `_send()` 发送。"""
-        code = self._generate_code()
-        redis = await self._get_redis()
-        await redis.set(f"{CODE_KEY_PREFIX}{target}", code, ex=self._ttl)
-        return await self._send(target, code)
-
-    async def verify_code(self, target: str, code: str) -> bool:
-        """从 Redis 读取存储的验证码比对,成功则删除 key(一次性)。"""
-        redis = await self._get_redis()
-        key = f"{CODE_KEY_PREFIX}{target}"
-        stored = await redis.get(key)
-        if stored is None:
-            return False
-        stored_str = stored if isinstance(stored, str) else stored.decode()
-        if stored_str != code:
-            return False
-        await redis.delete(key)
-        return True
-
-    @abstractmethod
-    async def _send(self, target: str, code: str) -> bool:
-        """子类实现发送动作。"""
-        ...

dwyeapi-0.8.2/src/dwyeapi/providers/sms/config.py

@@ -1,64 +0,0 @@
-"""SMS Provider 配置模型。"""
-
-from typing import Literal
-
-from pydantic import BaseModel, Field
-
-
-class AliyunSmsConfig(BaseModel):
-    """阿里云短信 Provider 配置。
-
-    SMS__PROVIDER=aliyun 时生效;空串默认仅为 pydantic 嵌套实例化需要,
-    provider=mock 场景下不会读取,真正启用时四项凭证必须通过 .env 显式提供。
-    """
-
-    access_key_id: str = Field(
-        default="",
-        description="[必填: aliyun] 阿里云 AccessKey ID",
-    )
-    access_key_secret: str = Field(
-        default="",
-        description="[必填: aliyun] 阿里云 AccessKey Secret",
-    )
-    sign_name: str = Field(
-        default="",
-        description="[必填: aliyun] 短信签名(需在阿里云控制台预先申请)",
-    )
-    template_code: str = Field(
-        default="",
-        description="[必填: aliyun] 短信模板 code,例 SMS_123456789",
-    )
-    region_id: str = Field(
-        default="cn-hangzhou",
-        description="阿里云地域 ID,默认 cn-hangzhou",
-    )
-
-
-class SmsSettings(BaseModel):
-    """SMS 模块配置 -- 业务项目嵌入 Settings 的入口。
-
-    用法:
-        class Settings(DwyBaseSettings):
-            sms: SmsSettings = SmsSettings()
-
-    `.env` 自动识别(双下划线嵌套):
-        SMS__PROVIDER=aliyun
-        SMS__ALIYUN__ACCESS_KEY_ID=LTAI...
-    """
-
-    provider: Literal["mock", "aliyun"] = Field(
-        default="mock",
-        description='SMS Provider 选择:"mock"(dev 限定,打印到日志)/ "aliyun"(生产)',
-    )
-    code_ttl: int = Field(
-        default=300,
-        description="验证码有效期(秒),默认 5 分钟",
-    )
-    code_length: int = Field(
-        default=6,
-        description="验证码位数,默认 6 位数字",
-    )
-    aliyun: AliyunSmsConfig = Field(
-        default_factory=AliyunSmsConfig,
-        description="阿里云短信凭证,provider=aliyun 时必填",
-    )

dwyeapi-0.8.2/src/dwyeapi/providers/sms/factory.py

@@ -1,48 +0,0 @@
-"""SMS Provider 工厂 -- 根据配置选择实现。"""
-
-from dwyeapi.config import is_prod
-from dwyeapi.providers.sms.config import SmsSettings
-from dwyeapi.providers.sms.protocol import SmsProvider
-
-
-def make_sms_provider(settings: SmsSettings) -> SmsProvider:
-    """根据 `settings.provider` 构造对应的 SMS Provider 实例。
-
-    Args:
-        settings: SMS 模块配置(项目 Settings 的嵌套字段)。
-
-    Returns:
-        实现了 `SmsProvider` Protocol 的实例。
-
-    Raises:
-        ValueError: 未知 provider、必填配置缺失,或 prod 环境下选择 mock provider。
-        ImportError: provider 对应的 extra 未安装。
-    """
-    common = {"code_ttl": settings.code_ttl, "code_length": settings.code_length}
-
-    match settings.provider:
-        case "mock":
-            if is_prod():
-                raise ValueError(
-                    "SMS__PROVIDER=mock 在 prod 环境下被禁止;请设置 ENVIRONMENT=dev 或改用真实 provider(aliyun)"
-                )
-            from dwyeapi.providers.sms.mock import MockSmsProvider
-
-            return MockSmsProvider(**common)
-
-        case "aliyun":
-            from dwyeapi.providers.sms.aliyun import AliyunSmsProvider
-
-            if not settings.aliyun.access_key_id or not settings.aliyun.access_key_secret:
-                raise ValueError("SMS__ALIYUN__ACCESS_KEY_ID/SECRET 未配置")
-            return AliyunSmsProvider(
-                access_key_id=settings.aliyun.access_key_id,
-                access_key_secret=settings.aliyun.access_key_secret,
-                sign_name=settings.aliyun.sign_name,
-                template_code=settings.aliyun.template_code,
-                region_id=settings.aliyun.region_id,
-                **common,
-            )
-
-        case _:
-            raise ValueError(f"未知 sms provider: {settings.provider}")

dwyeapi-0.8.2/src/dwyeapi/providers/sms/mock.py

@@ -1,23 +0,0 @@
-"""Mock SMS Provider -- 开发/测试环境使用,日志打印验证码不真实发送。"""
-
-from dwyeapi.logger import get_logger
-from dwyeapi.providers.sms.base import SmsProviderBase
-
-logger = get_logger(__name__)
-
-
-class MockSmsProvider(SmsProviderBase):
-    """Mock 短信验证码 Provider。
-
-    verify_code 故意放宽:任意 4-8 位数字都通过,方便开发者 curl 调试不需要先 send。
-    Email Mock 保持严格校验,因为邮箱注册是主流路径,测试里先 send_code 再 register 更接近生产。
-    """
-
-    async def _send(self, target: str, code: str) -> bool:
-        """打印验证码到日志,始终返回 True。"""
-        logger.info("Mock SMS sent: target=%s code=%s", target, code)
-        return True
-
-    async def verify_code(self, target: str, code: str) -> bool:
-        """Mock 模式宽松校验:任意 4-8 位数字即通过。"""
-        return 4 <= len(code) <= 8 and code.isdigit()

dwyeapi-0.8.2/src/dwyeapi/providers/sms/protocol.py

@@ -1,34 +0,0 @@
-"""SMS Provider Protocol。"""
-
-from typing import Protocol
-
-
-class SmsProvider(Protocol):
-    """短信验证码服务抽象接口。
-
-    实现类:MockSmsProvider(开发)、AliyunSmsProvider(生产)。
-    通过 `dwyeapi.providers.sms.make_sms_provider(settings.sms)` 工厂根据配置选择实现。
-    """
-
-    async def send_code(self, target: str) -> bool:
-        """生成并发送短信验证码。
-
-        Args:
-            target: 收件手机号。
-
-        Returns:
-            发送成功 True,失败 False(异常已记录日志)。
-        """
-        ...
-
-    async def verify_code(self, target: str, code: str) -> bool:
-        """校验短信验证码,成功后一次性删除。
-
-        Args:
-            target: 收件手机号。
-            code: 用户提交的验证码。
-
-        Returns:
-            匹配且未过期返回 True,否则 False。
-        """
-        ...