Supply a full list of pylint warnings that edX cares about, with rationales supplied

edx_lint/cmd/write.py

@@ -106,7 +106,7 @@ def write_main(argv):
     # pkg_resources always reads binary data (in both python2 and python3).
     # ConfigParser.read_string only exists in python3, so we have to wrap the string
     # from pkg_resources in a cStringIO so that we can pass it into ConfigParser.readfp.
-    cfg.readfp(cStringIO(resource_string), resource_name)   # pylint: disable=deprecated-method
+    cfg.readfp(cStringIO(resource_string), resource_name)  # pylint: disable=deprecated-method
 
     if os.path.exists(tweaks_name):
         print("Applying local tweaks from %s" % tweaks_name)

edx_lint/files/pylintrc

@@ -24,7 +24,227 @@ load-plugins=edx_lint.pylint,pylint_django,pylint_celery
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time. See also the "--disable" option for examples.
-#enable=
+enable=
+    # These are controlled by explicit choices in the pylintrc files
+    blacklisted-name,
+    line-too-long,
+
+    # These affect the correctness of the code
+    syntax-error,
+    init-is-generator,
+    return-in-init,
+    function-redefined,
+    not-in-loop,
+    return-outside-function,
+    yield-outside-function,
+    return-arg-in-generator,
+    nonexistent-operator,
+    duplicate-argument-name,
+    abstract-class-instantiated,
+    bad-reversed-sequence,
+    continue-in-finally,
+    method-hidden,
+    access-member-before-definition,
+    no-method-argument,
+    no-self-argument,
+    invalid-slots-object,
+    assigning-non-slot,
+    invalid-slots,
+    inherit-non-class,
+    inconsistent-mro,
+    duplicate-bases,
+    non-iterator-returned,
+    unexpected-special-method-signature,
+    invalid-length-returned,
+    import-error,
+    used-before-assignment,
+    undefined-variable,
+    undefined-all-variable,
+    invalid-all-object,
+    no-name-in-module,
+    unbalance-tuple-unpacking,
+    unpacking-non-sequence,
+    bad-except-order,
+    raising-bad-type,
+    misplaced-bare-raise,
+    raising-non-exception,
+    nonimplemented-raised,
+    catching-non-exception,
+    slots-on-old-class,
+    super-on-old-class,
+    bad-super-call,
+    missing-super-argument,
+    no-member,
+    not-callable,
+    assignment-from-no-return,
+    no-value-for-parameter,
+    too-many-function-args,
+    unexpected-keyword-arg,
+    redundant-keyword-arg,
+    invalid-sequence-index,
+    invalid-slice-index,
+    assignment-from-none,
+    not-context-manager,
+    invalid-unary-operand-type,
+    unsupported-binary-operation,
+    repeated-keyword,
+    not-an-iterable,
+    not-a-mapping,
+    unsupported-membership-test,
+    unsubscriptable-object,
+    logging-unsupported-format,
+    logging-too-many-args,
+    logging-too-few-args,
+    bad-format-character,
+    truncated-format-string,
+    mixed-fomat-string,
+    format-needs-mapping,
+    missing-format-string-key,
+    too-many-format-args,
+    too-few-format-args,
+    bad-str-strip-call,
+    model-unicode-not-callable,
+    super-method-not-called,
+    non-parent-method-called,
+    test-inherits-tests,
+    translation-of-non-string,
+    redefined-variable-type,
+    cyclical-import,
+    unreachable,
+    dangerous-default-value,
+    pointless-statement,
+    pointless-string-statement,
+    expression-not-assigned,
+    duplicate-key,
+    confusing-with-statement,
+    using-constant-test,
+    lost-exception,
+    assert-on-tuple,
+    attribute-defined-outside-init,
+    bad-staticmethod-argument,
+    arguments-differ,
+    signature-differs,
+    abstract-method,
+    super-init-not-called,
+    relative-import,
+    import-self,
+    misplaced-future,
+    invalid-encoded-data,
+    global-variable-undefined,
+    redefined-outer-name,
+    redefined-builtin,
+    redefined-in-handler,
+    undefined-loop-variable,
+    cell-var-from-loop,
+    duplicate-except,
+    nonstandard-exception,
+    binary-op-exception,
+    property-on-old-class,
+    bad-format-string-key,
+    unused-format-string-key,
+    bad-format-string,
+    missing-format-argument-key,
+    unused-format-string-argument,
+    format-combined-specification,
+    missing-format-attribute,
+    invalid-format-index,
+    anomalous-backslash-in-string,
+    anomalous-unicode-escape-in-string,
+    bad-open-mode,
+    boolean-datetime,
+
+    # Checking failed for some reason
+    fatal,
+    astroid-error,
+    parse-error,
+    method-check-failed,
+    django-not-available,
+    raw-checker-failed,
+    django-not-available-placeholder,
+
+    # Documentation is important
+    empty-docstring,
+    invalid-characters-in-docstring,
+    missing-docstring,
+    wrong-spelling-in-comment,
+    wrong-spelling-in-docstring,
+
+    # Unused code should be deleted
+    unused-import,
+    unused-variable,
+    unused-argument,
+
+    # These are dangerous!
+    exec-used,
+    eval-used,
+
+    # These represent idiomatic python. Not adhering to them
+    # will raise red flags with future readers.
+    bad-classmethod-argument,
+    bad-mcs-classmethod-argument,
+    bad-mcs-method-argument,
+    bad-whitespace,
+    consider-iterating-dictionary,
+    consider-using-enumerate,
+    literal-used-as-attribute,
+    multiple-imports,
+    multiple-statements,
+    old-style-class,
+    simplifiable-range,
+    singleton-comparison,
+    superfluous-parens,
+    unidiomatic-typecheck,
+    unneeded-not,
+    wrong-assert-type,
+    simplifiable-if-statement,
+    no-classmethod-decorator,
+    no-staticmethod-decorator,
+    unnecessary-pass,
+    unnecessary-lambda,
+    useless-else-on-loop,
+    unnecessary-semicolon,
+    reimported,
+    global-variable-not-assigned,
+    global-at-module-level,
+    bare-except,
+    broad-except,
+    logging-not-lazy,
+    redundant-unittest-assert,
+    model-missing-unicode,
+    model-has-unicode,
+    model-no-explicit-unicode,
+    protected-access,
+
+    # Don't use things that are deprecated
+    deprecated-module,
+    deprecated-method,
+
+    # These help manage code complexity
+    too-many-nested-blocks,
+    too-many-statements,
+    too-many-boolean-expressions,
+
+    # Consistent import order makes finding where code is
+    # imported from easier
+    ungrouped-imports,
+    wrong-import-order,
+    wrong-import-position,
+    wildcard-import,
+
+    # These should be auto-fixed by any competent editor
+    missing-final-newline,
+    mixed-line-endings,
+    trailing-newlines,
+    trailing-whitespace,
+    unexpected-line-ending-format,
+    mixed-indentation,
+
+    # These attempt to limit pylint line-noise
+    bad-option-value,
+    unrecognized-inline-option,
+    useless-suppression,
+    bad-inline-option,
+    deprecated-pragma,
 
 # Disable the message, report, category or checker with the given id(s). You
 # can either give multiple identifiers separated by comma (,) or put this
