Homec4science
Diffusion py-licenser (licence_header_only) Browse

py-licenser/FileTransformer.py
9f2960d072delicence_header_only

Last Change
Raw File

FileTransformer.py
View Options

#! /usr/bin/env python
# -*- coding: utf-8 -*-
import datetime as dt
try:
from termcolor import colored
except ImportError:
def colored(string, color, **kwargs):
return string
import LicenserDB as ldb
import VersionInfo as vc_info
import FileInfo as f_info
import AuthorDB as adb
import CopyrightDB as cdb
class FileTransformer(object):
__ignore = False
def __init__(self, filename, db, release_date = dt.datetime.now().date(),
no_author_check = False,
no_brief_check = False, **kwargs):
self.__filename = filename
self.__release_date = release_date
self.__db = db
self.__name = vc_info.VersionInfo.getNameFromFilename(self.__filename,
backend = db.getVersioningBackend())
# Check the authors
self.__author_db = adb.AuthorDB(db)
self._vc_info = vc_info.VersionInfo(self.__filename,
backend = self.__db.getVersioningBackend(),
rev_to = release_date)
self._creation_date = self._vc_info.creationDate()
self._file = f_info.FileInfo(self.__filename, self.__author_db)
rev_from = None
license_id = None
file_maj = self.__db.findFile(self._vc_info.oldest_name())
if not file_maj == None:
rev_from, license_id = file_maj
if rev_from.date() >= release_date:
print("File {0} ignored due to recent modifications ({1})".format(self._vc_info.getName(),
colored(rev_from.strftime("%Y-%m-%d"), 'red', attrs=['bold'])))
self.__ignore = True
return
if(not no_author_check):
self._vc_authors = self._vc_info.getAuthors()
self._vc_info.populate(self.__author_db,
rev_to = self.__release_date,
rev_from = rev_from)
self._vc_authors = self._vc_info.getAuthors()
self._f_authors = self._file.getAuthors()
self._real_authors = self.__compareAuthors(self._f_authors,
self._vc_authors,
file_is_good = (not file_maj == None),
**kwargs)
if(self._real_authors - self._f_authors):
print("Added authors:\n{0}".format(
"\n".join(
[" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author)
for author in self._real_authors - self._f_authors])
))
if(self._f_authors - self._real_authors):
print("Removed authors:\n{0}".format(
"\n".join(
[" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author)
for author in self._f_authors - self._real_authors])
))
else:
self._real_authors = self._file.getAuthors()
# Check the brief
if not no_brief_check:
self.__checkBrief(**kwargs)
else:
self._brief = self._file.getBrief()
# Getting the license content
self.__copyright_base = cdb.CopyrightDB(db)
if license_id == None:
copyright_policy = self.__db.getConfig('copyright_policy')
if copyright_policy == 'creation_date':
cdate = self._creation_date
elif copyright_policy == 'release_date':
cdate = self.__release_date
self._lic = self.__copyright_base.findByDate(cdate)
else:
self._lic = self.__copyright_base.findByID(license_id)
# Generates the new header file
self._new_header = self._file.generateHeader(
real_authors = self._real_authors,
copyright_txt = self._lic.text,
date_format = self.__db.getConfig('date_format'),
date_style = self.__db.getConfig('date_style'),
last_modification_date = self._vc_info.lastModificationDate(),
creation_date = self._creation_date,
brief = self._brief)
def __compareAuthors(self, file_known_tmp, vc_known, file_is_good = False,
ignore_threshold = 0, **kwargs):
file_known = file_known_tmp
if len(file_known) == 0 and len(vc_known) == 1:
file_known = vc_known
if not file_is_good:
file_only = file_known - vc_known
to_remove = set()
if file_only:
KEEP = 0
REMOVE = 1
for author in file_only:
answer = ldb.licenser_ask_question(
"Do you want to remove" +
" @author {0.first_name} {0.last_name} <{0.e_mail}>".format(author),
{ 'k': KEEP, 'r': REMOVE }, 'k')
if answer == REMOVE:
to_remove.add(author)
file_known = file_known - to_remove
vc_only = vc_known - file_known
if vc_only:
to_add = set()
YES = 0
NO = 1
DIFF = 2
for author in vc_only:
modifications = self._vc_info.modificationsByAuthor(author.user_name)
number_of_modified_lines = sum([len(e[2]) for e in modifications])
number_of_modifications = len(modifications)
if number_of_modified_lines <= ignore_threshold:
print('Potiential new author' +
' @author {0.first_name} {0.last_name} <{0.e_mail}> '.format(author) +
'({0} modifications, lines count {1}) {2}'.format(number_of_modifications,
number_of_modified_lines,
colored("[ignored do to threshold]",
'red', attrs=['bold'])))
continue
answer = DIFF
while answer == DIFF:
answer = ldb.licenser_ask_question(
'Do you want to add' +
' @author {0.first_name} {0.last_name} <{0.e_mail}> '.format(author) +
'({0} modifications, lines count {1}) '.format(number_of_modifications,
number_of_modified_lines),
{ 'd': DIFF, 'n': NO, 'y': YES }, 'n')
if answer == DIFF:
for info, modif, nb_lines in modifications:
print (info)
print (modif)
elif answer == YES:
to_add.add(author)
file_known = file_known.union(to_add)
return file_known
def __checkBrief(self, ignore_filled_briefs = False, **kwargs):
self._brief = self._file.getBrief()
if(self._brief and not ignore_filled_briefs):
keep_brief = ldb.licenser_ask_question("\"{0}\"\nDo you want to keep this brief".format(self._brief))
if not keep_brief:
self._brief = False
if not self._brief:
res = raw_input("Please type the brief for file: ")
brief = []
while res is not "":
brief.append(res)
res = raw_input("> ")
self._brief = "\n".join(brief)
def replaceFile(self, dry_run = True):
if self.__ignore: return
if dry_run:
print(self._new_header)
else:
self.__db.updateFile(self._vc_info.oldest_name(), self._lic.lid, self.__release_date)
self._file.replaceFile(self._new_header)
c4science · Help