Python implements automatic addition of script header information

Preface

Everyone’s format when writing a script will be different. Some will indicate some information about the script itself, while others will get straight to the point. In fact, there is nothing in the team. You basically know what others do, but if you put it into a large team, it will be more troublesome, because as the number of people increases, the script grows exponentially. If everyone’s style is not unified, it will cause problems in the end. It is a very big disadvantage, so when the number of people in the team increases, there must be a set of standards to form unified coding rules for everyone, so that even if you don't see the specific implementation of the script, you know what the function of the script is.

The script we share today is a script that automatically adds comment information. The added information includes script name, author, time, description, script usage, language version, remarks, etc. Let’s look at the sample code

#!/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()

I won’t explain too much about the script. It basically gets the information and writes it into a file. No more nonsense. This script is simple enough. Let’s do it last. Take a look at the generated results:

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

Summary

Everyone think about it, if every There is this basic information in front of each script. It will look much clearer. Finally, I hope this script can bring some help to everyone. Of course, if you have any questions, you can leave a message to communicate. Thank you for your support to the PHP Chinese website.

For more articles related to Python's automatic addition of script header information, please pay attention to the PHP Chinese website!