Add flake8 checks (#30)

* Fix blank lines and whitespace

* Add flake8 configuration

* Add flake8 to style CI

Author: jleonatti

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+# To be added once code is refactored: E501, W291, W293, F401
+select = W191, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, F403
+count = True
+max-complexity = 10
+max-line-length = 100
+statistics = True

.github/workflows/style.yml

@@ -16,7 +16,14 @@ jobs:
         with:
           python-version: 3.8
 
-      - name: Style
+      - name: Install style requirements
         run: |
           pip install -r requirements_style.txt --disable-pip-version-check
-          make
+
+      - name: Codespell
+        run: |
+          make codespell
+
+      - name: flake8
+        run: |
+          make flake8

Makefile

@@ -12,22 +12,26 @@ codespell:
 	@echo "Running codespell"
 	@codespell $(CODESPELL_DIRS) -S $(CODESPELL_SKIP) -I $(CODESPELL_IGNORE)
 
+flake8:
+	@echo "Running flake8"
+	@flake8 .
+
 pydocstyle:
 	@echo "Running pydocstyle"
-	@pydocstyle ansys.mapdl
+	@pydocstyle ansys.dpf.post
 
 doctest-modules:
 	@echo "Runnnig module doctesting"
-	pytest -v --doctest-modules ansys.mapdl
+	pytest -v --doctest-modules ansys.dpf.post
 
 coverage:
 	@echo "Running coverage"
-	@pytest -v --cov ansys.mapdl
+	@pytest -v --cov ansys.dpf.post
 
 coverage-xml:
 	@echo "Reporting XML coverage"
-	@pytest -v --cov ansys.mapdl --cov-report xml
+	@pytest -v --cov ansys.dpf.post --cov-report xml
 
 coverage-html:
 	@echo "Reporting HTML coverage"
-	@pytest -v --cov ansys.mapdl --cov-report html
+	@pytest -v --cov ansys.dpf.post --cov-report html

ansys/dpf/post/dpf_solution.py

@@ -64,7 +64,7 @@ def _check_nodal_location(self, **kwargs):
 
     def __str__(self):
         txt = '%s solution object.' % self._model.metadata.result_info.analysis_type.capitalize() +\
-        '\n\n\nData Sources\n------------------------------\n'
+              '\n\n\nData Sources\n------------------------------\n'
         ds_str = self._data_sources.__str__()
         txt += ds_str
         txt += "\n\n"
@@ -184,8 +184,7 @@ def has_complex_result(self):
         if (tfq_sup.complex_frequencies == None):
             return False
         return True
-    
-    
+
     def displacement(self, **kwargs):
         """Returns a displacement object from which it is possible to get ResultData.
         
@@ -272,8 +271,7 @@ class DpfThermalSolution(DpfSolution):
     def __init__(self, data_sources, model):
         super().__init__(data_sources, model)
         #self.misc = ThermalMisc(model, data_sources)
-        
-        
+
     def __str__(self):
         txt = super().__str__()
         txt += "\n"

ansys/dpf/post/electric_results.py

@@ -16,7 +16,6 @@ def __init__(self, **kwargs):
         if _AvailableKeywords.element_scoping in kwargs:
             raise Exception("Element scoping is not available with thermal/electric results.")
         self.definition._Definition__element_scoping_locked = True
-            
 
     def __str__(self):
         txt = super().__str__()

ansys/dpf/post/misc_results.py

@@ -127,7 +127,6 @@ def modal_basis(self, **kwargs):
         self._check_nodal_location(**kwargs)
         return self._get_result_data_function_of_operator("ModalBasis", self, self._data_sources, **kwargs)
 
-    
     #element nodal results (get result at nodes or at elements)
     def elemental_stress(self, **kwargs):
         """Returns a elemental_stress result data."""
@@ -339,7 +338,6 @@ def nodal_elastic_strain_energy_density(self, **kwargs):
         self._check_nodal_location(**kwargs)
         return self._get_result_data_function_of_operator("ENL_ELENG", self, self._data_sources, location="Nodal", **kwargs)
 
-    
     #element nodal result (here only elemental result given because the nodal one is given in nodal category)
     def elemental_force(self, **kwargs):
         """Returns a elemental_force result data."""
@@ -352,7 +350,6 @@ def elemental_nodal_force(self, **kwargs):
         self._check_elemnodal_location(**kwargs)
         return self._get_result_data_function_of_operator("ENF", self, self._data_sources, location="ElementalNodal", **kwargs)
 
-    
     #element results
     def elemental_contact_status(self, **kwargs):
         """Returns a elemental_contact_status result data."""
@@ -439,7 +436,6 @@ def elemental_thermal_dissipation_energy(self, **kwargs):
         self._check_elemental_location(**kwargs)
         return self._get_result_data_function_of_operator("ENG_TH", self, self._data_sources, location="Elemental", **kwargs)
 
-
     #special results
     def von_mises_stress(self, **kwargs):
         """von_mises_stress output default location is Nodal. 

ansys/dpf/post/result_data.py

@@ -53,8 +53,7 @@ def __init__(self, operator_name: str, data_sources, model,
                  location, element_scoping, node_scoping, named_selection, time, 
                  grouping, phase, subresult, mapdl_grouping, set, time_scoping)
         self.result_fields_container = None
-             
-            
+        
     def __str__(self):
         self._evaluate_result()
         name = self.result_fields_container[0].name.split("_")
@@ -178,8 +177,7 @@ def get_min_data_at_field(self, field_index: int = 0):
         returns its result (output from pin 0).
         """
         return self._min_max(0).data[field_index]
-    
-    
+
     def _plot_contour_with_vtk_file(self):
         """Plot the contour result on its mesh support. The obtained figure depends on the 
         support (can be a meshed_region or a time_freq_support).
@@ -189,8 +187,7 @@ def _plot_contour_with_vtk_file(self):
         self._evaluate_result()
         pl = DpfPlotter(self._evaluator._model.metadata.meshed_region)
         pl._plot_contour_using_vtk_file(self.result_fields_container)
-        
-    
+
     def plot_contour(self, display_option: str = "time", option_id=1,
                      off_screen=None, notebook=None, **kwargs):
         """Plot the contour result on its mesh support.

ansys/dpf/post/result_evaluation.py

@@ -79,7 +79,7 @@ def __init__(self, operator_name: str, data_sources, model,
             if (grouping == Grouping.by_material) or (grouping == Grouping.by_body):
                 scop_op.inputs.label1.connect("mat")
             elif(grouping == Grouping.by_el_shape):
-                 scop_op.inputs.label1.connect("elshape")            
+                scop_op.inputs.label1.connect("elshape")            
             else:
                 raise Exception("Grouping impossible. Use the keyword argument as: grouping = grouping.by_el_shape, grouping = grouping.by_material...")
             self._result_operator.inputs.mesh_scoping.connect(scop_op.outputs.mesh_scoping)

docs/source/conf.py

@@ -44,15 +44,15 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
-              'sphinx_gallery.gen_gallery',
-              'sphinx.ext.todo',
-              'sphinx.ext.napoleon',
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx_gallery.gen_gallery',
+    'sphinx.ext.todo',
+    'sphinx.ext.napoleon',
 ]
 
 autosummary_generate = True
 
-
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
 
@@ -107,8 +107,6 @@
     #                         "set_plot_theme('document')"),
 }
 
-
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

examples/01-Different-analysis-types/02-modal-analysis.py

@@ -110,4 +110,3 @@
 ###############################################################################
 # **It is also possible to deal with plastic_strain and temperature this way.**
 # The result file must contain those results.
-