Python API / Python公开API索引
本页目录
计划加载与检查执行与结果批量任务高性能积分器自定义分析算子业务预设时间转换功能与配置关联Python公开API索引
按调用任务查询公开入口。每个名称进入单独的公开对象页,包含完整构造签名、公开方法/属性、参数、返回值和异常。通用分析、批量、预设和时间入口从chronaxis导入;高性能积分器和自定义分析算子在各节注明实际导入模块;结果行模型见结果结构,内部模块见开发参考。从文件运行的完整流程见Python快速开始。
计划加载与检查
执行与结果
| 公开名称 |
定义与用途 |
chronaxis.AnalysisRunner |
AnalysisRunner:保存可选后端覆盖,复用同一静态校验,逐次创建独立运行资源。 |
chronaxis.AnalysisResult |
AnalysisResult:保存暂存路径和小型元数据,无events/segments/calculations全量列表。 |
chronaxis.OutputManifest |
OutputManifest:保存成功发布目录、清单和固定白名单表行数;legacy只在启用时出现。 |
chronaxis.ExportManifest |
ExportManifest:提供直接信号CSV或原帧导出的实际目录、完成清单及数据文件路径。 |
chronaxis.RunMetadata |
RunMetadata:保存运行身份、实际后端、时间解释、会话边界与兼容限制。 |
chronaxis.AnalysisError |
AnalysisError:表示分析或结果交付失败;异常本身不承诺旧输出已回滚。 |
chronaxis.ResultClosedError |
ResultClosedError:表示结果已经关闭,不能再创建迭代器、读取或发布。 |
批量任务
| 公开名称 |
定义与用途 |
chronaxis.BatchPlan |
BatchPlan:保存批量选项及独立任务列表;任务可引用分析配置路径或已加载的分析计划。同一连续会话仍放在一个任务中。 |
chronaxis.BatchJob |
BatchJob:声明一个独立分析;同会话连续文件应包含在本任务的一个计划中。 |
chronaxis.BatchJobResult |
BatchJobResult:保存一个任务的最终状态;发布后关闭失败仍为failed,并保留已发布路径。 |
chronaxis.BatchReport |
BatchReport:按原任务顺序汇总结果;每个任务数值表仍在各自目录,不会把不同任务的数值相加。 |
chronaxis.BatchRunner |
BatchRunner:通过process_count设置分析工作进程数,每次run创建并回收本批的工作进程;不跨批次缓存计划和状态。 |
chronaxis.load_batch_plan |
load_batch_plan:读取严格批量JSON/YAML。参数: path为UTF-8配置文件。返回: BatchPlan。异常: 带路径配置错误。 |
chronaxis.run_batch |
run_batch:运行并发布批量报告。 |
高性能积分器
使用from chronaxis.fast import run和from chronaxis.fast.batch import run_batch导入上述入口。
自定义分析算子
使用from chronaxis.extensions import ExtensionRegistry, FunctionSpec, ReductionSpec, TransformSpec导入以下对象。
参数、生命周期和完整示例见自定义分析算子。
业务预设
| 公开名称 |
定义与用途 |
chronaxis.PresetSpec |
PresetSpec:保存预设实例名、任务类型、模板版本、角色与信号对应关系及业务参数;通过from_dict建立不可修改的声明。 |
chronaxis.PlanFragment |
PlanFragment:保存预设生成的公共节点,不含来源、执行器或真实样本。 |
chronaxis.build_preset |
build_preset:校验v1预设并展开公共声明,不执行I/O或数值分析。 |
chronaxis.resolve_preset_roles |
resolve_preset_roles:先使用role_bindings明确指定的信号;未指定的角色再按semantic_id和semantic_contract_version查找唯一符合角色要求的信号。 |
时间转换
功能与配置关联
| 配置或任务 |
功能指南 |
主要API |
| 配置文件与公共定义 |
配置结构、公共定义 |
load_analysis_plan、AnalysisPlan.from_dict |
| 事件、窗口和计算 |
规则、窗口、计算 |
AnalysisRunner.run、AnalysisResult迭代方法 |
| 独立任务批量运行 |
批量任务 |
load_batch_plan、run_batch |
| 预设角色及声明生成 |
业务预设 |
PresetSpec、resolve_preset_roles、build_preset |
| 时间单位和日期 |
时间与结果质量 |
parse_duration、convert_time、parse_datetime_ns |