@@ -36,28 +256,88 @@ load-plugins=edx_lint.pylint,pylint_django,pylint_celery
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 disable=
+    # These should be left to the discretion of the reviewer
+    bad-continuation,
+    invalid-name,
+    misplaced-comparison-constant,
+    too-many-lines,
+    file-ignored,
+    bad-indentation,
+    lowercase-l-suffix,
+    unused-wildcard-import,
+    global-statement
+
+    # This is specific to python3 compatibility
+    long-suffix,
+    reload-builtin,
+
+    # These are disabled by pylint by default
+    apply-builtin,
+    backtick,
+    basestring-builtin,
+    buffer-builtin,
+    cmp-builtin,
+    cmp-method,
+    coerce-builtin,
+    coerce-method,
+    delslice-method,
+    dict-iter-method,
+    dict-view-method,
+    duplicate-code,
+    execfile-builtin,
+    file-builtin,
+    filter-builtin-not-iterating,
+    fixme,
+    getslice-method,
+    hex-method,
+    import-star-module-level,
+    indexing-exception,
+    input-builtin,
+    intern-builtin,
     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,
+    long-builtin,
+    long-suffix,
+    map-builtin-not-iterating,
+    metaclass-assignment,
+    next-method-called,
+    no-absolute-import,
+    no-init,
     no-self-use,
+    nonzero-method,
+    oct-method,
+    old-division,
+    old-ne-operator,
+    old-octal-literal,
+    old-raise-syntax,
+    parameter-unpacking,
+    print-statement,
+    raising-string,
+    range-builtin-not-iterating,
+    raw_input-builtin,
+    reduce-builtin,
+    reload-builtin,
+    round-builtin,
+    setslice-method,
+    standarderror-builtin,
+    suppressed-message,
+    too-few-public-methods,
     too-many-ancestors,
+    too-many-arguments,
+    too-many-branches,
     too-many-instance-attributes,
-    too-few-public-methods,
+    too-many-lines,
+    too-many-locals,
     too-many-public-methods,
     too-many-return-statements,
-    too-many-branches,
-    too-many-arguments,
-    too-many-locals,
-    unused-wildcard-import,
-    duplicate-code
+    unichr-builtin,
+    unicode-builtin,
+    unpacking-in-except,
+    using-cmp-argument,
+    xrange-builtin,
+    zip-builtin-not-iterating,
+
 
 
 [REPORTS]

edx_lint/pylint/super_check.py

@@ -87,7 +87,6 @@ class UnitTestSetupSuperChecker(BaseChecker):
                 # base = super()
                 # base.__init__(...)
 
-                # pylint: disable=protected-access
                 if (isinstance(klass, astroid.Instance) and
                         isinstance(klass._proxied, astroid.Class) and
                         utils.is_builtin_object(klass._proxied) and

pylintrc

@@ -55,32 +55,291 @@
 [MASTER]
 ignore = ,input
 persistent = yes
-load-plugins = edx_lint.pylint,pylint_django,pylint_celery
+load-plugins = edx_lint.pylint
 
 [MESSAGES CONTROL]
+enable = 
+	blacklisted-name,
+	line-too-long,
+	
+	syntax-error,
+	init-is-generator,
+	return-in-init,
+	function-redefined,
+	not-in-loop,
+	return-outside-function,
+	yield-outside-function,
+	return-arg-in-generator,
+	nonexistent-operator,
+	duplicate-argument-name,
+	abstract-class-instantiated,
+	bad-reversed-sequence,
+	continue-in-finally,
+	method-hidden,
+	access-member-before-definition,
+	no-method-argument,
+	no-self-argument,
+	invalid-slots-object,
+	assigning-non-slot,
+	invalid-slots,
+	inherit-non-class,
+	inconsistent-mro,
+	duplicate-bases,
+	non-iterator-returned,
+	unexpected-special-method-signature,
+	invalid-length-returned,
+	import-error,
+	used-before-assignment,
+	undefined-variable,
+	undefined-all-variable,
+	invalid-all-object,
+	no-name-in-module,
+	unbalance-tuple-unpacking,
+	unpacking-non-sequence,
+	bad-except-order,
+	raising-bad-type,
+	misplaced-bare-raise,
+	raising-non-exception,
+	nonimplemented-raised,
+	catching-non-exception,
+	slots-on-old-class,
+	super-on-old-class,
+	bad-super-call,
+	missing-super-argument,
+	no-member,
+	not-callable,
+	assignment-from-no-return,
+	no-value-for-parameter,
+	too-many-function-args,
+	unexpected-keyword-arg,
+	redundant-keyword-arg,
+	invalid-sequence-index,
+	invalid-slice-index,
+	assignment-from-none,
+	not-context-manager,
+	invalid-unary-operand-type,
+	unsupported-binary-operation,
+	repeated-keyword,
+	not-an-iterable,
+	not-a-mapping,
+	unsupported-membership-test,
+	unsubscriptable-object,
+	logging-unsupported-format,
+	logging-too-many-args,
+	logging-too-few-args,
+	bad-format-character,
+	truncated-format-string,
+	mixed-fomat-string,
+	format-needs-mapping,
+	missing-format-string-key,
+	too-many-format-args,
+	too-few-format-args,
+	bad-str-strip-call,
+	model-unicode-not-callable,
+	super-method-not-called,
+	non-parent-method-called,
+	test-inherits-tests,
+	translation-of-non-string,
+	redefined-variable-type,
+	cyclical-import,
+	unreachable,
+	dangerous-default-value,
+	pointless-statement,
+	pointless-string-statement,
+	expression-not-assigned,
+	duplicate-key,
+	confusing-with-statement,
+	using-constant-test,
+	lost-exception,
+	assert-on-tuple,
+	attribute-defined-outside-init,
+	bad-staticmethod-argument,
+	arguments-differ,
+	signature-differs,
+	abstract-method,
+	super-init-not-called,
+	relative-import,
+	import-self,
+	misplaced-future,
+	invalid-encoded-data,
+	global-variable-undefined,
+	redefined-outer-name,
+	redefined-builtin,
+	redefined-in-handler,
+	undefined-loop-variable,
+	cell-var-from-loop,
+	duplicate-except,
+	nonstandard-exception,
+	binary-op-exception,
+	property-on-old-class,
+	bad-format-string-key,
+	unused-format-string-key,
+	bad-format-string,
+	missing-format-argument-key,
+	unused-format-string-argument,
+	format-combined-specification,
+	missing-format-attribute,
+	invalid-format-index,
+	anomalous-backslash-in-string,
+	anomalous-unicode-escape-in-string,
+	bad-open-mode,
+	boolean-datetime,
+	
+	fatal,
+	astroid-error,
+	parse-error,
+	method-check-failed,
+	django-not-available,
+	raw-checker-failed,
+	django-not-available-placeholder,
+	
+	empty-docstring,
+	invalid-characters-in-docstring,
+	missing-docstring,
+	wrong-spelling-in-comment,
+	wrong-spelling-in-docstring,
+	
+	unused-import,
+	unused-variable,
+	unused-argument,
+	
+	exec-used,
+	eval-used,
+	
+	bad-classmethod-argument,
+	bad-mcs-classmethod-argument,
+	bad-mcs-method-argument,
+	bad-whitespace,
+	consider-iterating-dictionary,
+	consider-using-enumerate,
+	literal-used-as-attribute,
+	multiple-imports,
+	multiple-statements,
+	old-style-class,
+	simplifiable-range,
+	singleton-comparison,
+	superfluous-parens,
+	unidiomatic-typecheck,
+	unneeded-not,
+	wrong-assert-type,
+	simplifiable-if-statement,
+	no-classmethod-decorator,
+	no-staticmethod-decorator,
+	unnecessary-pass,
+	unnecessary-lambda,
+	useless-else-on-loop,
+	unnecessary-semicolon,
+	reimported,
+	global-variable-not-assigned,
+	global-at-module-level,
+	bare-except,
+	broad-except,
+	logging-not-lazy,
+	redundant-unittest-assert,
+	model-missing-unicode,
+	model-has-unicode,
+	model-no-explicit-unicode,
+	protected-access,
+	
+	deprecated-module,
+	deprecated-method,
+	
+	too-many-nested-blocks,
+	too-many-statements,
+	too-many-boolean-expressions,
+	
+	ungrouped-imports,
+	wrong-import-order,
+	wrong-import-position,
+	wildcard-import,
+	
+	missing-final-newline,
+	mixed-line-endings,
+	trailing-newlines,
+	trailing-whitespace,
+	unexpected-line-ending-format,
+	mixed-indentation,
+	
+	bad-option-value,
+	unrecognized-inline-option,
+	useless-suppression,
+	bad-inline-option,
+	deprecated-pragma,
 disable = 
+	bad-continuation,
+	invalid-name,
+	misplaced-comparison-constant,
+	file-ignored,
+	bad-indentation,
+	lowercase-l-suffix,
+	unused-wildcard-import,
+	global-statement
+	
+	apply-builtin,
+	backtick,
+	basestring-builtin,
+	buffer-builtin,
+	cmp-builtin,
+	cmp-method,
+	coerce-builtin,
+	coerce-method,
+	delslice-method,
+	dict-iter-method,
+	dict-view-method,
+	duplicate-code,
+	execfile-builtin,
+	file-builtin,
+	filter-builtin-not-iterating,
+	fixme,
+	getslice-method,
+	hex-method,
+	import-star-module-level,
+	indexing-exception,
+	input-builtin,
+	intern-builtin,
 	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,
+	long-builtin,
+	long-suffix,
+	map-builtin-not-iterating,
+	metaclass-assignment,
+	next-method-called,
+	no-absolute-import,
+	no-init,
 	no-self-use,
+	nonzero-method,
+	oct-method,
+	old-division,
+	old-ne-operator,
+	old-octal-literal,
+	old-raise-syntax,
+	parameter-unpacking,
+	print-statement,
+	raising-string,
+	range-builtin-not-iterating,
+	raw_input-builtin,
+	reduce-builtin,
+	reload-builtin,
+	round-builtin,
+	setslice-method,
+	standarderror-builtin,
+	suppressed-message,
+	too-few-public-methods,
 	too-many-ancestors,
+	too-many-arguments,
+	too-many-branches,
 	too-many-instance-attributes,
-	too-few-public-methods,
+	too-many-lines,
+	too-many-locals,
 	too-many-public-methods,
 	too-many-return-statements,
-	too-many-branches,
-	too-many-arguments,
-	too-many-locals,
-	unused-wildcard-import,
-	duplicate-code
+	unichr-builtin,
+	unicode-builtin,
+	unpacking-in-except,
+	using-cmp-argument,
+	xrange-builtin,
+	zip-builtin-not-iterating,
 
 [REPORTS]
 output-format = text
@@ -103,7 +362,7 @@ 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
+docstring-min-length = 5
 
 [FORMAT]
 max-line-length = 120
@@ -180,4 +439,4 @@ int-import-graph =
 [EXCEPTIONS]
 overgeneral-exceptions = Exception
 
-# 6dce538dd71d2e031194c436e3c0a4f25fa4b139
+# 6eb8ad6e6d8cfc8d0aaa08b832cbd7b957662448

pylintrc_tweaks

 # Local tweaks to pylintrc for edx_lint's own code.
 [MASTER]
 ignore+ = ,input
+load-plugins = edx_lint.pylint