-
Notifications
You must be signed in to change notification settings - Fork 171
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add some pre-commit check items. #8
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5e506aa
Add configuration for pre-commit and travis CI.
pkuyym b8a8963
Add copyright hook and keep clang-format consistent with PaddlePaddle.
pkuyym df7dd8f
Add yapf style and clang-format checking.
pkuyym 3e333da
Add setup.sh and remove clang-format.
pkuyym File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
from __future__ import absolute_import | ||
from __future__ import print_function | ||
from __future__ import unicode_literals | ||
|
||
import argparse | ||
import io, re | ||
import sys, os | ||
import subprocess | ||
import platform | ||
|
||
COPYRIGHT = ''' | ||
Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserved. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
''' | ||
|
||
LANG_COMMENT_MARK = None | ||
|
||
NEW_LINE_MARK = None | ||
|
||
COPYRIGHT_HEADER = None | ||
|
||
if platform.system() == "Windows": | ||
NEW_LINE_MARK = "\r\n" | ||
else: | ||
NEW_LINE_MARK = '\n' | ||
COPYRIGHT_HEADER = COPYRIGHT.split(NEW_LINE_MARK)[1] | ||
p = re.search('(\d{4})', COPYRIGHT_HEADER).group(0) | ||
process = subprocess.Popen(["date", "+%Y"], stdout=subprocess.PIPE) | ||
date, err = process.communicate() | ||
date = date.decode("utf-8").rstrip("\n") | ||
COPYRIGHT_HEADER = COPYRIGHT_HEADER.replace(p, date) | ||
|
||
|
||
def generate_copyright(template, lang='C'): | ||
if lang == 'Python': | ||
LANG_COMMENT_MARK = '#' | ||
else: | ||
LANG_COMMENT_MARK = "//" | ||
|
||
lines = template.split(NEW_LINE_MARK) | ||
BLANK = " " | ||
ans = LANG_COMMENT_MARK + BLANK + COPYRIGHT_HEADER + NEW_LINE_MARK | ||
for lino, line in enumerate(lines): | ||
if lino == 0 or lino == 1 or lino == len(lines) - 1: continue | ||
if len(line) == 0: | ||
BLANK = "" | ||
else: | ||
BLANK = " " | ||
ans += LANG_COMMENT_MARK + BLANK + line + NEW_LINE_MARK | ||
|
||
return ans + "\n" | ||
|
||
|
||
def lang_type(filename): | ||
if filename.endswith(".py"): | ||
return "Python" | ||
elif filename.endswith(".h"): | ||
return "C" | ||
elif filename.endswith(".c"): | ||
return "C" | ||
elif filename.endswith(".hpp"): | ||
return "C" | ||
elif filename.endswith(".cc"): | ||
return "C" | ||
elif filename.endswith(".cpp"): | ||
return "C" | ||
elif filename.endswith(".cu"): | ||
return "C" | ||
elif filename.endswith(".cuh"): | ||
return "C" | ||
elif filename.endswith(".go"): | ||
return "C" | ||
elif filename.endswith(".proto"): | ||
return "C" | ||
else: | ||
print("Unsupported filetype %s", filename) | ||
exit(0) | ||
|
||
|
||
PYTHON_ENCODE = re.compile("^[ \t\v]*#.*?coding[:=][ \t]*([-_.a-zA-Z0-9]+)") | ||
|
||
|
||
def main(argv=None): | ||
parser = argparse.ArgumentParser( | ||
description='Checker for copyright declaration.') | ||
parser.add_argument('filenames', nargs='*', help='Filenames to check') | ||
args = parser.parse_args(argv) | ||
|
||
retv = 0 | ||
for filename in args.filenames: | ||
fd = io.open(filename, encoding="utf-8") | ||
first_line = fd.readline() | ||
second_line = fd.readline() | ||
if "COPYRIGHT (C)" in first_line.upper(): continue | ||
if first_line.startswith("#!") or PYTHON_ENCODE.match( | ||
second_line) != None or PYTHON_ENCODE.match(first_line) != None: | ||
continue | ||
original_contents = io.open(filename, encoding="utf-8").read() | ||
new_contents = generate_copyright( | ||
COPYRIGHT, lang_type(filename)) + original_contents | ||
print('Auto Insert Copyright Header {}'.format(filename)) | ||
retv = 1 | ||
with io.open(filename, 'w') as output_file: | ||
output_file.write(new_contents) | ||
|
||
return retv | ||
|
||
|
||
if __name__ == '__main__': | ||
exit(main()) |
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,6 @@ | ||
.DS_Store | ||
|
||
*~ | ||
|
||
*.pyc | ||
.pydevproject |
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,36 @@ | ||
repos: | ||
- repo: https://github.com/PaddlePaddle/mirrors-yapf.git | ||
sha: 0d79c0c469bab64f7229c9aca2b1186ef47f0e37 | ||
hooks: | ||
- id: yapf | ||
files: (.*\.(py|bzl)|BUILD|.*\.BUILD|WORKSPACE)$ | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
sha: 5bf6c09bfa1297d3692cadd621ef95f1284e33c0 | ||
hooks: | ||
- id: check-added-large-files | ||
- id: check-merge-conflict | ||
- id: check-symlinks | ||
- id: detect-private-key | ||
files: (?!.*paddle)^.*$ | ||
- id: end-of-file-fixer | ||
files: \.md$ | ||
- id: trailing-whitespace | ||
files: \.md$ | ||
- repo: https://github.com/Lucas-C/pre-commit-hooks | ||
sha: v1.0.1 | ||
hooks: | ||
- id: forbid-crlf | ||
files: \.md$ | ||
- id: remove-crlf | ||
files: \.md$ | ||
- id: forbid-tabs | ||
files: \.md$ | ||
- id: remove-tabs | ||
files: \.md$ | ||
- repo: local | ||
hooks: | ||
- id: copyright_checker | ||
name: copyright_checker | ||
entry: python ./.copyright.hook | ||
language: system | ||
files: \.(c|cc|cxx|cpp|cu|h|hpp|hxx|proto|py)$ |
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,3 @@ | ||
[style] | ||
based_on_style = pep8 | ||
column_limit = 80 |
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,34 @@ | ||
language: cpp | ||
cache: ccache | ||
sudo: required | ||
dist: trusty | ||
services: | ||
- docker | ||
os: | ||
- linux | ||
env: | ||
- JOB=PRE_COMMIT | ||
|
||
addons: | ||
apt: | ||
packages: | ||
- git | ||
- python | ||
- python-pip | ||
- python2.7-dev | ||
|
||
before_install: | ||
- sudo pip install -U virtualenv pre-commit pip | ||
- docker pull paddlepaddle/paddle:latest | ||
|
||
script: | ||
- exit_code=0 | ||
- .travis/precommit.sh || exit_code=$(( exit_code | $? )) | ||
- docker run -i --rm -v "$PWD:/py_unittest" paddlepaddle/paddle:latest /bin/bash -c | ||
'cd /py_unittest; sh .travis/unittest.sh' || exit_code=$(( exit_code | $? )) | ||
exit $exit_code | ||
|
||
notifications: | ||
email: | ||
on_success: change | ||
on_failure: always |
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,21 @@ | ||
#!/bin/bash | ||
function abort(){ | ||
echo "Your commit not fit PaddlePaddle code style" 1>&2 | ||
echo "Please use pre-commit scripts to auto-format your code" 1>&2 | ||
exit 1 | ||
} | ||
|
||
trap 'abort' 0 | ||
set -e | ||
cd `dirname $0` | ||
cd .. | ||
export PATH=/usr/bin:$PATH | ||
pre-commit install | ||
|
||
if ! pre-commit run -a ; then | ||
ls -lh | ||
git diff --exit-code | ||
exit 1 | ||
fi | ||
|
||
trap : 0 |
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,29 @@ | ||
#!/bin/bash | ||
|
||
abort(){ | ||
echo "Run unittest failed" 1>&2 | ||
echo "Please check your code" 1>&2 | ||
exit 1 | ||
} | ||
|
||
unittest(){ | ||
cd $1 > /dev/null | ||
if [ -f "setup.sh" ]; then | ||
sh setup.sh | ||
export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH | ||
fi | ||
if [ $? != 0 ]; then | ||
exit 1 | ||
fi | ||
find . -name 'tests' -type d -print0 | \ | ||
xargs -0 -I{} -n1 bash -c \ | ||
'python -m unittest discover -v -s {}' | ||
cd - > /dev/null | ||
} | ||
|
||
trap 'abort' 0 | ||
set -e | ||
|
||
unittest . | ||
|
||
trap : 0 |
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
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,10 @@ | ||
#!/usr/bin/env bash | ||
|
||
# install python dependencies | ||
if [ -f "requirements.txt" ]; then | ||
pip install -r requirements.txt | ||
fi | ||
if [ $? != 0 ]; then | ||
echo "Install python dependencies failed !!!" | ||
exit 1 | ||
fi |
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
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.
2018
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.
@kuke Seems cpp code is necessary, @varunarora please help to confirm it.
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.
@kuke 2016 is only a place-holder, actual year is generated dynamically:
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.
clang-format removed.
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.
Great - yes this is exactly it needs to be dynamically replaced