Skip to content

Config 模块文档

模块路径: FQBase.Config源码: [FQBase/Config](file:///Users/A.D.189/FQuant/FQuant.Server/FQBase/FQBase/Config)


文档索引

主文档

文档说明
README.md模块首页(本文档)
framework.md框架概述、设计原则
architecture.md整体架构

核心配置 (core/)

文档说明
core/README.mdcore 子模块首页
core/framework.md环境变量、Setting、GLOBALMAP
core/api.mdAPI 参考

业务配置 (business/)

文档说明
business/README.mdbusiness 子模块首页
business/framework.md常量、数据源配置
business/api.mdAPI 参考

模块结构

FQBase.Config

├── core/                          # 核心配置
│   ├── env.py                    # 环境变量管理
│   ├── setting.py                # MongoDB 连接配置、路径配置
│   ├── cache_config.py           # 缓存配置
│   └── config_watcher.py         # 配置监听器

└── business/                      # 业务配置
    ├── constants.py              # 交易常量定义
    ├── datasource_config.py       # 数据源配置
    ├── financial_mapping.py       # 财务指标映射
    └── ip_list.py                # IP 列表配置

设计原则

原则说明
核心配置不依赖业务配置core 模块独立
业务配置可以依赖核心配置业务配置依赖核心配置
公共 API 保持向后兼容旧的导入方式继续支持

快速开始

导入核心配置

python
from FQBase.Config import get_env, GLOBALMAP, Setting

# 获取环境变量
mongo_uri = get_env('MONGODB', 'localhost')

# 获取路径配置
data_path = GLOBALMAP.FQDATA_PATH

# 获取 MongoDB 配置
setting = Setting()

导入业务配置

python
from FQBase.Config import MARKET_TYPE, ORDER_DIRECTION

# 使用交易常量
direction = ORDER_DIRECTION.BUY
market = MARKET_TYPE.STOCK

导入缓存配置

python
from FQBase.Config.core import CacheConfig, get_cache_config

config = get_cache_config()
print(f"Cache type: {config.cache_type}")