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 相关文章推荐
wxpython学习笔记(推荐查看)
Jun 09 Python
编写Python脚本抓取网络小说来制作自己的阅读器
Aug 20 Python
Python手机号码归属地查询代码
May 04 Python
python监控linux内存并写入mongodb(推荐)
Sep 11 Python
Python实现的求解最大公约数算法示例
May 03 Python
用Python PIL实现几个简单的图片特效
Jan 18 Python
Python告诉你木马程序的键盘记录原理
Feb 02 Python
在Python中利用pickle保存变量的实例
Dec 30 Python
Windows下Anaconda和PyCharm的安装与使用详解
Apr 23 Python
keras-siamese用自己的数据集实现详解
Jun 10 Python
numpy中生成随机数的几种常用函数(小结)
Aug 18 Python
Python基础知识学习之类的继承
May 31 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+AJAX实现无刷新注册(带用户名实时检测)
2007/01/02 PHP
《PHP编程最快明白》第三讲:php数组
2010/11/01 PHP
php设计模式 Decorator(装饰模式)
2011/06/26 PHP
解决php使用异步调用获取数据时出现(错误c00ce56e导致此项操作无法完成)
2013/07/03 PHP
使用PHP curl模拟浏览器抓取网站信息
2013/10/28 PHP
微信公众平台开发实现2048游戏的方法
2015/04/15 PHP
PHP学习笔记(三):数据类型转换与常量介绍
2015/04/17 PHP
checkbox全选/取消全选以及checkbox遍历jQuery实现代码
2009/12/02 Javascript
最佳JS代码编写的14条技巧
2011/01/09 Javascript
JavaScript实现页面跳转的几种常用方式
2015/11/28 Javascript
jQuery实现级联下拉框实战(5)
2017/02/08 Javascript
jquery实现用户登陆界面(示例讲解)
2017/09/06 jQuery
基于Vue2.X的路由和钩子函数详解
2018/02/09 Javascript
微信小程序实现横向增长表格的方法
2018/07/24 Javascript
JS中‘hello’与new String(‘hello’)引出的问题详解
2018/08/14 Javascript
分享5个好用的javascript文件上传插件
2018/09/16 Javascript
express如何解决ajax跨域访问session失效问题详解
2019/06/20 Javascript
JS随机密码生成算法
2019/09/23 Javascript
Vue 中 template 有且只能一个 root的原因解析(源码分析)
2020/04/11 Javascript
分析用Python脚本关闭文件操作的机制
2015/06/28 Python
python paramiko模块学习分享
2017/08/23 Python
python基础教程项目四之新闻聚合
2018/04/02 Python
Python使用爬虫抓取美女图片并保存到本地的方法【测试可用】
2018/08/30 Python
python中文分词库jieba使用方法详解
2020/02/11 Python
Python接口测试文件上传实例解析
2020/05/22 Python
CSS的pointer-events属性详细介绍(作用和注意事项)
2014/04/23 HTML / CSS
出门问问全球官方商城:Tichome音箱和TicWatch智能手表
2017/12/02 全球购物
学生实习介绍信
2014/01/15 职场文书
迟到早退检讨书
2014/02/10 职场文书
大学生职业生涯规划书汇总
2014/03/20 职场文书
初中生考试作弊检讨书
2014/12/14 职场文书
学生检讨书
2015/01/27 职场文书
面试通知邮件
2015/04/20 职场文书
白银帝国观后感
2015/06/17 职场文书
2016元旦主持人经典开场白台词
2015/12/03 职场文书
2016年4月份红领巾广播稿
2015/12/21 职场文书