feat: migrate to Ruff for code linting and formatting (#1727)

* feat: migrate linters and formaters to Ruff

* fix: code style and spelling

* fix: code style

Author: jorgepiloto

.ci/update_dpf_dependencies.py

@@ -12,6 +12,7 @@
 It will update the current repo
 or the repo defined by the environment variable "ANSYSDPFCORE_ROOT" if it exists.
 """
+
 import os
 import glob
 import pathlib

.flake8

@@ -1,31 +1,28 @@
-exclude: |
-    (?x)^(
-        doc/source/|
-        src/ansys/dpf/core/operators/|
-        examples_notebooks/|
-        src/ansys/dpf/core/__init__.py|
-        doc/styles/|
-        src/ansys/dpf/gate/|
-        src/ansys/dpf/gatebin/|
-        src/ansys/grpc/dpf/|
-    )
+exclude: >
+  (?x)^(
+    doc/source/
+    |src/ansys/dpf/core/operators/
+    |examples_notebooks/
+    |src/ansys/dpf/core/__init__.py
+    |doc/styles/
+    |src/ansys/dpf/gate/
+    |src/ansys/dpf/gatebin/
+    |src/ansys/grpc/dpf/
+  )
 repos:
 
-- repo: https://github.com/psf/black
-  rev: 24.4.2
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.6.3
   hooks:
-  - id: black
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 7.0.0
-  hooks:
-  - id: flake8
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format
 
 - repo: https://github.com/codespell-project/codespell
   rev: v2.3.0
   hooks:
   - id: codespell
-    args: ["--ignore-words=ignore_words.txt"]
+    args: ["--ignore-words=./doc/styles/Vocab/ANSYS/accept.txt"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.6.0
@@ -36,6 +33,6 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.5
+  rev: 0.29.2
   hooks:
-    - id: check-github-workflows
+    - id: check-github-workflows

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ pydocstyle:
 	@pydocstyle ansys.dpf.core
 
 doctest-modules:
-	@echo "Runnnig module doctesting"
+	@echo "Running module doctesting"
 	pytest -v --doctest-modules ansys.dpf.core
 
 coverage:

Makefile

@@ -3,6 +3,7 @@
 Launch or connect to a persistent local DPF service to be shared in
 pytest as a session fixture
 """
+
 import doctest
 from doctest import DocTestRunner
 from unittest import mock

conftest.py

@@ -1,41 +1,50 @@
 ANSYS
-[Aa]nsys
-Abaqus
 APIs
-[Cc]omponentization
-[Cc]ore
+Abaqus
 CPython
 DPF [Ss]erver
 DPFArray
 Entry
+GLTF
 Gaussian
+IronPython
+MSUP
+Mises
+Premium
+Preview License Agreement
+PyDPF
+Pythonic
+Remotable
+Reusability
+Rz
+[Aa]nsys
+[Cc]omponentization
+[Cc]ore
+[Pp]ostprocessing
+[Pp]ython
+[Pp]yvista
+ans
+containter
 getters
 gltf
-GLTF
 grpcio
 hexa
-IronPython
+inpt
+mane
 matplotlib
-Mises
-MSUP
+mecanic
 numpy
+parm
 postprocess
-[Pp]ostprocessing
-Premium
-Preview License Agreement
+pres
 protobuf
 psutil
-PyDPF
-[Pp]ython
-Pythonic
-[Pp]yvista
 recursivity
-Remotable
-Reusability
-Rz
 scopings
 serializer
 setuptools
+socio-economic
 substep
+systyem
 tqdm
-von
+von

doc/styles/Vocab/ANSYS/accept.txt

@@ -9,6 +9,7 @@
 visualize the outputs.
 
 """
+
 # Import the necessary modules
 import matplotlib.pyplot as plt
 import numpy as np

examples/01-transient_analyses/00-basic_transient.py

@@ -8,6 +8,7 @@
 This example shows how to use a model's result to choose a time scoping.
 
 """
+
 import matplotlib.pyplot as plt
 
 from ansys.dpf import core as dpf

examples/01-transient_analyses/01-transient_easy_time_scoping.py

@@ -8,6 +8,7 @@
 using ``fft`` transformations.
 
 """
+
 import matplotlib.pyplot as pyplot
 
 from ansys.dpf import core as dpf

examples/03-harmonic_analyses/00-multi_harmonic.py

@@ -8,6 +8,7 @@
 from a multi-stage cyclic analysis. It also shows how to use the cyclic support
 for advanced postprocessing
 """
+
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 from ansys.dpf.core import operators as ops

examples/04-advanced/00-multistage_advanced_options.py

@@ -11,6 +11,7 @@
 total volume.
 
 """
+
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 from ansys.dpf.core import operators as ops

examples/04-advanced/02-volume_averaged_stress.py

@@ -21,6 +21,7 @@
     For more information, see :ref:`ref_compatibility`.
 
 """
+
 # Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core.core import errors

examples/04-advanced/13-manage_licensing.py

@@ -95,7 +95,7 @@
 res_deser_all_times_list = []
 h5_read_op = dpf.operators.serialization.hdf5dpf_custom_read()
 h5_read_op.inputs.streams.connect(h5_stream_prov_op.outputs)
-h5_read_op.inputs.time_scoping.connect(dpf.Scoping(ids = list(range(1,54)), location="time"))
+h5_read_op.inputs.time_scoping.connect(dpf.Scoping(ids=list(range(1, 54)), location="time"))
 for i, res_name in enumerate(result_names_on_all_time_steps):
     h5_read_op.inputs.result_name.connect(res_name)
     res_deser = h5_read_op.outputs.field_or_fields_container_as_fields_container()

examples/05-file-IO/02-hdf5_serialize_and_read.py

@@ -23,7 +23,7 @@
     screenshot="model_plot.png",
     title="Model",
     text="Model plot off",
-    parallel_projection=True
+    parallel_projection=True,
 )
 
 # Notes:
