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

 更新时间:2016年09月02日 09:41:16   投稿:daisy  
这篇文章给大家介绍的一段脚本是自动添加注释信息的脚本,添加的信息包括脚本名称、作者和时间等之类的,对于团队形成统一的编码规则很有帮助。有需要的可以参考借鉴。

前言

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

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

#!/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基于TCP实现的文件下载器功能案例

    python基于TCP实现的文件下载器功能案例

    这篇文章主要介绍了python基于TCP实现的文件下载器功能,结合具体实例形式分析了Python使用socket模块实现的tcp协议下载功能客户端与服务器端相关操作技巧,需要的朋友可以参考下
    2019-12-12
  • 在Python的Django框架中创建语言文件

    在Python的Django框架中创建语言文件

    这篇文章主要介绍了在Python的Django框架中创建语言文件的方法,以语言代码来表示语言区域种类,需要的朋友可以参考下
    2015-07-07
  • python中实现字符串翻转的方法

    python中实现字符串翻转的方法

    这篇文章主要介绍了python中实现字符串翻转的方法,代码很简单,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07
  • python将txt文件读取为字典的示例

    python将txt文件读取为字典的示例

    今天小编就为大家分享一篇python将txt文件读取为字典的示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • TensorFlow实现Batch Normalization

    TensorFlow实现Batch Normalization

    这篇文章主要为大家详细介绍了TensorFlow实现Batch Normalization,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • python使用htmllib分析网页内容的方法

    python使用htmllib分析网页内容的方法

    这篇文章主要介绍了python使用htmllib分析网页内容的方法,涉及Python使用htmllib模块的相关技巧,需要的朋友可以参考下
    2015-05-05
  • Python轻量级web框架bottle使用方法解析

    Python轻量级web框架bottle使用方法解析

    这篇文章主要介绍了Python轻量级web框架bottle使用方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • Flask web上传获取图像Image读取并使用方式

    Flask web上传获取图像Image读取并使用方式

    这篇文章主要介绍了Flask web上传获取图像Image读取并使用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • Python扑克牌21点游戏实例代码

    Python扑克牌21点游戏实例代码

    大家好,本篇文章主要讲的是Python扑克牌21点游戏实例代码,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下,方便下次浏览
    2021-12-12
  • 详解Python中的Dict

    详解Python中的Dict

    这篇文章主要为大家介绍了Python中的Dict,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2021-12-12

最新评论