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复制文件代码实现
Dec 23 Python
一则python3的简单爬虫代码
May 26 Python
Python的Flask开发框架简单上手笔记
Nov 16 Python
Python中使用asyncio 封装文件读写
Sep 11 Python
python实现二叉查找树实例代码
Feb 08 Python
Python实现判断一行代码是否为注释的方法
May 23 Python
Python import与from import使用及区别介绍
Sep 06 Python
django模板结构优化的方法
Feb 28 Python
python语言基本语句用法总结
Jun 11 Python
django中SMTP发送邮件配置详解
Jul 19 Python
最小二乘法及其python实现详解
Feb 24 Python
Python try except异常捕获机制原理解析
Apr 18 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一些十分严重的缺陷详解
2013/06/03 PHP
深入apache host的配置详解
2013/06/09 PHP
php pdo操作数据库示例
2017/03/10 PHP
PHP设计模式(八)装饰器模式Decorator实例详解【结构型】
2020/05/02 PHP
jQuery参数列表集合
2011/04/06 Javascript
解析javascript系统错误:-1072896658的解决办法
2013/07/08 Javascript
文本框水印提示效果的简单实现代码
2014/02/22 Javascript
仿淘宝TAB切换搜索框搜索切换的相关内容
2014/09/21 Javascript
JS仿Windows开机启动Loading进度条的方法
2015/02/26 Javascript
JavaScript九九乘法口诀表的简单实现
2016/10/04 Javascript
BootStrap Validator 根据条件在JS中添加或移除校验操作
2017/10/12 Javascript
详解React Native 采用Fetch方式发送跨域POST请求
2017/11/15 Javascript
如何使用vuex实现兄弟组件通信
2018/11/02 Javascript
vue插件draggable实现拖拽移动图片顺序
2018/12/01 Javascript
在vue中使用echarts(折线图的demo,markline用法)
2020/07/20 Javascript
微信小程序canvas实现签名功能
2021/01/19 Javascript
[05:09]DOTA2-DPC中国联赛2月22日Recap集锦
2021/03/11 DOTA
Python创建系统目录的方法
2015/03/11 Python
python统计字符串中指定字符出现次数的方法
2015/04/04 Python
Python使用CMD模块更优雅的运行脚本
2015/05/11 Python
Python实现从log日志中提取ip的方法【正则提取】
2018/03/31 Python
基于anaconda下强大的conda命令介绍
2018/06/11 Python
总结python中pass的作用
2019/02/27 Python
python django model联合主键的例子
2019/08/06 Python
Python自动化完成tb喵币任务的操作方法
2019/10/30 Python
python 实现矩阵填充0的例子
2019/11/29 Python
Python输出指定字符串的方法
2020/02/06 Python
英国评分最高的女性剃须刀订阅盒:FFS Beauty
2018/01/25 全球购物
高清安全摄像头系统:Lorex Technology
2018/07/20 全球购物
TripAdvisor日本:全球领先的旅游网站
2019/02/14 全球购物
公积金转移接收函
2014/01/11 职场文书
大学生优秀自荐信范文
2014/02/25 职场文书
2014年干部培训工作总结
2014/12/17 职场文书
python 爬取豆瓣网页的示例
2021/04/13 Python
CSS 还能这样玩?奇思妙想渐变的艺术
2021/04/27 HTML / CSS
MySQL 使用索引扫描进行排序
2021/06/20 MySQL