[Merged by Bors] - ci(scripts/*): linting for copyright, imports, module docstrings, line length #4486
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| import sys | ||
|
|
||
| fns = sys.argv[1:] | ||
|
|
||
| ERR_COP = 0 | ||
| ERR_IMP = 1 | ||
| ERR_MOD = 2 | ||
|
|
||
| exceptions = [] | ||
|
|
||
| with open("scripts/copy-mod-doc-exceptions-short.txt") as f: | ||
| lines = f.readlines() | ||
| for line in lines: | ||
| (fn, c, errno) = line.split() | ||
jcommelin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if errno == "ERR_COP": | ||
| exceptions += [(ERR_COP, fn)] | ||
| if errno == "ERR_IMP": | ||
| exceptions += [(ERR_IMP, fn)] | ||
| if errno == "ERR_MOD": | ||
| exceptions += [(ERR_MOD, fn)] | ||
|
|
||
| new_exceptions = False | ||
|
|
||
| def import_only_check(lines, fn): | ||
| import_only_file = True | ||
| errors = [] | ||
| line_nr = 0 | ||
| in_comment = False | ||
| for line_nr, line in enumerate(lines, 1): | ||
| if "/-" in line: | ||
| in_comment = True | ||
| if "-/" in line: | ||
| in_comment = False | ||
| continue | ||
| if line == "\n" or in_comment: | ||
| continue | ||
| imports = line.split() | ||
| if imports[0] == "--": | ||
| continue | ||
| if imports[0] != "import": | ||
| import_only_file = False | ||
| break | ||
| if len(imports) > 2: | ||
| if imports[2] == "--": | ||
| continue | ||
| else: | ||
| errors += [(ERR_IMP, line_nr, fn)] | ||
| return (import_only_file, errors) | ||
|
|
||
| def regular_check(lines, fn): | ||
| errors = [] | ||
| copy_started = False | ||
| copy_done = False | ||
| copy_start_line_nr = 0 | ||
| copy_lines = "" | ||
| for line_nr, line in enumerate(lines, 1): | ||
| if not copy_started and line == "\n": | ||
| errors += [(ERR_COP, copy_start_line_nr, fn)] | ||
| continue | ||
| if not copy_started and line == "/-\n": | ||
| copy_started = True | ||
| copy_start_line_nr = line_nr | ||
| continue | ||
| if not copy_started: | ||
| errors += [(ERR_COP, line_nr, fn)] | ||
| if copy_started and not copy_done: | ||
| copy_lines += line | ||
| if line == "-/\n": | ||
| if ((not "Copyright" in copy_lines) or | ||
| (not "Apache" in copy_lines) or | ||
| (not "Author" in copy_lines)): | ||
| errors += [(ERR_COP, copy_start_line_nr, fn)] | ||
| copy_done = True | ||
| continue | ||
| if copy_done and line == "\n": | ||
| continue | ||
| words = line.split() | ||
| if words[0] != "import" and words[0] != "/-!": | ||
| errors += [(ERR_MOD, line_nr, fn)] | ||
| break | ||
| if words[0] == "/-!": | ||
| break | ||
| # final case: words[0] == "import" | ||
| if len(words) > 2: | ||
| if words[2] != "--": | ||
| errors += [(ERR_IMP, line_nr, fn)] | ||
| return errors | ||
|
|
||
| def format_errors(errors): | ||
| global new_exceptions | ||
| for (errno, line_nr, fn) in errors: | ||
| if (errno, fn) in exceptions: | ||
| continue | ||
| new_exceptions = True | ||
| # filename first, then line so that we can call "sort" on the output | ||
| if errno == ERR_COP: | ||
| print("{} : line {} : ERR_COP : Malformed or missing copyright header".format(fn, line_nr)) | ||
| if errno == ERR_IMP: | ||
| print("{} : line {} : ERR_IMP : More than one file imported per line".format(fn, line_nr)) | ||
| if errno == ERR_MOD: | ||
| print("{} : line {} : ERR_MOD : Module docstring missing, or too late".format(fn, line_nr)) | ||
|
|
||
| def lint(fn): | ||
| with open(fn) as f: | ||
| lines = f.readlines() | ||
| (b, errs) = import_only_check(lines, fn) | ||
| if b: | ||
| format_errors(errs) | ||
| return | ||
| errs = regular_check(lines, fn) | ||
| format_errors(errs) | ||
|
|
||
| for fn in fns: | ||
| lint(fn) | ||
|
|
||
| # if "exceptions" is empty, | ||
| # we're trying to generate copy-mod-doc-exceptions.txt, | ||
| # so new exceptions are expected | ||
| if new_exceptions and len(exceptions) > 0: | ||
| exit(1) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # This is a little wrapper around the python script | ||
| # lint-copy-mod-doc.py | ||
|
|
||
| touch scripts/copy-mod-doc-exceptions.txt | ||
|
|
||
| cut -d: -f1,3 < scripts/copy-mod-doc-exceptions.txt > scripts/copy-mod-doc-exceptions-short.txt | ||
|
|
||
| find src archive -name '*.lean' | xargs ./scripts/lint-copy-mod-doc.py | ||
|
|
||
| rm scripts/copy-mod-doc-exceptions-short.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # This is a little wrapper around the python script | ||
| # lint-copy-mod-doc.py | ||
|
|
||
| # we want an empty "exceptions" array in lint-copy-mod-doc.py | ||
| > scripts/copy-mod-doc-exceptions-short.txt | ||
|
|
||
| find src archive -name '*.lean' | xargs ./scripts/lint-copy-mod-doc.py | sort > scripts/copy-mod-doc-exceptions.txt | ||
|
There was a problem hiding this comment. I appreciate the creative use of the There was a problem hiding this comment. It should be be fine. I don't know if the shell guarantees to open the file before launching the subprocesses, but even if it doesn't There was a problem hiding this comment. Hmm, it looks like the |
||
|
|
||
| rm scripts/copy-mod-doc-exceptions-short.txt | ||
jcommelin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not unhappy with the change, but it's completely unrelated, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, Bryan mentioned a link to a GH blog post about some vulnerability that is fixed by this change.