Homec4science
Diffusion py-licenser (licence_header_only) Browse

py-licenser/licencer.py
b6061cf40126licence_header_only

Last Change
Raw File

licencer.py
View Options

#! /usr/bin/env python
from __future__ import print_function
import os, sys
import re
import datetime
import time
from SvnInfo import SvnInfo
from AuthorBase import AuthorBase
from CopyRightBase import CopyRightBase
class FileTransformer(object):
def seekAuthors(self):
author_list = []
reg = re.compile(
'@author\s+(.*)\s\<?([a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4})',
re.IGNORECASE)
for match in re.finditer(reg, self.header):
author_list.append((match.group(1), match.group(2)))
return author_list
def compareAuthors(self, authors_file, authors_svn):
file_unknown = list()
file_known = set()
for name, e_mail in authors_file:
aut = self.author_base.findByEMail(e_mail)
if aut is None:
file_unknown.append(name)
else:
file_known.add(aut)
svn_unknown = list()
svn_known = set()
for user_name in authors_svn:
aut = self.author_base.findByUserName(user_name)
if aut is None:
svn_unknown.append(user_name)
else:
svn_known.add(aut)
if len(file_known) == 0 and len(svn_known) == 1:
file_known = svn_known
if file_unknown:
self.warn_list.append(
"The following unknown authors appear in the header:")
for author in file_unknown:
self.warn_list.append(" {0}".format(author))
self.warn_list.append(
" add them to the database or they won't be in the final "
"file")
if svn_unknown:
self.warn_list.append(
"The following unknown authors appear in the SVN:")
for author in svn_unknown:
self.warn_list.append(" {0}".format(author))
if file_known - svn_known:
self.warn_list.append(
"The following known authors appear in the header but not the SVN:")
for author in file_known-svn_known:
self.warn_list.append(
" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author))
if svn_known - file_known:
self.warn_list.append(
"The following known authors appear in the SVN but not the header:")
for author in svn_known-file_known:
self.warn_list.append(
" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author))
if not file_known:
self.warn_list.append(
"The file has no author. Add one. According to svn there are"
" {0} candidates:".format(len(svn_known)))
for author in svn_known:
self.warn_list.append(
" {0.first_name} {0.last_name} <{0.e_mail}>".format(author))
return file_known
def splitHeader(self):
if self.ext in (".cc", ".hh", ".h"):
if not re.search("Copyright",self.file_content):
header = ""
body = self.file_content
else:
header, body = re.split("\*/", self.file_content, maxsplit=1)
header = '\n'.join((line for line in header.split('\n') if line.strip()))
return header, body
elif ((os.path.basename(self.filepath) == "CMakeLists.txt") or
(self.ext ==".cmake")):
lines = self.file_content.split('\n')
nb_sep = 0
nb_whitelines = 0
header_lines = list()
while nb_sep < 2:
if lines[0].strip().startswith('#===='):
nb_sep += 1
elif not lines[0].strip():
nb_whitelines += 1
header_lines.append(lines.pop(0))
if nb_whitelines > 0:
self.warn_list.append(
"The header has a blank line or is ill-formed")
return "\n".join(header_lines), "\n".join(lines)
else:
raise Exception(
"I can't handle files with '{0}' extension".format(self.ext))
def generateFile(self):
body = self.splitHeader()[-1].split("\n")
while body and not body[0].strip():
body.pop(0)
return (self.generateHeader() + '\n\n' +
"\n".join(body))
def findBrief(self):
reg = re.compile(
'@brief(.*?)^ ?\S\s+@', re.MULTILINE| re.DOTALL)
matches = [match for match in re.finditer(reg, self.header)]
if len(matches) == 0:
self.brief = raw_input("Please type a brief for file: " + self.filepath+ "\n")
return
if len(matches) > 1:
self.warn_list.append("There's multiple @brief")
self.brief = "\n".join((line for line in
matches[0].group(1).lstrip().split('\n')
if len(line.strip()) > 1))
if not self.brief:
self.brief = raw_input("Please type a brief for file: " + self.filepath+ "\n")
# self.warn_list.append("The @brief is empty")
def saveSections(self):
reg = re.compile('^(.*@section)', re.MULTILINE)
pref = re.search(reg, self.header)
pref = pref.group(1) if pref is not None else ""
reg = re.compile('^.*@section', re.MULTILINE)
licreg = re.compile('LICEN.E')
self.sections = list()
for section in re.split(reg, self.header)[1:]:
if not re.search(licreg, section.split('\n')[0]):
self.sections.append(pref + section)
#if self.sections:
# self.warn_list.append("There's a Description section in the header, edit it manually and separate it from the header")
def generateHeader(self):
if self.ext in (".cc", ".hh", ".h"):
starter = "/**"
prefix = " *"
closer = " */"
force_closer = True
else:
starter = "#==============================================================================="
prefix = "#"
closer = "#==============================================================================="
force_closer = False
new_lines = list()
new_lines.append(starter)
## file name
new_lines.append(prefix + " @file "+os.path.basename(self.filepath))
new_lines.append(prefix)
## authors
for author in self.authors:
new_lines.append(
"{0} @author {1.first_name} {1.last_name} <{1.e_mail}>".format(
prefix, author))
new_lines.append(prefix)
## date
new_lines.append(
"{0} @date {1}".format(
prefix,
datetime.datetime.fromtimestamp(self.svn_info.lastModificationDate()).strftime(
"%a %b %d %H:%M:%S %Y")))
new_lines.append(prefix)
## brief
new_lines.append("{0} @brief {1}".format(prefix, self.brief))
new_lines.append(prefix)
## license
new_lines.append(prefix+ " @section LICENSE")
new_lines.append(prefix)
owners = self.copyright_base.findByDate(self.svn_info.creationDate())
licence_str = ""
for owner in owners:
with open(owner.licence_file) as f:
licence_str += f.read()
for line in licence_str.split("\n"):
new_lines.append("{0}{1}{2}".format(prefix, " " if line else "", line))
## sections
for section in self.sections:
new_lines += section.split('\n')
if force_closer or not self.sections:
new_lines.append(closer)
return "\n".join(new_lines)
def __init__(self, svn_info, copyright_base, author_base):
self.brief = ""
self.svn_info = svn_info
self.copyright_base = copyright_base
self.author_base = author_base
self.filepath = self.svn_info.filepath
garbage, self.ext = os.path.splitext(os.path.basename(self.filepath))
if self.ext == '.in':
self.ext = os.path.splitext(garbage)[1]
if self.ext not in (".cc", ".hh", ".h", ".txt", ".cmake"):
print(
"\nWARNING:\n File {0} has been skipped based on its"
" extension".format(self.filepath))
sys.exit()
self.file_content = ""
self.warn_list = list()
def runCheck(self):
with open(self.filepath) as f:
self.file_content = f.read()
try:
self.header, self.body = self.splitHeader()
except Exception as error:
raise Exception("CRASH: While dealing with file {0}:\n{1}".format(self.filepath, error))
self.authors_header = self.seekAuthors()
self.authors_svn = self.svn_info.getAuthors()
self.authors = self.compareAuthors(self.authors_header, self.authors_svn)
self.findBrief()
self.saveSections()
if self.warn_list:
print("\nWARNING!:")
print(" While dealing with file \n{0} ,\n the following shit happened:\n".format(
self.filepath))
[print(" {0}".format(warning)) for warning in self.warn_list]
print("{0}:1:".format(self.filepath))
def replaceFile(self):
with open(self.filepath, "w") as fh:
print(self.generateFile(), file=fh, end='')
##print(self.generateFile(),"TOTO", sep='')
if __name__ == "__main__":
if len(sys.argv) not in (4,5):
print ("usage: licencer.py filename copyrightbase authorbase [force]")
sys.exit(1)
if len(sys.argv) == 5 and sys.argv[4] == "force":
force = True
else:
force = False
svninfo = SvnInfo(sys.argv[1])
copyright_base = CopyRightBase(sys.argv[2])
author_base = AuthorBase(sys.argv[3])
# try:
ft = FileTransformer(svninfo, copyright_base, author_base)
ft.runCheck()
if force:
ft.replaceFile()
# except Exception as error:
# raise Exception("CRASH: While dealing with file {0}:\n{1}".format(sys.argv[1], error))
c4science · Help