From a0aafb64c192f2fd56e37b5d3ec9b9f17d60c557 Mon Sep 17 00:00:00 2001 From: Tyler Veness Date: Mon, 20 Dec 2021 12:14:22 -0800 Subject: [PATCH] Support filename in license headers Fixes #223. --- wpiformat/wpiformat/licenseupdate.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/wpiformat/wpiformat/licenseupdate.py b/wpiformat/wpiformat/licenseupdate.py index e87894e..36dcdaf 100644 --- a/wpiformat/wpiformat/licenseupdate.py +++ b/wpiformat/wpiformat/licenseupdate.py @@ -21,10 +21,11 @@ def should_process_file(config_file, name): or name.endswith(".java") ) and not license_regex.search(name) - def __try_regex(self, lines, last_year, license_template): + def __try_regex(self, repo_relative_name, lines, last_year, license_template): """Try finding license with regex of license template. Keyword arguments: + repo_relative_name -- repo-relative filename lines -- lines of file last_year -- last year in copyright range license_template -- license_template string @@ -44,6 +45,7 @@ def __try_regex(self, lines, last_year, license_template): .replace(")", r"\)") .replace("{year}", r"(?P[0-9]+)(-[0-9]+)?") .replace("{padding}", "[ ]*") + .replace("{filename}", "") ) license_rgx = regex.compile(license_rgxstr, regex.M) @@ -135,6 +137,8 @@ def __try_string_search(self, lines, last_year, license_template): def run_pipeline(self, config_file, name, lines): linesep = super().get_linesep(lines) + repo_relative_name = name[len(Task.get_repo_root()) + 1 :] + _, license_template = Config.read_file( os.path.dirname(os.path.abspath(name)), ".styleguide-license" ) @@ -160,7 +164,7 @@ def run_pipeline(self, config_file, name, lines): last_year = str(date.today().year) success, first_year, appendix = self.__try_regex( - lines, last_year, license_template + repo_relative_name, lines, last_year, license_template ) if not success: success, first_year, appendix = self.__try_string_search( @@ -179,6 +183,9 @@ def run_pipeline(self, config_file, name, lines): # Insert copyright year range line = line.replace("{year}", year_range) + # Insert filename + line = line.replace("{filename}", repo_relative_name) + # Insert padding which expands to the 80th column. If there is more # than one padding token, the line may contain fewer than 80 # characters due to rounding during the padding width calculation.