Python實作自動新增腳本頭訊息

前言

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

我們今天分享的一段腳本是自動新增註解資訊的腳本，新增的資訊包括腳本名稱、作者、時間、描述、腳本用法、語言版本、備註等，下面來看範例程式碼

#!/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: ")
p = '======================================='
 
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#' + p * 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
#==============================================================================

#總結

大家想一下，如果每個腳本前面都有這些基本訊息，看起來會清晰很多，最後希望這個腳本給給大家帶來些幫助，當然如果有任何問題可以留言交流。謝謝大家對PHP中文網的支持。

更多Python實作自動加入腳本頭資訊相關文章請關注PHP中文網！