BI报表Python脚本编写清晰框架提示词
这是一份为BI报表Python脚本编写任务设计的结构化提示词方案,旨在帮助数据分析师或开发人员快速...
提示词内容
复制角色定义与任务定位
请以“资深数据分析工程师”或“BI系统开发架构师”的身份,运用这份提示词。你的核心目标是:为一项具体的商业智能(BI)报表自动化需求,生成一个结构清晰、注释完整、易于维护和扩展的Python脚本框架。这不仅是写代码,更是构建一个可复用的、体现工程化思维的解决方案。
适用场景
- 需要定期从数据库或API抽取数据并生成标准化报表的自动化任务。
- 为新BI报表项目搭建初始的、规范化的Python脚本模板。
- 将零散的数据处理步骤整合为一个有完整错误处理与日志记录的生产级脚本。
- 团队协作中,需要统一脚本结构和编码规范以提升可读性与可维护性。
核心提示词
你可以直接使用或组合以下提示词块,填入你的具体需求:
- “编写一个Python脚本框架,用于自动生成[月度销售业绩]BI报表。脚本需包含:模块导入区、配置文件读取、数据库连接与查询函数、数据清洗与转换函数(处理缺失值、计算衍生指标)、报表数据透视与聚合、结果导出为Excel/CSV文件、日志记录函数以及主程序执行流。”
- “设计一个结构化的Python脚本,实现从[CRM系统API]提取数据,经过清洗后,自动更新[客户留存率]BI看板。要求包含异常处理机制、邮件通知功能(成功/失败),并将关键运行参数外置到config.ini文件中。”
- “创建一个模块化的BI数据管道脚本框架,包含extract_data(), transform_data(), load_report()三个核心函数。脚本需使用argparse解析命令行参数,支持指定运行日期和数据源,并输出详细的处理日志到文件。”
风格方向
- 代码风格:遵循PEP 8规范,使用有意义的变量名和函数名(动词+名词结构),如 `fetch_sales_data()`。
- 注释风格:在文件开头使用文档字符串说明脚本目的、作者、版本及主要变更;为每个函数添加功能说明;在复杂逻辑处添加行内注释。
- 架构风格:采用“配置与代码分离”、“函数单一职责”的原则。逻辑处理与输入输出分离,核心算法与业务参数分离。
构图建议(脚本结构布局)
- 头部区域:Shebang(如适用)、编码声明、模块docstring、导入语句(标准库、第三方库、自定义模块分块)。
- 配置区域:常量定义、配置字典或从外部文件(JSON/YAML/INI)加载的配置对象。
- 函数定义区:按数据处理流程顺序定义函数,如:数据获取 → 数据清洗 → 业务计算 → 格式转换 → 输出保存。工具函数(如日志初始化)可前置。
- 主执行区:置于脚本末尾,使用 `if __name__ == '__main__':` 包裹,清晰展示函数调用顺序和流程控制。
细节强化
- 错误处理:在数据库查询、文件读写、API调用等关键操作中使用try-except块,并记录错误日志。
- 日志记录:使用logging模块,设置不同等级(INFO, WARNING, ERROR),输出到控制台和文件,格式包含时间、等级、消息。
- 可配置性:将数据库连接字符串、文件路径、关键阈值、邮件接收人等参数外置。
- 性能提示:对于大数据量,在注释中提示可使用Pandas分块读取、数据库查询优化等建议。
使用建议
- 将“核心提示词”中的方括号内容替换为你的具体业务对象(如“月度销售业绩”替换为“季度财务摘要”)。
- 在实际生成代码后,可根据团队规范,调整函数粒度,补充单元测试函数框架或DAG工作流调度器的集成注释。
- 将此框架作为团队资产,为不同报表类型(日频、周频、月频)衍生出细分的模板变体。
- 在提示词生成工具中,可进一步要求“为上述脚本生成一个对应的README.md文件提纲”,以完善项目文档。