跳转至

config

feishu.gateway.config

GatewayConfig dataclass

可部署飞书网关的配置对象。

源代码位于： feishu/gateway/config.py
Python
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@dataclass(frozen=True)
class GatewayConfig:
    r"""可部署飞书网关的配置对象。"""

    app_id: str
    app_secret: str
    service_keys: dict[str, str] = field(default_factory=dict)
    region: str = "feishu"
    base_url: str | None = None
    accounts_url: str | None = None
    encrypt_key: str | None = None
    verification_token: str | None = None
    event_max_age_seconds: float | None = 300.0
    host: str = "0.0.0.0"
    port: int = 8000

    @classmethod
    def from_env(cls, environ: Mapping[str, str] | None = None) -> GatewayConfig:
        r"""从环境变量构建网关配置。"""
        env = environ or os.environ
        app_id = _required(env, "FEISHU_APP_ID")
        app_secret = _required(env, "FEISHU_APP_SECRET")
        return cls(
            app_id=app_id,
            app_secret=app_secret,
            service_keys=parse_service_keys(env.get("FEISHU_GATEWAY_SERVICE_KEYS", "")),
            region=env.get("FEISHU_REGION", "feishu") or "feishu",
            base_url=env.get("FEISHU_BASE_URL") or None,
            accounts_url=env.get("FEISHU_ACCOUNTS_URL") or None,
            encrypt_key=env.get("FEISHU_ENCRYPT_KEY") or None,
            verification_token=env.get("FEISHU_VERIFICATION_TOKEN") or None,
            event_max_age_seconds=_optional_float(env.get("FEISHU_EVENT_MAX_AGE_SECONDS", "300")),
            host=env.get("FEISHU_GATEWAY_HOST", "0.0.0.0") or "0.0.0.0",
            port=_optional_int(env.get("FEISHU_GATEWAY_PORT"), default=8000),
        )

from_env classmethod

Python
from_env(environ: Mapping[str, str] | None = None) -> GatewayConfig

从环境变量构建网关配置。

源代码位于： feishu/gateway/config.py
Python
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@classmethod
def from_env(cls, environ: Mapping[str, str] | None = None) -> GatewayConfig:
    r"""从环境变量构建网关配置。"""
    env = environ or os.environ
    app_id = _required(env, "FEISHU_APP_ID")
    app_secret = _required(env, "FEISHU_APP_SECRET")
    return cls(
        app_id=app_id,
        app_secret=app_secret,
        service_keys=parse_service_keys(env.get("FEISHU_GATEWAY_SERVICE_KEYS", "")),
        region=env.get("FEISHU_REGION", "feishu") or "feishu",
        base_url=env.get("FEISHU_BASE_URL") or None,
        accounts_url=env.get("FEISHU_ACCOUNTS_URL") or None,
        encrypt_key=env.get("FEISHU_ENCRYPT_KEY") or None,
        verification_token=env.get("FEISHU_VERIFICATION_TOKEN") or None,
        event_max_age_seconds=_optional_float(env.get("FEISHU_EVENT_MAX_AGE_SECONDS", "300")),
        host=env.get("FEISHU_GATEWAY_HOST", "0.0.0.0") or "0.0.0.0",
        port=_optional_int(env.get("FEISHU_GATEWAY_PORT"), default=8000),
    )

parse_service_keys

Python
parse_service_keys(raw: str) -> dict[str, str]

把 service:key 列表解析为网关使用的 {key: service} 映射。

源代码位于： feishu/gateway/config.py
Python
66
67
68
69
70
71
72
73
74
75
76
77
def parse_service_keys(raw: str) -> dict[str, str]:
    r"""把 ``service:key`` 列表解析为网关使用的 ``{key: service}`` 映射。"""
    service_keys: dict[str, str] = {}
    for item in raw.split(","):
        item = item.strip()
        if not item:
            continue
        service_name, separator, api_key = item.partition(":")
        if not separator or not service_name or not api_key:
            raise ValueError("FEISHU_GATEWAY_SERVICE_KEYS entries must be service:key pairs")
        service_keys[api_key] = service_name
    return service_keys