संपादित करें: यदि आप ग्रहण का उपयोग कर रहे हैं, तो वहाँ है एक प्लगइन है
मैंने सिल्वर ड्रैगन के उत्तर पर आधारित एक साधारण अजगर स्क्रिप्ट लिखी। मुझे और अधिक लचीले समाधान की आवश्यकता थी इसलिए मैं इसके साथ आया। यह आपको एक निर्देशिका में सभी फ़ाइलों के लिए एक शीर्ष लेख जोड़ने की अनुमति देता है, पुनरावर्ती। आप वैकल्पिक रूप से एक regex जोड़ सकते हैं जो फ़ाइल नाम से मेल खाना चाहिए, और एक regex जो निर्देशिका नामों से मेल खाना चाहिए और एक regex जो फ़ाइल में पहली पंक्ति से मेल नहीं खाना चाहिए। आप इस अंतिम तर्क का उपयोग यह जांचने के लिए कर सकते हैं कि क्या हेडर पहले ही शामिल है।
यह स्क्रिप्ट स्वचालित रूप से किसी फ़ाइल में पहली पंक्ति को छोड़ देगी यदि यह एक शेबंग (#!) से शुरू होती है। इस पर निर्भर अन्य स्क्रिप्ट को तोड़ने के लिए नहीं। यदि आप इस व्यवहार की इच्छा नहीं रखते हैं, तो आपको 3 पंक्तियाँ लिखनी होंगी।
यह रहा:
#!/usr/bin/python
"""
This script attempts to add a header to each file in the given directory
The header will be put the line after a Shebang (#!) if present.
If a line starting with a regular expression 'skip' is present as first line or after the shebang it will ignore that file.
If filename is given only files matchign the filename regex will be considered for adding the license to,
by default this is '*'
usage: python addheader.py headerfile directory [filenameregex [dirregex [skip regex]]]
easy example: add header to all files in this directory:
python addheader.py licenseheader.txt .
harder example adding someone as copyrightholder to all python files in a source directory,exept directories named 'includes' where he isn't added yet:
python addheader.py licenseheader.txt src/ ".*\.py" "^((?!includes).)*$" "#Copyright .* Jens Timmerman*"
where licenseheader.txt contains '#Copyright 2012 Jens Timmerman'
"""
import os
import re
import sys
def writeheader(filename,header,skip=None):
"""
write a header to filename,
skip files where first line after optional shebang matches the skip regex
filename should be the name of the file to write to
header should be a list of strings
skip should be a regex
"""
f = open(filename,"r")
inpt =f.readlines()
f.close()
output = []
#comment out the next 3 lines if you don't wish to preserve shebangs
if len(inpt) > 0 and inpt[0].startswith("#!"):
output.append(inpt[0])
inpt = inpt[1:]
if skip and skip.match(inpt[0]): #skip matches, so skip this file
return
output.extend(header) #add the header
for line in inpt:
output.append(line)
try:
f = open(filename,'w')
f.writelines(output)
f.close()
print "added header to %s" %filename
except IOError,err:
print "something went wrong trying to add header to %s: %s" % (filename,err)
def addheader(directory,header,skipreg,filenamereg,dirregex):
"""
recursively adds a header to all files in a dir
arguments: see module docstring
"""
listing = os.listdir(directory)
print "listing: %s " %listing
#for each file/dir in this dir
for i in listing:
#get the full name, this way subsubdirs with the same name don't get ignored
fullfn = os.path.join(directory,i)
if os.path.isdir(fullfn): #if dir, recursively go in
if (dirregex.match(fullfn)):
print "going into %s" % fullfn
addheader(fullfn, header,skipreg,filenamereg,dirregex)
else:
if (filenamereg.match(fullfn)): #if file matches file regex, write the header
writeheader(fullfn, header,skipreg)
def main(arguments=sys.argv):
"""
main function: parses arguments and calls addheader
"""
##argument parsing
if len(arguments) > 6 or len(arguments) < 3:
sys.stderr.write("Usage: %s headerfile directory [filenameregex [dirregex [skip regex]]]\n" \
"Hint: '.*' is a catch all regex\nHint:'^((?!regexp).)*$' negates a regex\n"%sys.argv[0])
sys.exit(1)
skipreg = None
fileregex = ".*"
dirregex = ".*"
if len(arguments) > 5:
skipreg = re.compile(arguments[5])
if len(arguments) > 3:
fileregex = arguments[3]
if len(arguments) > 4:
dirregex = arguments[4]
#compile regex
fileregex = re.compile(fileregex)
dirregex = re.compile(dirregex)
#read in the headerfile just once
headerfile = open(arguments[1])
header = headerfile.readlines()
headerfile.close()
addheader(arguments[2],header,skipreg,fileregex,dirregex)
#call the main method
main()