写一个简单规范的PY脚本

运维中用PY写脚本,可以使得代码更加简洁直观 。但如果不去规范格式。PY 也一样会和SHELL 一样难阅读。
下面规简单的规范化一下一个小脚本的几个基本该有的模块。写脚本只需填充对应场景的功能模块即可。
规范:在日常运维中,脚本大约用于定时任务调起,排障工具,或者对接平台接口。可以把脚本分为 4个模块:输入(按照指定参数获取参数值)、处理(用户特定场景的功能模块)、日志(处理过程中遇到错误、或者重要信息的记录)、输出(脚本最终输出,一般定义为json)
【基本库】:脚本基本会用到的几个函数库。以及设置utf-8,防止中文编码错误

【日志模块】:用logging库函数定义日志的输出。

【主函数】:定义脚本的日志目录,脚本的数据参数(此处模拟常用的4类输入参数:字符串、列表、枚举、布尔值)。自定义函数快的return信息永远被打印到日志文件里。最终保留一个json格式的print 输出

【自定义函数块】:自定义函数快中。自定义函数中用一个字典保存函数执行的状态。有 code message 2个字段 , code标志功能执行成功与否,0表示成功,其他值表示失败。message 记录执行信息。函数的功能永远在try中。失败则返回失败信息到msg["message"]。保证输出永远是msg字典。

【CODE】
https://github.com/jiasirVan/dbaTool/blob/master/script/code.py
以上简单的PY脚本规范定义,保证标准输出永远是toJson(msg) 的 json信息。方便与接口对接。错误信息可以随时用lg() 保存到脚本中,方便排障。
更多运维文章 欢迎关注公众号
最后修改时间:2020-05-14 13:22:11
文章转载自DBATech,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。




