[ci] add check for copyright header #41
Conversation
tijyojwad
force-pushed
the
jdaw/copyright-check
branch
4 times, most recently
from
d94767a
to
4f45d5d
Compare
ci/checks/check_copyright.py
Outdated
| @@ -0,0 +1,169 @@ | |||
| #!/usr/bin/python | |||
ci/checks/check_copyright.py
Outdated
|
|
||
| cpp_exts = {".hpp", ".cpp", ".cu", ".cuh", ".cc", ".h", ".c"} | ||
|
|
||
| cpp_copyright = """/* |
There was a problem hiding this comment.
probably best put an r in front of this string
ci/checks/check_copyright.py
Outdated
| Args: | ||
| f - Path to file | ||
| """ | ||
| if 'Copyright (c)' in open(f).read(): |
There was a problem hiding this comment.
return 'Copyright (c)' in open(f).read() more pythonic
There was a problem hiding this comment.
Also, don't know if you want to just use the regex module to check if the string we have is in there, might make it easier also to replace existing copyright notices etc
ci/checks/check_copyright.py
Outdated
|
|
||
| # Get list of files to check. | ||
| script_dir = os.path.dirname(os.path.realpath(__file__)) | ||
| root_dir = os.path.abspath(os.path.join(script_dir, "../../")) |
There was a problem hiding this comment.
better to use pathlib.
from pathlib import Path
Path('foo').parent
.. will break OS interop
ci/checks/check_copyright.py
Outdated
|
|
||
| # Check/Add headers if need be. | ||
| if (args.add_header): | ||
| map(add_copyright, missing_header_files) |
There was a problem hiding this comment.
a matter of style, but list comprehensions are preferred to map
ci/checks/check_copyright.py
Outdated
|
|
||
| import sys | ||
| import os | ||
| import mmap |
ci/checks/check_copyright.py
Outdated
| import argparse | ||
| import re | ||
| from subprocess import check_output | ||
| from stat import * |
There was a problem hiding this comment.
best to never use import *
ci/checks/check_copyright.py
Outdated
| add optionally copyright header to them. | ||
| """ | ||
|
|
||
| import sys |
There was a problem hiding this comment.
could these imports be sorted alphabetically
ci/checks/check_copyright.py
Outdated
| script_dir = os.path.dirname(os.path.realpath(__file__)) | ||
| root_dir = os.path.abspath(os.path.join(script_dir, "../../")) | ||
| files = get_tracked_files(root_dir) | ||
| files = filter_files(files, "LICENSE|README|data\/|docs\/") |
There was a problem hiding this comment.
this string should be a raw string r"LICENSE|README|data\/|docs\/". Otherwise the \/ character combination can be interpreted as an escape sequence (probably an invalid one) by different tools, editors etc
tijyojwad
force-pushed
the
jdaw/copyright-check
branch
4 times, most recently
from
a971b39
to
6060670
Compare
tijyojwad
force-pushed
the
jdaw/copyright-check
branch
from
5aff485
to
68c3eac
Compare
Add script to check for copyright header Fail CI if copyright headers are missing
tijyojwad
force-pushed
the
jdaw/copyright-check
branch
from
68c3eac
to
23ad564
Compare
Add script to check for copyright header
Fail CI if copyright headers are missing