CHORE: Setting up ruff (#1233)

* chore: Introduce ruff config, remove flake8, update pre-commit-config (no formatting), enforce I(sort) rule

* chore: Update revs for blacken-docs pre-commit hook

* chore: Apply ruff formatting, add corresponding hook to pre-commit-config and update files accordingly

* Exhaustive list of ignored ruff linting rules and enable auto-fix

* MISC: Auto fixes from pre-commit.com hooks

For more information, see https://pre-commit.ci

* chore: Update list of ignored rules for ruff and pre-commit hooks, apply ruff linting and formatting

* Apply suggestions from code review

Co-authored-by: Sébastien Morais <[email protected]>

* chore: Rework improper formatting of some code examples inside docstrings

* MISC: Auto fixes from pre-commit.com hooks

For more information, see https://pre-commit.ci

---------

Co-authored-by: svandenb-dev <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Sébastien Morais <[email protected]>

Author: 4 people

.flake8

@@ -10,33 +10,17 @@ ci:
 
 repos:
 
-- repo: https://github.com/psf/black
-  rev: 23.10.1  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.12.10
   hooks:
-  - id: black
-    args:
-      - --line-length=120
+  - id: ruff-check
+  - id: ruff-format
 
 - repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.16.0
+  rev: 1.19.1
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.10.1]
-
-- repo: https://github.com/pycqa/isort
-  rev: 5.12.0
-  hooks:
-    - id: isort
-      args: ["--profile=black"]
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 6.1.0
-  hooks:
-  - id: flake8
-    args: [
-      --max-line-length, "120",
-      ansys, codegen, doc, examples, tests
-    ]
+    additional_dependencies: [black==25.1.0]
 
 - repo: https://github.com/codespell-project/codespell
   rev: v2.3.0

.pre-commit-config.yaml

@@ -1,4 +1,5 @@
 """Read errors output from a Sphinx build and remove duplicate groups."""
+
 import os
 import pathlib
 import sys

doc/print_errors.py

@@ -88,14 +88,133 @@ Source = "https://github.com/ansys/pyedb"
 Discussions = "https://github.com/ansys/pyedb/discussions"
  Releases = "https://github.com/ansys/pyedb/releases"
 
-[tool.black]
-line-length = 88
-
-[tool.isort]
-profile = "black"
-force_sort_within_sections = true
-default_section = "THIRDPARTY"
-src_paths = ["doc", "src", "tests"]
+[tool.ruff]
+line-length = 120
+fix = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = [
+    "D",   # pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "E",   # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "F",   # pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "I",   # isort, see https://docs.astral.sh/ruff/rules/#isort-i
+    "N",   # pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "PTH", # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "TD",  # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+    "W",   # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+]
+ignore = [
+    # "D" - pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "D100", # undocumented-public-module
+    "D101", # undocumented-public-class
+    "D102", # undocumented-public-method
+    "D103", # undocumented-public-function
+    "D104", # undocumented-public-package
+    "D105", # undocumented-magic-method
+    "D106", # undocumented-public-nested-class
+    "D200", # unnecessary-multiline-docstring
+    "D202", # blank-line-after-function
+    "D205", # missing-blank-line-after-summary
+    "D208", # over-indentation
+    "D209", # new-line-after-last-paragraph
+    "D210", # surrounding-whitespace
+    "D214", # overindented-section
+    "D215", # overindented-section-underline
+    "D301", # escape-sequence-in-docstring
+    "D400", # missing-trailing-period
+    "D401", # non-imperative-mood
+    "D403", # first-word-uncapitalized
+    "D404", # docstring-starts-with-this
+    "D405", # non-capitalized-section-name
+    "D406", # missing-new-line-after-section-name
+    "D407", # missing-dashed-underline-after-section
+    "D409", # mismatched-section-underline-length
+    "D410", # no-blank-line-after-section
+    "D411", # no-blank-line-before-section
+    "D412", # blank-lines-between-header-and-content
+    "D414", # empty-docstring-section
+    "D419", # empty-docstring
+
+    # "E" - pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "E402", # module-import-not-at-top-of-file
+    "E711", # none-comparison
+    "E712", # true-false-comparison
+    "E713", # not-in-test
+    "E721", # type-comparison
+    "E722", # bare-except
+    "E731", # lambda-assignment
+    "E741", # ambiguous-variable-name
+    "E743", # ambiguous-function-name
+
+    # "F" - pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "F401", # unused-import
+    "F523", # string-dot-format-extra-positional-arguments
+    "F541", # f-string-missing-placeholders
+    "F811", # redefined-while-unused
+    "F821", # undefined-name
+    "F841", # unused-variable
+
+    # "N" - pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
+    "N801", # invalid-class-name
+    "N802", # invalid-function-name
+    "N803", # invalid-argument-name
+    "N806", # non-lowercase-variable-in-function
+    "N812", # lowercase-imported-as-non-lowercase
+    "N813", # camelcase-imported-as-lowercase
+    "N815", # mixed-case-variable-in-class-scope
+    "N816", # mixed-case-variable-in-global-scope
+    "N817", # camelcase-imported-as-acronym
+    "N818", # error-suffix-on-exception-name
+    "N999", # invalid-module-name
+
+    # "PTH" - flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "PTH100", # os-path-abspath
+    "PTH101", # os-chmod
+    "PTH102", # os-mkdir
+    "PTH103", # os-makedirs
+    "PTH104", # os-rename
+    "PTH107", # os-remove
+    "PTH108", # os-unlink
+    "PTH110", # os-path-exists
+    "PTH111", # os-path-expanduser
+    "PTH112", # os-path-isdir
+    "PTH113", # os-path-isfile
+    "PTH116", # os-stat
+    "PTH118", # os-path-join
+    "PTH119", # os-path-basename
+    "PTH120", # os-path-dirname
+    "PTH122", # os-path-splitext
+    "PTH123", # builtin-open
+    "PTH202", # os-path-getsize
+
+    # "TD" - flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
+    "TD001", # invalid-todo-tag
+    "TD002", # missing-todo-author
+    "TD003", # missing-todo-link
+    "TD004", # missing-todo-colon
+    "TD005", # missing-todo-description
+    "TD006", # invalid-todo-capitalization
+
+    # "W" - pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "W605" # invalid-escape-sequence
+]
+
+[tool.ruff.lint.pydocstyle]
+# Use Numpy-style docstrings.
+convention = "numpy"
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ["doc", "src", "tests"]
+combine-as-imports = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
 
 [tool.codespell]
 skip = '*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,*.a3dcomp,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,*.cdb,*.CDB,build,./factory/*,PKG-INFO,*.mypy_cache/*,./_unused/*,pyproject.toml'

pyproject.toml

@@ -51,8 +51,7 @@ def custom_show_warning(message, category, filename, lineno, file=None, line=Non
         # TODO: Fall backing to dotnetcore2 should be removed in a near future.
         except Exception:
             warnings.warn(
-                "Unable to set .NET root and locate the runtime configuration file. "
-                "Falling back to using dotnetcore2."
+                "Unable to set .NET root and locate the runtime configuration file. Falling back to using dotnetcore2."
             )
             warnings.warn(LINUX_WARNING)
 

src/pyedb/dotnet/clr_module.py

@@ -35,8 +35,10 @@
 
 """
 
-from __future__ import absolute_import  # noreorder
-from __future__ import division
+from __future__ import (
+    absolute_import,  # noreorder
+    division,
+)
 
 import os
 import re
@@ -493,13 +495,13 @@ def decompose(self, variable_value):  # pragma: no cover
         --------
         >>> hfss = Hfss()
         >>> print(hfss.variable_manager.decompose("5mm"))
-        >>> (5.0, 'mm')
+        >>> (5.0, "mm")
         >>> hfss["v1"] = "3N"
         >>> print(hfss.variable_manager.decompose("v1"))
-        >>> (3.0, 'N')
+        >>> (3.0, "N")
         >>> hfss["v2"] = "2*v1"
         >>> print(hfss.variable_manager.decompose("v2"))
-        >>> (6.0, 'N')
+        >>> (6.0, "N")
         """
         if variable_value in self.independent_variable_names:
             val, unit = decompose_variable_value(self[variable_value].expression)
@@ -1009,8 +1011,13 @@ def set_variable(
         creating the property if it does not already exist. Also make
         it read-only and hidden and add a description.
 
-        >>> aedtapp.variable_manager.set_variable(variable_name="p2", expression="10mm", readonly=True, hidden=True,
-        ...                                       description="This is the description of this variable.")
+        >>> aedtapp.variable_manager.set_variable(
+        ...     variable_name="p2",
+        ...     expression="10mm",
+        ...     readonly=True,
+        ...     hidden=True,
+        ...     description="This is the description of this variable.",
+        ... )
 
         Set the value of the project variable ``$p1`` to ``"30mm"``,
         creating the variable if it does not exist.
@@ -1708,7 +1715,7 @@ def decompose(self):  # pragma: no cover
         >>> hfss = Hfss()
         >>> hfss["v1"] = "3N"
         >>> print(hfss.variable_manager["v1"].decompose("v1"))
-        >>> (3.0, 'N')
+        >>> (3.0, "N")
 
         """
         return decompose_variable_value(self.evaluated_value)
@@ -1760,9 +1767,9 @@ def format(self, format):  # pragma: no cover
         >>> from pyedb.dotnet.database.Variables import Variable
 
         >>> v = Variable("10W")
-        >>> assert v.format("f") == '10.000000W'
-        >>> assert v.format("06.2f") == '010.00W'
-        >>> assert v.format("6.2f") == ' 10.00W'
+        >>> assert v.format("f") == "10.000000W"
+        >>> assert v.format("06.2f") == "010.00W"
+        >>> assert v.format("6.2f") == " 10.00W"
 
         """
         return ("{0:" + format + "}{1}").format(self.numeric_value, self._units)

src/pyedb/dotnet/database/Variables.py

@@ -23,6 +23,7 @@
 """
 This module contains these classes: `EdbLayout` and `Shape`.
 """
+
 from typing import List, Union
 
 from pyedb.dotnet.database.cell.hierarchy.component import EDBComponent

src/pyedb/dotnet/database/cell/layout.py

@@ -39,8 +39,8 @@ class Primitive(Connectable):
     >>> from pyedb import Edb
     >>> edb = Edb(myedb, edbversion="2021.2")
     >>> edb_prim = edb.modeler.primitives[0]
-    >>> edb_prim.is_void # Class Property
-    >>> edb_prim.IsVoid() # EDB Object Property
+    >>> edb_prim.is_void  # Class Property
+    >>> edb_prim.IsVoid()  # EDB Object Property
     """
 
     def __init__(self, pedb, edb_object):

src/pyedb/dotnet/database/cell/primitive/primitive.py

@@ -20,9 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""This module contains the `Components` class.
+"""This module contains the `Components` class."""
 
-"""
 import codecs
 import json
 import math
@@ -541,16 +540,17 @@ def get_component_placement_vector(
 
         Examples
         --------
-        >>> edb1 = Edb(edbpath=targetfile1,  edbversion="2021.2")
+        >>> edb1 = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> hosting_cmp = edb1.components.get_component_by_name("U100")
         >>> mounted_cmp = edb2.components.get_component_by_name("BGA")
         >>> vector, rotation, solder_ball_height = edb1.components.get_component_placement_vector(
-        ...                                             mounted_component=mounted_cmp,
-        ...                                             hosting_component=hosting_cmp,
-        ...                                             mounted_component_pin1="A12",
-        ...                                             mounted_component_pin2="A14",
-        ...                                             hosting_component_pin1="A12",
-        ...                                             hosting_component_pin2="A14")
+        ...     mounted_component=mounted_cmp,
+        ...     hosting_component=hosting_cmp,
+        ...     mounted_component_pin1="A12",
+        ...     mounted_component_pin2="A14",
+        ...     hosting_component_pin1="A12",
+        ...     hosting_component_pin2="A14",
+        ... )
         """
         m_pin1_pos = [0.0, 0.0]
         m_pin2_pos = [0.0, 0.0]
@@ -1270,7 +1270,7 @@ def deactivate_rlc_component(self, component=None, create_circuit_port=False, pe
         Examples
         --------
         >>> from pyedb import Edb
-        >>> edb_file = r'C:\my_edb_file.aedb'
+        >>> edb_file = r"C:\my_edb_file.aedb"
         >>> edb = Edb(edb_file)
         >>> for cmp in list(edb.components.instances.keys()):
         >>>     edb.components.deactivate_rlc_component(component=cmp, create_circuit_port=False)
@@ -1750,9 +1750,9 @@ def set_component_model(self, componentname, model_type="Spice", modelpath=None,
 
         >>> from pyedb import Edb
         >>> edbapp = Edb("myaedbfolder")
-        >>> edbapp.components.set_component_model("A1", model_type="Spice",
-        ...                                            modelpath="pathtospfile",
-        ...                                            modelname="spicemodelname")
+        >>> edbapp.components.set_component_model(
+        ...     "A1", model_type="Spice", modelpath="pathtospfile", modelname="spicemodelname"
+        ... )
 
         """
         if not modelname:
@@ -2152,9 +2152,7 @@ def set_component_rlc(
 
         >>> from pyedb import Edb
         >>> edbapp = Edb("myaedbfolder")
-        >>> edbapp.components.set_component_rlc(
-        ...     "R1", res_value=50, ind_value=1e-9, cap_value=1e-12, isparallel=False
-        ... )
+        >>> edbapp.components.set_component_rlc("R1", res_value=50, ind_value=1e-9, cap_value=1e-12, isparallel=False)
 
         """
         if res_value is None and ind_value is None and cap_value is None:

src/pyedb/dotnet/database/components.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 """Database."""
+
 import re
 
 from pyedb.dotnet.database.general import convert_py_list_to_net_list