Python实现自动添加脚本头信息的示例代码


Posted in Python onSeptember 02, 2016

前言

每个人写脚本时的格式都会有所不同,有的会注明脚本本身的一些信息,有的则开门见山,这在小团队里其实没什么,基本别人做什么你也都知道,但如果放到大的团队就比较麻烦了,因为随着人数的增多,脚本成指数增长,如果每个人风格不统一,到最后就会造成非常大的弊端,所以当团队人数增长后,就必须有一套标准,形成大家统一的编码规则,这样即使不看脚本具体实现,也知道这个脚本的功能是什么。

我们今天分享的一段脚本是自动添加注释信息的脚本,添加的信息包括脚本名称、作者、时间、描述、脚本用法、语言版本、备注等,下面来看示例代码

#!/usr/bin/env python
 
 
from os.path import exists
from time import strftime
import os
 
title = raw_input("Enter a title for your script: ")
 
title = title + '.py'
 
title = title.lower()
 
title = title.replace(' ', '_')
 
if exists(title):
  print "\nA script with this name already exists."
  exit(1)
 
descrpt = raw_input("Enter a description: ")
name = raw_input("Enter your name: ")
ver = raw_input("Enter the version number: ")
div = '======================================='
 
filename = open(title, 'w')
 
date = strftime("%Y%m%d")
 
filename.write('#!/usr/bin/python')
filename.write('\n#title\t\t\t:' + title)
filename.write('\n#description\t\t:' + descrpt)
filename.write('\n#author\t\t\t:' + name)
filename.write('\n#date\t\t\t:' + date)
filename.write('\n#version\t\t:' + ver)
filename.write('\n#usage\t\t\t:' + 'python ' + title)
filename.write('\n#notes\t\t\t:')
filename.write('\n#python_version\t\t:2.6.6')
filename.write('\n#' + div * 2 + '\n')
filename.write('\n')
filename.write('\n')
 
filename.close()
 
os.system("clear") 
 
os.system("vim +12 " + title)
exit()

脚本不做过多解释了,基本就是获取信息,然后写入一个文件中,其它不废话了,这个脚本足够简单了,我们最后来看看生成的结果:

#!/usr/bin/python
#title         :test4.py
#description      :I am test script
#author         :python技术
#date          :20160902
#version        :0.1
#usage         :python test4.py
#notes         :
#python_version     :2.6.6
#==============================================================================

总结

大家想一下,如果每个脚本前面都有这些基本信息,是不是看起来会清晰很多,最后希望这个脚本给给大家带来些帮助,当然如果有任何问题可以留言交流。谢谢大家对三水点靠木的支持。

Python 相关文章推荐
python pdb调试方法分享
Jan 21 Python
python3实现短网址和数字相互转换的方法
Apr 28 Python
Python使用xlrd模块操作Excel数据导入的方法
May 26 Python
Python运算符重载用法实例
May 28 Python
Python深入06——python的内存管理详解
Dec 07 Python
使用Python & Flask 实现RESTful Web API的实例
Sep 19 Python
Python实现控制台中的进度条功能代码
Dec 22 Python
使用selenium模拟登录解决滑块验证问题的实现
May 10 Python
Pytorch之view及view_as使用详解
Dec 31 Python
Python3实现监控新型冠状病毒肺炎疫情的示例代码
Feb 13 Python
Python切割图片成九宫格的示例代码
Mar 10 Python
python如何调用字典的key
May 25 Python
利用Python获取操作系统信息实例
Sep 02 #Python
好用的Python编辑器WingIDE的使用经验总结
Aug 31 #Python
Linux下为不同版本python安装第三方库
Aug 31 #Python
Python中的左斜杠、右斜杠(正斜杠和反斜杠)
Aug 30 #Python
分享Python开发中要注意的十个小贴士
Aug 30 #Python
Python将图片批量从png格式转换至WebP格式
Aug 22 #Python
利用Python批量生成任意尺寸的图片
Aug 29 #Python
You might like
用php获取远程图片并把它保存到本地的代码
2008/04/07 PHP
php printf输出格式使用说明
2010/12/05 PHP
介绍一些PHP判断变量的函数
2012/04/24 PHP
解析php mysql 事务处理回滚操作(附实例)
2013/08/05 PHP
php和jquery实现地图区域数据统计展示数据示例
2014/02/12 PHP
详解PHP中strlen和mb_strlen函数的区别
2014/03/07 PHP
修改ThinkPHP缓存为Memcache的方法
2014/06/25 PHP
ThinkPHP文件上传实例教程
2014/08/22 PHP
php+mysql大量用户登录解决方案分析
2014/12/29 PHP
php获取excel文件数据
2017/04/21 PHP
PHP5.5基于mysqli连接MySQL数据库和读取数据操作实例详解
2019/02/16 PHP
基于Laravel 5.2 regex验证的正确写法
2019/09/29 PHP
javascript下操作css的float属性的特殊写法
2007/08/22 Javascript
JavaScript实现可拖拽的拖动层Div实例
2015/08/05 Javascript
js判断文本框输入的内容是否为数字
2015/12/23 Javascript
JavaScript6 let 新语法优势介绍
2016/07/15 Javascript
微信小程序 基础知识css样式media标签
2017/02/15 Javascript
JS简单获取当前日期时间的方法(如:2017-03-29 11:41:10 星期四)
2017/03/29 Javascript
详解javascript中的Error对象
2019/04/25 Javascript
如何基于原生javaScript生成带图片的二维码
2019/11/21 Javascript
sharp.js安装过程中遇到的问题总结
2020/04/02 Javascript
[43:51]2014 DOTA2国际邀请赛中国区预选赛 Dream Times VS TongFu
2014/05/22 DOTA
[06:49]2018DOTA2国际邀请赛寻真——VirtusPro傲视群雄
2018/08/12 DOTA
python访问系统环境变量的方法
2015/04/29 Python
.img/.hdr格式转.nii格式的操作
2020/07/01 Python
HTML5页面直接调用百度地图API获取当前位置直接导航目的地的实现代码
2018/03/02 HTML / CSS
欧洲最大的婴幼儿服装及内衣公司:Petit Bateau(小帆船)
2016/08/16 全球购物
大专计算机个人求职的自我评价
2013/10/21 职场文书
办公室主任岗位职责
2013/11/08 职场文书
营销总经理的岗位职责
2013/12/15 职场文书
简短大学毕业感言
2014/01/18 职场文书
干部现实表现材料
2014/02/13 职场文书
工作证明格式及范本
2014/09/12 职场文书
贫困证明书格式及范文
2014/10/15 职场文书
暑假安全保证书
2015/02/28 职场文书
python基于opencv批量生成验证码的示例
2021/04/28 Python