Python實現(xiàn)自動添加腳本頭信息的示例代碼

更新時間：2016年09月02日 09:41:16 投稿：daisy

這篇文章給大家介紹的一段腳本是自動添加注釋信息的腳本，添加的信息包括腳本名稱、作者和時間等之類的，對于團隊形成統(tǒng)一的編碼規(guī)則很有幫助。有需要的可以參考借鑒。

前言

每個人寫腳本時的格式都會有所不同，有的會注明腳本本身的一些信息，有的則開門見山，這在小團隊里其實沒什么，基本別人做什么你也都知道，但如果放到大的團隊就比較麻煩了，因為隨著人數(shù)的增多，腳本成指數(shù)增長，如果每個人風格不統(tǒng)一，到最后就會造成非常大的弊端，所以當團隊人數(shù)增長后，就必須有一套標準，形成大家統(tǒng)一的編碼規(guī)則，這樣即使不看腳本具體實現(xiàn)，也知道這個腳本的功能是什么。

我們今天分享的一段腳本是自動添加注釋信息的腳本，添加的信息包括腳本名稱、作者、時間、描述、腳本用法、語言版本、備注等，下面來看示例代碼

#!/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
#==============================================================================

總結

大家想一下，如果每個腳本前面都有這些基本信息，是不是看起來會清晰很多，最后希望這個腳本給給大家?guī)硇椭?，當然如果有任何問題可以留言交流。謝謝大家對腳本之家的支持。

您可能感興趣的文章: