Merge pull request #851 from edx/christina/pep8

Add pylint and pep, with thresholds.

.pep8

+[pep8]
+max-line-length = 120

Makefile

@@ -53,6 +53,8 @@ install: install-wheels install-python install-js install-nltk-data install-test
 quality:
 	jshint openassessment/xblock/static/js/src -c .jshintrc --verbose
 	./node_modules/jscs/bin/jscs openassessment/xblock/static/js/src --verbose
+	./scripts/run-pep8.sh
+	./scripts/run-pylint.sh
 
 test: quality test-python test-js
 

pylintrc

+# ***************************
+# ** DO NOT EDIT THIS FILE **
+# ***************************
+#
+# This file was generated by edx-lint: http://github.com/edx.edx-lint
+#
+# If you want to change this file, you have two choices, depending on whether
+# you want to make a local change that applies only to this repo, or whether
+# you want to make a central change that applies to all repos using edx-lint.
+#
+# LOCAL CHANGE:
+#
+# 1. Edit the local pylintrc_tweaks file to add changes just to this
+#    repo's file.
+#
+# 2. Run:
+#
+#       $ edx_lint write pylintrc
+#
+# 3. This will modify the local file.  Submit a pull request to get it
+#    checked in so that others will benefit.
+#
+#
+# CENTRAL CHANGE:
+#
+# 1. Edit the pylintrc file in the edx-lint repo at
+#    https://github.com/edx/edx-lint/blob/master/edx_lint/files/pylintrc
+#
+# 2. Make a new version of edx_lint, which involves the usual steps of
+#    incrementing the version number, submitting and reviewing a pull
+#    request, and updating the edx-lint version reference in this repo.
+#
+# 3. Install the newer version of edx-lint.
+#
+# 4. Run:
+#
+#       $ edx_lint write pylintrc
+#
+# 5. This will modify the local file.  Submit a pull request to get it
+#    checked in so that others will benefit.
+#
+#
+#
+#
+#
+# STAY AWAY FROM THIS FILE!
+#
+#
+#
+#
+#
+# SERIOUSLY.
+#
+# ------------------------------
+[MASTER]
+ignore = 
+persistent = yes
+load-plugins = edx_lint.pylint,pylint_django,pylint_celery
+
+[MESSAGES CONTROL]
+disable = 
+	locally-disabled,
+	locally-enabled,
+	too-few-public-methods,
+	bad-builtin,
+	star-args,
+	abstract-class-not-used,
+	abstract-class-little-used,
+	no-init,
+	fixme,
+	logging-format-interpolation,
+	too-many-lines,
+	no-self-use,
+	too-many-ancestors,
+	too-many-instance-attributes,
+	too-few-public-methods,
+	too-many-public-methods,
+	too-many-return-statements,
+	too-many-branches,
+	too-many-arguments,
+	too-many-locals,
+	unused-wildcard-import,
+	duplicate-code
+
+[REPORTS]
+output-format = text
+files-output = no
+reports = no
+evaluation = 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+[BASIC]
+bad-functions = map,filter,apply,input
+module-rgx = (([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
+const-rgx = (([A-Z_][A-Z0-9_]*)|(__.*__)|log|urlpatterns)$
+class-rgx = [A-Z_][a-zA-Z0-9]+$
+function-rgx = ([a-z_][a-z0-9_]{2,40}|test_[a-z0-9_]+)$
+method-rgx = ([a-z_][a-z0-9_]{2,40}|setUp|set[Uu]pClass|tearDown|tear[Dd]ownClass|assert[A-Z]\w*|maxDiff|test_[a-z0-9_]+)$
+attr-rgx = [a-z_][a-z0-9_]{2,30}$
+argument-rgx = [a-z_][a-z0-9_]{2,30}$
+variable-rgx = [a-z_][a-z0-9_]{2,30}$
+class-attribute-rgx = ([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
+inlinevar-rgx = [A-Za-z_][A-Za-z0-9_]*$
+good-names = f,i,j,k,db,ex,Run,_,__
+bad-names = foo,bar,baz,toto,tutu,tata
+no-docstring-rgx = __.*__$|test_.+|setUp$|setUpClass$|tearDown$|tearDownClass$|Meta$
+docstring-min-length = -1
+
+[FORMAT]
+max-line-length = 120
+ignore-long-lines = ^\s*(# )?<?https?://\S+>?$
+single-line-if-stmt = no
+no-space-check = trailing-comma,dict-separator
+max-module-lines = 1000
+indent-string = '    '
+
+[MISCELLANEOUS]
+notes = FIXME,XXX,TODO
+
+[SIMILARITIES]
+min-similarity-lines = 4
+ignore-comments = yes
+ignore-docstrings = yes
+ignore-imports = no
+
+[TYPECHECK]
+ignore-mixin-members = yes
+ignored-classes = SQLObject
+unsafe-load-any-extension = yes
+generated-members = 
+	REQUEST,
+	acl_users,
+	aq_parent,
+	objects,
+	DoesNotExist,
+	can_read,
+	can_write,
+	get_url,
+	size,
+	content,
+	status_code,
+	create,
+	build,
+	fields,
+	tag,
+	org,
+	course,
+	category,
+	name,
+	revision,
+	_meta,
+
+[VARIABLES]
+init-import = no
+dummy-variables-rgx = _|dummy|unused|.*_unused
+additional-builtins = 
+
+[CLASSES]
+defining-attr-methods = __init__,__new__,setUp
+valid-classmethod-first-arg = cls
+valid-metaclass-classmethod-first-arg = mcs
+
+[DESIGN]
+max-args = 5
+ignored-argument-names = _.*
+max-locals = 15
+max-returns = 6
+max-branches = 12
+max-statements = 50
+max-parents = 7
+max-attributes = 7
+min-public-methods = 2
+max-public-methods = 20
+
+[IMPORTS]
+deprecated-modules = regsub,TERMIOS,Bastion,rexec
+import-graph = 
+ext-import-graph = 
+int-import-graph = 
+
+[EXCEPTIONS]
+overgeneral-exceptions = Exception
+
+# 3250774073f0697a990686dc27be1c757cd3ca54

requirements/test.txt

@@ -5,8 +5,8 @@ coverage==4.0.2
 django-nose==1.4.1
 mock==1.0.1
 moto==0.3.1
-pep8==1.6.2
-pylint<1.0
+pep8==1.7.0
 
 git+https://github.com/edx/django-pyfs.git@1.0.3#egg=django-pyfs==1.0.3
 git+https://github.com/edx/i18n-tools.git@56f048af9b6868613c14aeae760548834c495011#egg=i18n_tools
+git+https://github.com/edx/edx-lint.git@v0.4.1#egg=edx_lint==0.4.1

scripts/run-pep8.sh

+#!/usr/bin/env bash
+
+MAX_PEP8_VIOLATIONS=230
+
+mkdir -p test/logs
+PEP8_VIOLATIONS=test/logs/pep8.txt
+touch $PEP8_VIOLATIONS
+
+pep8 --config=.pep8 openassessment > $PEP8_VIOLATIONS
+NUM_PEP8_VIOLATIONS=$(cat $PEP8_VIOLATIONS | wc -l)
+
+echo "Found" $NUM_PEP8_VIOLATIONS "pep8 violations, threshold is" $MAX_PEP8_VIOLATIONS
+if [[ $NUM_PEP8_VIOLATIONS > $MAX_PEP8_VIOLATIONS ]]; then
+    cat $PEP8_VIOLATIONS
+    echo "NUMBER OF PEP8 VIOLATIONS ("$NUM_PEP8_VIOLATIONS") EXCEEDED THRESHOLD" $MAX_PEP8_VIOLATIONS
+    exit 1
+fi

scripts/run-pylint.py

+#!/usr/bin/env python
+"""
+Determines the number of pylint violations (note that this includes both warnings and errors).
+If larger than the supplied threshold, emits a status of 1 indicating failure.
+"""
+
+import re
+import sys
+
+
+USAGE = u"{} VIOLATIONS_FILE VIOLATIONS_THRESHOLD"
+
+
+def count_pylint_violations(report_file):
+    """
+    Parses a pylint report line-by-line, and determins the number of pylint violations.
+
+    Taken from https://github.com/edx/edx-platform/blob/master/pavelib/quality.py.
+    """
+    num_violations = 0
+    # An example string:
+    # common/lib/xmodule/xmodule/tests/test_conditional.py:21: [C0111(missing-docstring), DummySystem] Missing docstring
+    # More examples can be found in the unit tests for this method
+    pylint_pattern = re.compile(r".(\d+):\ \[(\D\d+.+\]).")
+
+    for line in report_file:
+        violation_list_for_line = pylint_pattern.split(line)
+        # If the string is parsed into four parts, then we've found a violation. Example of split parts:
+        # test file, line number, violation name, violation details
+        if len(violation_list_for_line) == 4:
+            num_violations += 1
+
+    return num_violations
+
+
+def main():
+    """
+    Main entry point for the script.
+    """
+    if len(sys.argv) < 3:
+        print USAGE.format(sys.argv[0])
+        sys.exit(1)
+
+    try:
+        with open(sys.argv[1]) as violations:
+            num_violations = count_pylint_violations(violations)
+            max_violations = sys.argv[2]
+            print "Found {} pylint violations, threshold is {}".format(num_violations, max_violations)
+            if num_violations > int(max_violations):
+                violations.seek(0)
+                for line in violations:
+                    print line
+                print "NUMBER OF PYLINT VIOLATIONS ({}) EXCEEDED THRESHOLD {}".format(num_violations, max_violations)
+                sys.exit(1)
+    except IOError as ex:
+        print u"Could not open pylint violations file: {}".format(sys.argv[1])
+        print(ex)
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

scripts/run-pylint.sh

+#!/usr/bin/env bash
+
+MAX_PYLINT_VIOLATIONS=609
+
+mkdir -p test/logs
+PYLINT_VIOLATIONS=test/logs/pylint.txt
+touch $PYLINT_VIOLATIONS
+
+pylint --rcfile=pylintrc openassessment --msg-template='"{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}"'> $PYLINT_VIOLATIONS
+./scripts/run-pylint.py $PYLINT_VIOLATIONS $MAX_PYLINT_VIOLATIONS