Lint your code

[simon-wacker]

Analyze your code with pylint to make sure it adheres to Python coding standards.

[simon-wacker]

I configured Pylint in .pylintrc and added the GNU Make target lint that can be run with make lint. It still reports many warnings that should be fixed though.

[simon-wacker]

I also added a GNU Make target dead that looks for dead code.

[simon-wacker]

make lint still produces warnings (see below). They should either be fixed or if you do not want to fix them for some reason you can add magic comments on the lines that produce the warnings, for example, # pylint: disable=redefined-outer-name. Disabling warnings should be made with caution though.

************* Module glare.trace
glare/trace.py:71:4: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:78:27: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:84:23: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:89:24: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:98:37: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:98:0: C0103: Function name "_create_non_existing_directories" doesn't conform to '[a-z_][a-z0-9_]{2,30}$' pattern (invalid-name)
glare/trace.py:110:0: R1710: Either all return statements in a function should return an expression, or none of them should. (inconsistent-return-statements)
glare/trace.py:140:4: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:141:4: W0621: Redefining name 'opts' from outer scope (line 286) (redefined-outer-name)
glare/trace.py:142:4: W0621: Redefining name 'radiance_param' from outer scope (line 288) (redefined-outer-name)
glare/trace.py:186:4: C0200: Consider using enumerate instead of iterating with range and len (consider-using-enumerate)
glare/trace.py:198:23: W0621: Redefining name 'opts' from outer scope (line 286) (redefined-outer-name)
glare/trace.py:209:9: W0621: Redefining name 'opts' from outer scope (line 286) (redefined-outer-name)
glare/trace.py:209:15: W0621: Redefining name 'config' from outer scope (line 287) (redefined-outer-name)
glare/trace.py:209:23: W0621: Redefining name 'radiance_param' from outer scope (line 288) (redefined-outer-name)
glare/trace.py:291:11: W0703: Catching too general exception Exception (broad-except)
************* Module docs.conf
docs/conf.py:23:0: W0622: Redefining built-in 'copyright' (redefined-builtin)
docs/conf.py:18:0: C0103: Constant name "master_doc" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:22:0: C0103: Constant name "project" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:23:0: C0103: Constant name "copyright" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:24:0: C0103: Constant name "author" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:27:0: C0103: Constant name "release" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:52:0: C0103: Constant name "autoclass_content" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:61:0: C0103: Constant name "autosummary_generate" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:62:0: C0103: Constant name "napoleon_numpy_docstring" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:63:0: C0103: Constant name "napoleon_use_rtype" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
docs/conf.py:73:0: C0103: Constant name "html_theme" doesn't conform to '(([A-Z_][A-Z0-9_]*)|(__.*__))$' pattern (invalid-name)
************* Module tests.test_trace
tests/test_trace.py:42:4: C0200: Consider using enumerate instead of iterating with range and len (consider-using-enumerate)
tests/test_trace.py:1:0: W0611: Unused import filecmp (unused-import)

-----------------------------------
Your code has been rated at 8.77/10