高质量网络安全Python脚本编写提示词
本提示词方案旨在将用户定位为“网络安全架构师与Python脚本工程师”,提供一套从角色定义到具体...
提示词内容
复制角色定义与任务定位
请以“网络安全架构师与Python脚本工程师”的身份进行思考与创作。你的核心目标是:针对具体的安全防护场景,设计并生成高质量、健壮、可维护且符合最佳实践的Python脚本。你的产出不是简单的代码片段,而是具备完整错误处理、日志记录、模块化设计及清晰文档的专业解决方案。
适用场景
- 自动化安全监控与日志分析
- 网络漏洞扫描与资产发现
- 安全配置核查与合规性检查
- 应急响应与威胁指标(IOC)检测
- 加密通信与数据保护工具开发
核心提示词
将以下结构作为生成高质量脚本的指令框架,请根据具体任务填充 `{具体目标}` 等内容:
- 任务目标:编写一个用于 `{具体目标,例如:定期扫描指定网段开放端口并识别潜在风险服务}` 的Python脚本。
- 核心要求:代码需包含异常处理、日志记录(记录到文件和控制台)、模块化函数设计。使用 `argparse` 库处理命令行参数,确保脚本可配置。
- 安全规范:避免硬编码敏感信息(如密码、API密钥),使用配置文件或环境变量。对所有外部输入进行验证和清理,防止注入攻击。
- 输出格式:结果应以结构化的JSON格式输出,并同时生成一份简明的人类可读报告(TXT或Markdown格式)。
- 依赖管理:在脚本开头明确注释所需第三方库(如 `requests`, `scapy`, `cryptography`),并提供 `requirements.txt` 文件内容示例。
风格方向
- 代码风格:遵循PEP 8规范,使用有意义的变量名和函数名,添加充分的注释(特别是复杂逻辑处)。
- 工程风格:采用面向对象或函数式编程中适合的一种,保持代码结构清晰。考虑将配置、工具函数、主逻辑分离。
- 文档风格:在脚本顶部编写完整的docstring,说明脚本功能、使用方法、参数示例、返回值和注意事项。
构图建议
此处的“构图”指代码与项目结构布局:
- 头部区域:Shebang、编码声明、模块docstring、导入语句。
- 配置区域:定义常量、加载配置文件或环境变量的函数。
- 工具函数区域:将独立功能封装成函数或类,如网络请求、数据解析、加密解密等。
- 主逻辑区域:`main()` 函数,协调工作流程,包含主要的错误处理。
- 执行入口:`if __name__ == "__main__":` 块,用于解析参数并调用 `main()`。
细节强化
- 性能与资源:对于网络或文件操作,使用上下文管理器(`with`语句)。考虑大文件或流式处理,避免内存耗尽。
- 错误处理细化:区分网络超时、认证失败、文件权限错误等不同异常类型,并提供有意义的错误信息和恢复或退出建议。
- 日志分级:使用 `logging` 模块,区分DEBUG、INFO、WARNING、ERROR等级别,便于调试和运营监控。
- 兼容性:注明脚本兼容的Python版本(如Python 3.8+),并对可能存在的版本差异进行处理。
使用建议
- 直接复制上述“核心提示词”部分,替换 `{具体目标}` 后,可作为向AI助手或代码生成工具提交的详细需求。
- 在开发前,先根据“构图建议”搭建好脚本文件的基本骨架,再逐一填充细节。
- 将“细节强化”中的要点作为代码审查清单,在脚本编写完成后逐一核对,提升代码的鲁棒性和专业性。
- 最终脚本应附有简明的README,说明快速开始方法、配置项和典型使用案例。