@@ -81,14 +81,19 @@
 split_mesh_op.connect(7, mesh)
 split_mesh_op.connect(13, "mat")
 meshes_cont = split_mesh_op.get_output(0, dpf.types.meshes_container)
-meshes_cont.plot(title='Meshes Container', text='Meshes Container plot')
+meshes_cont.plot(title="Meshes Container", text="Meshes Container plot")
 # A fields_container can be given as input, with results on each part of our split mesh.
 disp_op = dpf.Operator("U")
 disp_op.connect(7, meshes_cont)
 ds = dpf.DataSources(examples.find_multishells_rst())
 disp_op.connect(4, ds)
 disp_fc = disp_op.outputs.fields_container()
-meshes_cont.plot(disp_fc, title='Meshes Container disp_fc', text='Meshes Container disp_fc plot')
+meshes_cont.plot(disp_fc, title="Meshes Container disp_fc", text="Meshes Container disp_fc plot")
 # Additional PyVista kwargs are supported, such as:
-meshes_cont.plot(off_screen=True, notebook=False, screenshot='meshes_cont_plot.png',
-                 title='Meshes Container', text='Meshes Container plot')
+meshes_cont.plot(
+    off_screen=True,
+    notebook=False,
+    screenshot="meshes_cont_plot.png",
+    title="Meshes Container",
+    text="Meshes Container plot",
+)

examples/06-plotting/00-basic_plotting.py

@@ -131,6 +131,5 @@
 # The three tuples in the list for the ``cpos`` argument represent the camera
 # position, focal point, and view respectively.
 plot.show_figure(
-    show_axes=True,
-    cpos=[(0.123, 0.095, 1.069), (-0.121, -0.149, 0.825), (0.0, 0.0, 1.0)]
+    show_axes=True, cpos=[(0.123, 0.095, 1.069), (-0.121, -0.149, 0.825), (0.0, 0.0, 1.0)]
 )

examples/06-plotting/03-labels.py

