# Data Contract 模块 API 文档

**版本：** `0.3.3`（`IssueResult` / plural `issue` **已实现**；单 `entity_id` 糖仍可用。）

本文档采用统一 API 条目格式：函数名、状态、描述、诞生版本、参数（三列表格）、返回值。

包级常用导出见 `core.modules.data_contract` 的 `__all__`；下文含内部协作类型（如 `ContractIssuer`）仅作索引时可略。

---

## IssueResult（0.3.0）

### 类型名
`IssueResult`

- 状态：`stable`
- 描述：**`issue`** 的统一返回信封。GLOBAL 使用 **`contract`**；PER_ENTITY 使用 **`by_entity`**（`entity_id → DataContract`）。见 [`DECISIONS.md`](DECISIONS.md) 决策 9。
- 诞生版本：`0.3.0`
- 字段（概念）：

| 字段 | 类型 | 说明 |
|------|------|------|
| `data_id` | `DataKey` | 本次签发的 data key |
| `scope` | `ContractScope` | `GLOBAL` 或 `PER_ENTITY` |
| `contract` | `DataContract \| None` | **GLOBAL** 时非空 |
| `by_entity` | `Mapping[str, DataContract] \| None` | **PER_ENTITY** 时非空 |

- 方法（推荐）：**`entity_count()`**、**`entity(entity_id)`**、**`require_one()`**

---

## DataContractManager

### 函数名
`__init__(self, *, contract_cache: ContractCacheManager) -> None`

- 状态：`stable`
- 描述：构造管理器：合并 `default_map` 与 userspace 映射、创建 **`ContractIssuer`**、持有 **`ContractCacheManager`**。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `contract_cache` | `ContractCacheManager` | 进程内缓存实例 |

- 返回值：`None`

---

### 函数名
`issue(self, data_id: DataKey, *, entity_id: Optional[str] = None, entity_ids: Optional[Sequence[str]] = None, start: Optional[str] = None, end: Optional[str] = None, **override_params: Any) -> IssueResult`

- 状态：`stable`
- 描述：签发数据契约。 **`GLOBAL`**：返回 **`IssueResult.contract`**（缓存与物化规则同 [`DECISIONS.md`](DECISIONS.md) 决策 4）。 **`PER_ENTITY`**：须 **`entity_ids`**（或糖 **`entity_id`**）；DCM 通过 loader **`load_batch`**（优先）或循环 **`load`** 物化 **`IssueResult.by_entity`**。参数与缓存语义见 [`DECISIONS.md`](DECISIONS.md)。
- 诞生版本：`0.2.0`（`IssueResult` / `entity_ids`：`0.3.0`）
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `data_id` | `DataKey` | 必选；须在合并后的 `map` 中存在 |
| `entity_id` (可选) | `Optional[str]` | **PER_ENTITY 糖**：等价 `entity_ids=[entity_id]`；与 `entity_ids` 互斥 |
| `entity_ids` (可选) | `Optional[Sequence[str]]` | **PER_ENTITY**：非空 entity 列表 |
| `start` (可选) | `Optional[str]` | 时序：与 `end` 同传或同省略 |
| `end` (可选) | `Optional[str]` | 时序：与 `start` 同传或同省略 |
| `**override_params` | `Any` | 覆盖 mapping 中 `defaults` 的 loader 参数 |

- 返回值：`IssueResult`

---

## ContractCacheManager

### 函数名
`__init__(self) -> None`

- 状态：`stable`
- 描述：创建 **global** 与 **per-strategy** 两个 store。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`None`

---

### 函数名
`enter_strategy_run(self) -> None`

- 状态：`stable`
- 描述：单次策略 run 开始：清空 **per-strategy** 层（可与 `exit_strategy_run` 对称使用）。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`None`

---

### 函数名
`exit_strategy_run(self) -> None`

- 状态：`stable`
- 描述：单次策略 run 结束：清空 **per-strategy** 层。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`None`

---

### 函数名
`clear_global(self) -> None`

- 状态：`stable`
- 描述：清空 **global** 层缓存。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`None`

---

### 函数名
`clear_all(self) -> None`

- 状态：`stable`
- 描述：清空 global 与 per-strategy 两层。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`None`

---

### 函数名
`get(self, cache_scope: ContractCacheScope, key: str) -> Optional[ContractCacheEntry]`

- 状态：`stable`
- 描述：按层读取缓存条目（通常由 **`DataContractManager`** 内部使用）。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `cache_scope` | `ContractCacheScope` | `GLOBAL` / `PER_STRATEGY` 等 |
| `key` | `str` | 缓存键 |

- 返回值：`ContractCacheEntry` 或 `None`

---

### 函数名
`put_for_scope(self, cache_scope: ContractCacheScope, key: str, *, meta: Optional[Dict[str, Any]] = None, data: Any = None) -> None`

