qmt_parser/
lib.rs

1#![warn(missing_docs)]
2//! `qmt-parser` 提供面向 MiniQMT / QMT 本地数据目录的解析能力。
3//!
4//! 这个 crate 主要覆盖三类能力：
5//!
6//! - 历史行情 `.dat` 文件解析：tick、1 分钟线、日线
7//! - 可选的 Polars `DataFrame` 输出
8//! - QMT 本地财务与分红数据读取
9//!
10//! 大多数用户可以直接从 crate 根模块调用重导出的顶层函数，例如
11//! [`parse_ticks_to_structs`]、[`parse_min_to_structs`]、
12//! [`parse_daily_to_structs`] 或 [`FinanceReader::read_file`]。
13//!
14//! # Feature Flags
15//!
16//! - `polars`：默认开启，启用 `parse_*_to_dataframe` 系列接口
17//!
18//! # Quick Start
19//!
20//! 解析 tick 文件为结构体：
21//!
22//! ```no_run
23//! use qmt_parser::parse_ticks_to_structs;
24//!
25//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
26//! let ticks = parse_ticks_to_structs("data/000001-20250529-tick.dat")?;
27//! println!("rows = {}", ticks.len());
28//! # Ok(())
29//! # }
30//! ```
31//!
32//! 解析日线并限制日期范围：
33//!
34//! ```no_run
35//! use qmt_parser::parse_daily_to_structs;
36//!
37//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
38//! let rows = parse_daily_to_structs("data/day/000001.dat", "20230101", "20231231")?;
39//! println!("rows = {}", rows.len());
40//! # Ok(())
41//! # }
42//! ```
43//!
44//! 在启用 `polars` feature 时生成 `DataFrame`：
45//!
46//! ```no_run
47//! # #[cfg(feature = "polars")]
48//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
49//! use qmt_parser::parse_min_to_dataframe;
50//!
51//! let df = parse_min_to_dataframe("data/000001-1m.dat")?;
52//! println!("{:?}", df.shape());
53//! # Ok(())
54//! # }
55//! #
56//! # #[cfg(not(feature = "polars"))]
57//! # fn main() {}
58//! ```
59//!
60//! # Modules
61//!
62//! - [`tick`]：Tick 分笔解析
63//! - [`min`]：1 分钟 K 线解析
64//! - [`day`]：日线解析与派生列处理
65//! - [`finance`]：财务 `.DAT` 解析
66//! - [`dividend`]：分红送配 LevelDB 查询
67//! - [`metadata`]：xtquant 本地资料/板块文件解析
68//! - [`error`]：公共错误类型
69
70/// 基于 datadir 根目录的自动发现入口。
71pub mod datadir;
72/// 日线解析与 DataFrame 导出。
73pub mod day;
74/// 分红送配 LevelDB 查询。
75pub mod dividend;
76/// 公开错误类型定义。
77pub mod error;
78/// QMT 财务 `.DAT` 解析。
79pub mod finance;
80/// xtquant 本地资料文件解析。
81pub mod metadata;
82/// 1 分钟 K 线解析与 DataFrame 导出。
83pub mod min;
84/// Tick 分笔解析与 DataFrame 导出。
85pub mod tick;
86
87pub use datadir::{Market, QmtDataDir, parse_security_code};
88/// 日线 DataFrame 的输出列名。
89pub use day::daily_dataframe_column_names;
90pub use day::{DailyKlineData, DailyReader};
91#[cfg(feature = "polars")]
92pub use day::{
93    parse_daily_file_to_dataframe, parse_daily_to_dataframe, parse_daily_to_dataframe_in_range,
94};
95pub use day::{
96    parse_daily_file_to_structs, parse_daily_to_structs, parse_daily_to_structs_in_range,
97};
98pub use dividend::{DividendDb, DividendError, DividendRecord};
99pub use error::{DailyParseError, DataDirError, MetadataParseError, MinParseError, TickParseError};
100pub use finance::{FileType, FinanceData, FinanceError, FinanceReader, FinanceRecord, Shareholder};
101pub use metadata::{
102    load_holidays_from_root, load_holidays_from_standard_paths, load_industry_from_root,
103    load_industry_from_standard_paths, load_sector_names_from_root,
104    load_sector_names_from_standard_paths, load_sector_weight_index_from_root,
105    load_sector_weight_index_from_standard_paths, load_sector_weight_members_from_root,
106    load_sector_weight_members_from_standard_paths, load_sectorlist_from_root,
107    load_sectorlist_from_standard_paths, parse_holiday_file, parse_industry_file,
108    parse_sector_name_file, parse_sector_weight_index, parse_sector_weight_members,
109    parse_sectorlist_dat,
110};
111/// 分钟线 DataFrame 的输出列名。
112pub use min::min_dataframe_column_names;
113#[cfg(feature = "polars")]
114pub use min::parse_min_to_dataframe;
115pub use min::{MinKlineData, MinReader, parse_min_to_structs};
116#[cfg(feature = "polars")]
117pub use tick::parse_ticks_to_dataframe;
118pub use tick::{
119    FULL_TICK_API_FIELD_NAMES, TICK_DATAFRAME_COLUMN_NAMES, tick_api_field_names,
120    tick_dataframe_column_names,
121};
122pub use tick::{TickData, TickReader, parse_ticks_to_structs};
qmt_parser/lib.rs

qmt_parser/
lib.rs