@@ -8,6 +8,7 @@
 shown with the arguments available.
 
 """
+
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 

examples/06-plotting/06-animate_results.py

@@ -74,7 +74,6 @@
 
 
 def compute_von_mises_then_average(analysis):
-
     # Create a model from the results of the simulation and retrieve its mesh
     model = dpf.Model(analysis)
     mesh = model.metadata.meshed_region
@@ -112,7 +111,6 @@ def compute_von_mises_then_average(analysis):
 
 
 def average_then_compute_von_mises(analysis):
-
     # Creating the model from the results of the simulation
     model = dpf.Model(analysis)
     mesh = model.metadata.meshed_region
@@ -158,9 +156,7 @@ def average_then_compute_von_mises(analysis):
 print("Max stress when the stress averaging is done first: {:.2f} Pa".format(max2))
 print(
     "The maximum Von Mises stress value is {:.2f}% higher when \
-the averaging is done after the calculations.".format(
-        diff
-    )
+the averaging is done after the calculations.".format(diff)
 )
 
 ###############################################################################

examples/09-averaging/00-compute_and_average.py

@@ -259,9 +259,7 @@ def average_across_bodies(analysis):
 print("Max stress when averaging across bodies is deactivated: {:.2f} Pa".format(max_non_avg))
 print(
     "The maximum stress value when averaging across bodies is PERFORMED \
-is {:.2f}% LOWER than when it is NOT PERFORMED".format(
-        diff
-    )
+is {:.2f}% LOWER than when it is NOT PERFORMED".format(diff)
 )
 
 ###############################################################################

examples/09-averaging/01-average_across_bodies.py

@@ -8,6 +8,7 @@
 can be useful for specific results and for performance.
 
 """
+
 # Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples

examples/10-mesh_operations/05-skin_extraction.py

@@ -16,6 +16,7 @@
 The script below demonstrates the methodology using PyDPF.
 
 """
+
 # Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples

examples/10-mesh_operations/13-nodes_in_local_coordinate_system.py

@@ -80,7 +80,7 @@
 # extract Sx (use component selector and select the first component)
 comp_sel = dpf.operators.logic.component_selector_fc(scyc_op, 0)
 
-# expand the displacements and get the resuls
+# expand the displacements and get the results
 fields = comp_sel.outputs.fields_container()
 
 # plot the expanded result on the expanded mesh
@@ -105,7 +105,7 @@
 # extract Sy (use component selector and select the component 1)
 comp_sel = dpf.operators.logic.component_selector_fc(to_elemental, 1)
 
-# expand the displacements and get the resuls
+# expand the displacements and get the results
 fields = comp_sel.outputs.fields_container()
 
 # # plot the expanded result on the expanded mesh

examples/11-cyclic-symmetry/01-modal_cyclic.py

@@ -9,6 +9,7 @@
 multi-stage cyclic analysis.
 
 """
+
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 

examples/11-cyclic-symmetry/03-cyclic_multi_stage.py

@@ -85,17 +85,21 @@
 
 vec_iso_values = [-153.6, -100.0, -50.0, 50.0, 100.0, 150.0, 200.0, 300.0, 361.8]
 
-iso_surfaces_op = dpf.operators.mesh.iso_surfaces(field=P_S[0], mesh=whole_mesh, slice_surfaces=True,
-                                              vector_iso_values=vec_iso_values)
+iso_surfaces_op = dpf.operators.mesh.iso_surfaces(
+    field=P_S[0], mesh=whole_mesh, slice_surfaces=True, vector_iso_values=vec_iso_values
+)
 
 iso_surfaces_meshes = iso_surfaces_op.outputs.meshes()
 
 iso_surfaces_fields = iso_surfaces_op.outputs.fields_container()
 
 for i in range(len(iso_surfaces_fields)):
     pl.add_field(
-        field=iso_surfaces_fields[i], meshed_region=iso_surfaces_meshes[i], style="surface", show_edges=False,
-        show_axes=True
+        field=iso_surfaces_fields[i],
+        meshed_region=iso_surfaces_meshes[i],
+        style="surface",
+        show_edges=False,
+        show_axes=True,
     )
 
 pl.show_figure(show_axes=True, cpos=c_pos_iso)

examples/12-fluids/03-fluids_isosurface.py

@@ -25,7 +25,7 @@
 # contain information related to Units. In this case, as the simulation was run
 # through Mechanical, a file.actunits file is produced. If this file is
 # supplemented in the data_sources, the units will be correctly fetched for all
-# resuls in the file as well as for the mesh.
+# results in the file as well as for the mesh.
 
 d3plot = examples.download_d3plot_beam()
 ds = dpf.DataSources()