- 状态：`stable`
- 描述：写入缓存；`cache_scope == NONE` 时不写。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `cache_scope` | `ContractCacheScope` | 目标层 |
| `key` | `str` | 缓存键 |
| `meta` (可选) | `Optional[Dict[str, Any]]` | 元数据 |
| `data` (可选) | `Any` | 载荷 |

- 返回值：`None`

---

### 函数名
`put_entry(self, cache_scope: ContractCacheScope, key: str, entry: ContractCacheEntry) -> None`

- 状态：`stable`
- 描述：以完整 **`ContractCacheEntry`** 写入；`NONE` 时不写。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `cache_scope` | `ContractCacheScope` | 目标层 |
| `key` | `str` | 缓存键 |
| `entry` | `ContractCacheEntry` | 条目 |

- 返回值：`None`

---

## resolve_cache_scope

### 函数名
`resolve_cache_scope(spec: DataSpec) -> ContractCacheScope`

- 状态：`stable`
- 描述：根据 **`DataSpec`** 的 `scope` 与 `type` 决定缓存层；见 [`DESIGN.md`](DESIGN.md)。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `spec` | `DataSpec` | 单条映射 |

- 返回值：`ContractCacheScope`

---

### 函数名
`resolve_cache_scope_for_data_key(dcm_map: DataSpecMap, data_id: DataKey) -> ContractCacheScope`

- 状态：`stable`
- 描述：对 **`dcm_map`** 查 `data_id` 后调用 **`resolve_cache_scope`**；不存在时返回 **`NONE`**。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `dcm_map` | `DataSpecMap` | 合并后的映射 |
| `data_id` | `DataKey` | 键 |

- 返回值：`ContractCacheScope`

---

## discover_userspace_map

### 函数名
`discover_userspace_map() -> DataSpecMap`

- 状态：`stable`
- 描述：若存在 **`userspace.data_contract.mapping`** 且导出映射变量，则解析为 **`DataSpecMap`**；否则返回空字典。键经 **`DataKey`** 规范化。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`DataSpecMap`

---

## DataContract

### 函数名
`needs_load(self) -> bool`

- 状态：`stable`
- 描述：属性语义：`True` 表示 **`data is None`**，仍需 **`load`**。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`bool`

---

### 函数名
`get_meta(self) -> ContractMeta`

- 状态：`stable`
- 描述：返回 **`ContractMeta`**。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`ContractMeta`

---

### 函数名
`load(self, **override_params: Any) -> Any`

- 状态：`stable`
- 描述：合并 **`loader_params`** 与 `override_params` 后调用 **`loader.load(params, context)`**，结果写入 **`self.data`** 并返回。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `**override_params` | `Any` | 覆盖本次 load 的参数 |

- 返回值：loader 返回的任意类型（通常为行列表）

---

### 函数名
`validate_raw(self, raw: Any) -> Any`

- 状态：`beta`（基类透传；子类加强校验）
- 描述：对 **raw** 做校验/规范化；**`DataContract`** 基类默认透传 **`raw`**；**`TimeSeriesContract` / `NonTimeSeriesContract`** 实现轻量校验。
- 诞生版本：`0.2.0`
- params：

| 名字 | 类型 | 说明 |
|------|------|------|
| `raw` | `Any` | 裸数据 |

- 返回值：通过校验后的数据（当前多为原样或同结构）

---

### 函数名
`clear(self) -> None`

- 状态：`stable`
- 描述：将 **`data`** 置为 **`None`**。
- 诞生版本：`0.2.0`
- params：无
- 返回值：`None`

---

## DataKey（枚举）

字符串枚举，成员包括（值为其字符串）：`STOCK_LIST`、`STOCK_KLINE_DAILY`、`STOCK_KLINE_WEEKLY`、`STOCK_KLINE_MONTHLY`、`TAG`、`STOCK_ADJ_FACTOR_EVENTS`、`STOCK_CORPORATE_FINANCE`、`STOCK_INDICATORS_DAILY`、`INDEX_LIST`、`INDEX_KLINE_DAILY`、`INDEX_WEIGHT_DAILY`、`MACRO_GDP`、`MACRO_LPR`、`MACRO_CPI`、`MACRO_PPI`、`MACRO_PMI`。完整定义见 `contract_const.py`。

---

## 示例

```python
from core.modules.data_contract import (
    ContractCacheManager,
    DataContractManager,
    DataKey,
)

cache = ContractCacheManager()
dcm = DataContractManager(contract_cache=cache)

c = dcm.issue(DataKey.STOCK_LIST)
assert c.data is not None or c.needs_load
```

---

## 相关文档

- [ARCHITECTURE.md](ARCHITECTURE.md)
- [DESIGN.md](DESIGN.md)
- [DECISIONS.md](DECISIONS.md)
