Clean up pylint warnings in unit tests and update flake8 config (#152)

Adds short descriptions for all the ignored flake8 error codes.
W291 (trailing whitespace) is no longer ignored and F401 (module imported but unused) is only ignored for __init__.py files.

Author: yut23

.flake8

@@ -1,4 +1,20 @@
 [flake8]
 max-line-length = 132
-ignore = E126, E127, E128, E129, E226, E241, E265, E741, F401, F403, F841, W504, W291
-exclude = docs/,lm_combustion,radhydro
+
+# E126: continuation line over-indented for hanging indent
+# E127: continuation line over-indented for visual indent
+# E128: continuation line under-indented for visual indent
+# E129: visually indented line with same indent as next logical line
+# E226: missing whitespace around arithmetic operator
+# E241: multiple spaces after ','
+# E265: block comment should start with '# '
+# E741: do not use variables named 'I', 'O', or 'l'
+# F403: 'from module import *' used; unable to detect undefined names
+# F841: local variable assigned to but never used
+# W504: line break after binary operator
+ignore = E126, E127, E128, E129, E226, E241, E265, E741, F403, F841, W504
+
+# F401: module imported but unused
+per-file-ignores = __init__.py:F401
+
+exclude = docs/

.github/workflows/pylint.yml

@@ -41,5 +41,5 @@ jobs:
         run: pip install .
 
       - name: Validate
-        run: pylint --errors-only pyro pyro/analysis
+        run: pylint --errors-only pyro pyro/analysis pyro/**/tests/*.py
 

logo/logo.py

@@ -8,7 +8,7 @@
  XXX   XXX X     XX  
  X       X           
  X      X            
-"""
+"""  # noqa
 
 
 class LogoGrid:

pyproject.toml

@@ -35,6 +35,7 @@ defining-attr-methods = [
   "__post_init__",
   "initialize",
   "__array_finalize__",
+  "setup_class", "setup_method",  # for tests
 ]
 
 [tool.pylint.FORMAT]

pyro/advection/tests/test_advection.py

@@ -2,16 +2,14 @@
 from pyro.util import runparams
 
 
-class TestSimulation(object):
+class TestSimulation:
     @classmethod
     def setup_class(cls):
         """ this is run once for each class before any tests """
-        pass
 
     @classmethod
     def teardown_class(cls):
         """ this is run once for each class after all tests """
-        pass
 
     def setup_method(self):
         """ this is run before each test """

pyro/advection_nonuniform/tests/test_advection_nonuniform.py

@@ -2,16 +2,14 @@
 from pyro.util import runparams
 
 
-class TestSimulation(object):
+class TestSimulation:
     @classmethod
     def setup_class(cls):
         """ this is run once for each class before any tests """
-        pass
 
     @classmethod
     def teardown_class(cls):
         """ this is run once for each class after all tests """
-        pass
 
     def setup_method(self):
         """ this is run before each test """

pyro/compressible/tests/test_compressible.py

@@ -6,16 +6,14 @@
 from pyro.util import runparams
 
 
-class TestSimulation(object):
+class TestSimulation:
     @classmethod
     def setup_class(cls):
         """ this is run once for each class before any tests """
-        pass
 
     @classmethod
     def teardown_class(cls):
         """ this is run once for each class after all tests """
-        pass
 
     def setup_method(self):
         """ this is run before each test """

pyro/compressible/tests/test_eos.py

@@ -1,4 +1,4 @@
-import pyro.compressible.eos as eos
+from pyro.compressible import eos
 
 
 def test_eos_consistency():

pyro/compressible_rk/tests/test_compressible_rk.py

@@ -2,16 +2,14 @@
 from pyro.util import runparams
 
 
-class TestSimulation(object):
+class TestSimulation:
     @classmethod
     def setup_class(cls):
         """ this is run once for each class before any tests """
-        pass
 
     @classmethod
     def teardown_class(cls):
         """ this is run once for each class after all tests """
-        pass
 
     def setup_method(self):
         """ this is run before each test """

pyro/compressible_sr/tests/test_compressible_sr.py

@@ -7,16 +7,14 @@
 from pyro.util import runparams
 
 
-class TestSimulation(object):
+class TestSimulation:
     @classmethod
     def setup_class(cls):
         """ this is run once for each class before any tests """
-        pass
 
     @classmethod
     def teardown_class(cls):
         """ this is run once for each class after all tests """
-        pass
 
     def setup_method(self):
         """ this is run before each test """