Browse Source
This patch enables pylint 1.4.5 checking in netwoking-ovn. Script tools/coding-checks.sh is copied from neutron and adapted for networking-ovn. .pylintrc is also copied from neutron, message options that do not need to be suppressed have been removed and some of remaining options will be removed by code adjustment in separate patches. Change-Id: I9e1612583debb555199b416675eea6685801f04cchanges/65/474965/6
Dong Jun
4 years ago
10 changed files with 178 additions and 8 deletions
@ -0,0 +1,101 @@ |
|||
# The format of this file isn't really documented; just use --generate-rcfile |
|||
[MASTER] |
|||
# Add <file or directory> to the black list. It should be a base name, not a |
|||
# path. You may set this option multiple times. |
|||
ignore=.git,tests |
|||
|
|||
[MESSAGES CONTROL] |
|||
# TODO: This list is copied from neutron, the options which do not need to be |
|||
# suppressed have been already removed, some of the remaining options will be |
|||
# removed by code adjustment. |
|||
disable= |
|||
# "F" Fatal errors that prevent further processing |
|||
import-error, |
|||
# "I" Informational noise |
|||
# "E" Error for important programming issues (likely bugs) |
|||
no-member, |
|||
# "W" Warnings for stylistic problems or minor programming issues |
|||
abstract-method, |
|||
arguments-differ, |
|||
attribute-defined-outside-init, |
|||
broad-except, |
|||
dangerous-default-value, |
|||
fixme, |
|||
global-statement, |
|||
no-init, |
|||
protected-access, |
|||
redefined-builtin, |
|||
redefined-outer-name, |
|||
signature-differs, |
|||
unused-argument, |
|||
unused-import, |
|||
unused-variable, |
|||
useless-super-delegation, |
|||
# "C" Coding convention violations |
|||
bad-continuation, |
|||
invalid-name, |
|||
len-as-condition, |
|||
misplaced-comparison-constant, |
|||
missing-docstring, |
|||
superfluous-parens, |
|||
ungrouped-imports, |
|||
wrong-import-order, |
|||
# "R" Refactor recommendations |
|||
duplicate-code, |
|||
no-else-return, |
|||
no-self-use, |
|||
too-few-public-methods, |
|||
too-many-ancestors, |
|||
too-many-arguments, |
|||
too-many-branches, |
|||
too-many-instance-attributes, |
|||
too-many-lines, |
|||
too-many-locals, |
|||
too-many-public-methods, |
|||
too-many-return-statements, |
|||
too-many-statements |
|||
|
|||
[BASIC] |
|||
# Variable names can be 1 to 31 characters long, with lowercase and underscores |
|||
variable-rgx=[a-z_][a-z0-9_]{0,30}$ |
|||
|
|||
# Argument names can be 2 to 31 characters long, with lowercase and underscores |
|||
argument-rgx=[a-z_][a-z0-9_]{1,30}$ |
|||
|
|||
# Method names should be at least 3 characters long |
|||
# and be lowercased with underscores |
|||
method-rgx=([a-z_][a-z0-9_]{2,}|setUp|tearDown)$ |
|||
|
|||
# Module names matching |
|||
module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ |
|||
|
|||
# Don't require docstrings on tests. |
|||
no-docstring-rgx=((__.*__)|([tT]est.*)|setUp|tearDown)$ |
|||
|
|||
[FORMAT] |
|||
# Maximum number of characters on a single line. |
|||
max-line-length=79 |
|||
|
|||
[VARIABLES] |
|||
# List of additional names supposed to be defined in builtins. Remember that |
|||
# you should avoid to define new builtins when possible. |
|||
additional-builtins= |
|||
|
|||
[CLASSES] |
|||
# List of interface methods to ignore, separated by a comma. |
|||
ignore-iface-methods= |
|||
|
|||
[IMPORTS] |
|||
# Deprecated modules which should not be used, separated by a comma |
|||
deprecated-modules= |
|||
# should use oslo_serialization.jsonutils |
|||
json |
|||
|
|||
[TYPECHECK] |
|||
# List of module names for which member attributes should not be checked |
|||
ignored-modules=six.moves,_MovedItems |
|||
|
|||
[REPORTS] |
|||
# Tells whether to display a full report or only the messages |
|||
reports=no |
|||
|
|||
@ -0,0 +1,66 @@ |
|||
#!/bin/sh |
|||
# This script is copied from neutron and adapted for networking-ovn. |
|||
set -eu |
|||
|
|||
usage () { |
|||
echo "Usage: $0 [OPTION]..." |
|||
echo "Run networking_ovn's coding check(s)" |
|||
echo "" |
|||
echo " -Y, --pylint [<basecommit>] Run pylint check on the entire networking_ovn module or just files changed in basecommit (e.g. HEAD~1)" |
|||
echo " -h, --help Print this usage message" |
|||
echo |
|||
exit 0 |
|||
} |
|||
|
|||
join_args() { |
|||
if [ -z "$scriptargs" ]; then |
|||
scriptargs="$opt" |
|||
else |
|||
scriptargs="$scriptargs $opt" |
|||
fi |
|||
} |
|||
|
|||
process_options () { |
|||
i=1 |
|||
while [ $i -le $# ]; do |
|||
eval opt=\$$i |
|||
case $opt in |
|||
-h|--help) usage;; |
|||
-Y|--pylint) pylint=1;; |
|||
*) join_args;; |
|||
esac |
|||
i=$((i+1)) |
|||
done |
|||
} |
|||
|
|||
run_pylint () { |
|||
local target="${scriptargs:-all}" |
|||
|
|||
if [ "$target" = "all" ]; then |
|||
files="networking_ovn" |
|||
else |
|||
case "$target" in |
|||
*HEAD~[0-9]*) files=$(git diff --diff-filter=AM --name-only $target -- "*.py");; |
|||
*) echo "$target is an unrecognized basecommit"; exit 1;; |
|||
esac |
|||
fi |
|||
|
|||
echo "Running pylint..." |
|||
echo "You can speed this up by running it on 'HEAD~[0-9]' (e.g. HEAD~1, this change only)..." |
|||
if [ -n "${files}" ]; then |
|||
pylint --rcfile=.pylintrc --output-format=colorized ${files} |
|||
else |
|||
echo "No python changes in this commit, pylint check not required." |
|||
exit 0 |
|||
fi |
|||
} |
|||
|
|||
scriptargs= |
|||
pylint=1 |
|||
|
|||
process_options $@ |
|||
|
|||
if [ $pylint -eq 1 ]; then |
|||
run_pylint |
|||
exit 0 |
|||
fi |
|||
Loading…
Reference in new issue