Homec4science
Diffusion py-licenser (master) Browse

py-licenser/pylicenser/file_info.py
3c7dd341bd05master

Last Change
Raw File

file_info.py
View Options

# -*- coding: utf-8 -*-
__author__ = "Guillaume Anciaux, and Nicolas Richart"
__copyright__ = "Copyright (C) 2015, EPFL (Ecole Polytechnique Fédérale de Lausanne) Laboratory " \
"(LSMS - Laboratoire de Simulation en Mécanique des Solides)"
__credits__ = ["Guillaume Anciaux", "Nicolas Richart"]
__license__ = "GPL"
__version__ = "1.0"
__maintainer__ = "Nicolas Richart"
__email__ = "nicolas.richart@epfl.ch"
import os
import re
from datetime import datetime as dt
from . import export
UNKNOWN_TYPE = 0
CPP_SOURCES = 1
CMAKE_FILES = 2
CREATION_MODIFICATION = 0
LAST_MODIFICATION = 1
CREATION = 2
@export
class FileInfo:
__date_style_conv = {'creation_modification': CREATION_MODIFICATION,
'last_modification': LAST_MODIFICATION,
'creation': CREATION}
__supported_ext = []
__supported_types = {CPP_SOURCES: [".cc", ".c", ".hh", ".h"],
CMAKE_FILES: [".txt", ".cmake"]}
_file_type = UNKNOWN_TYPE
_file_content = ""
_warn_list = list()
_brief = ""
_sections = list()
_authors = set()
_header = ""
def __init__(self, filename, author_db):
self._warn_list = list()
self._sections = list()
self._authors = set()
self._author_db = author_db
self._filename = os.path.expanduser(filename)
garbage, self._ext = os.path.splitext(os.path.basename(filename))
if self._ext == '.in':
self._ext = os.path.splitext(garbage)[1]
for key, value in self.__supported_types.items():
self.__supported_ext.extend(value)
if self._ext not in self.__supported_ext:
raise (Exception("File {0} has been skipped based on its extension".format(self._filename)))
for key, value in self.__supported_types.items():
if self._ext in value:
self._file_type = key
self.__analyse_content()
def __analyse_content(self):
with open(self._filename) as f:
self._file_content = f.read()
try:
self.__split_header()
except Exception as error:
raise Exception("While dealing with file {0}:\n{1}".format(self._filename, error))
self.__find_authors()
self.__find_brief()
self.__save_sections()
if self._warn_list:
print("\nWARNING!:")
print(" While dealing with file {0}".format(self._filename))
print(" the following shit happened:")
[print(" {0}".format(warning)) for warning in self._warn_list]
print("{0}:1:".format(self._filename))
def __save_sections(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')
for section in re.split(reg, self._header)[1:]:
if not re.search(licreg, section.split('\n')[0]):
self._sections.append(pref + section)
def __split_header(self):
if not re.search("Copyright", self._file_content):
self._header = ""
self._body = self._file_content
print("This file as no header or a really badly formatted one!!")
else:
if self._file_type == CPP_SOURCES:
self._header, self._body = re.split("\*/", self._file_content, maxsplit=1)
self._header = '\n'.join((line for line in self._header.split('\n') if line.strip()))
elif self._file_type == CMAKE_FILES:
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")
self._header = "\n".join(header_lines)
self._body = "\n".join(lines)
def __find_authors(self):
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):
auth = self._author_db.find_by_email(match.group(2))
if not self._author_db.is_author_in_ignore_list(auth):
self._authors.add(auth)
def __find_brief(self):
if self._file_type == CPP_SOURCES:
prefix = " *"
elif self._file_type == CMAKE_FILES:
prefix = "#"
else:
raise IOError("file type unknown")
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 = ""
return
if len(matches) > 1:
self._warn_list.append("There's multiple @brief")
self._brief = "\n".join((line.replace(prefix, "").strip() for line in
matches[0].group(1).split('\n')
if len(line.strip()) > 1))
def generate_header(self,
real_authors=None,
copyright_txt="",
creation_date=None,
last_modification_date=None,
date_style=CREATION_MODIFICATION,
date_format="%a %b %d %H:%M:%S %Y",
brief=None):
if type(date_style) == str:
# noinspection PyTypeChecker
date_style = self.__date_style_conv[date_style]
if self._file_type == CPP_SOURCES:
starter = "/**"
prefix = " *"
closer = " */"
force_closer = True
elif self._file_type == CMAKE_FILES:
starter = "#==============================================================================="
prefix = "#"
closer = "#==============================================================================="
force_closer = False
else:
raise IOError("file type not recognized")
if real_authors is None:
real_authors = self._authors
new_lines = list()
new_lines.append(starter)
# file name
new_lines.append(prefix + " @file " + os.path.basename(self._filename))
new_lines.append(prefix)
# authors
for author in real_authors:
new_lines.append('{0} @author {1.first_name} {1.last_name} <{1.e_mail}>'.format(prefix, author))
new_lines.append(prefix)
# date
if date_style == CREATION_MODIFICATION and creation_date is not None and last_modification_date is not None:
new_lines.append(
"{0} @date creation: {1}".format(prefix, dt.fromtimestamp(creation_date).strftime(date_format)))
new_lines.append("{0} @date last modification: {1}".format(prefix, dt.fromtimestamp(
last_modification_date).strftime(date_format)))
elif date_style == LAST_MODIFICATION and last_modification_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(last_modification_date).strftime(date_format)))
elif date_style == CREATION and creation_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(creation_date).strftime(date_format)))
elif date_style == LAST_MODIFICATION and last_modification_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(last_modification_date).strftime(date_format)))
elif date_style == CREATION and creation_date is not None:
new_lines.append("{0} @date {1}".format(
prefix,
dt.fromtimestamp(creation_date).strftime(date_format)))
new_lines.append(prefix)
# brief
brief_list = (self._brief
if brief is None else brief).split("\n")
pref_join = ("\n{0} ".format(prefix))
new_lines.append('{0} @brief {1}'.format(prefix, pref_join.join([b for b in brief_list])))
new_lines.append(prefix)
# license
new_lines.append(prefix + " @section LICENSE")
new_lines.append(prefix)
for line in copyright_txt.split("\n"):
new_lines.append('{0}{1}{2}'.format(prefix, " " if line else "", line))
new_lines.append(prefix)
# 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 get_brief(self):
return self._brief
def replace_file(self, new_header=None):
if new_header is None:
new_header = self._header
body = self._body.split("\n")
while body and not body[0].strip():
body.pop(0)
new_file = (new_header + '\n\n' +
'\n'.join(body))
with open(self._filename, "w") as fh:
print(new_file, file=fh, end='')
@property
def authors(self):
return self._authors
c4science · Help