MISC: update following pre-commit

Changes include: - formatting using black, isort, flake8 - proposed changes from codespell - doc updates following blackend-docs - trim trailing whitespace
ansys · Dec 1, 2023 · ee5ff30 · ee5ff30
1 parent 1be6c98
commit ee5ff30
Show file tree

Hide file tree

Showing 132 changed files with 805 additions and 642 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -17,7 +17,7 @@
 #
 # Merging from the command prompt will add diff markers to the files if there
 # are conflicts (Merging from VS is not affected by the settings below, in VS
-# the diff markers are never inserted). Diff markers may cause the following 
+# the diff markers are never inserted). Diff markers may cause the following
 # file extensions to fail to load in VS. An alternative would be to treat
 # these files as binary and thus will always conflict and require user
 # intervention with every merge. To do so, just uncomment the entries below
@@ -46,9 +46,9 @@
 
 ###############################################################################
 # diff behavior for common document formats
-# 
+#
 # Convert binary document formats to text before diffing them. This feature
-# is only available from the command line. Turn it on by uncommenting the 
+# is only available from the command line. Turn it on by uncommenting the
 # entries below.
 ###############################################################################
 #*.doc   diff=astextplain

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,7 +4,7 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "daily"
-    reviewers: 
+    reviewers:
       - "SMoraisAnsys"
     assignees:
       - "pyansys-ci-bot"
@@ -18,7 +18,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
-    reviewers: 
+    reviewers:
       - "SMoraisAnsys"
     assignees:
       - "pyansys-ci-bot"

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -49,6 +49,8 @@ repos:
   - id: requirements-txt-fixer
   - id: debug-statements
   - id: trailing-whitespace
+    files: '(src|doc|tests)/.*'
+    exclude: 'tests/example_models/*'
 
 # # validate GitHub workflow files
 # - repo: https://github.com/python-jsonschema/check-jsonschema

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 ANSYS, Inc. All rights reserved. 
+Copyright (c) 2023 ANSYS, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -116,8 +116,8 @@ start using EDB faster and easier.
 
 ## Example workflow
 
- 1. 
- 2. 
+ 1.
+ 2.
 
 ## Connect to PyEDB from Python IDE
 
@@ -129,10 +129,9 @@ Usage examples follow.
 ## Explicit AEDT declaration and error management
 
 ``` python
-    # Launch PyEDB 2024 R1 
+# Launch PyEDB 2024 R1
 
-    from pyedb import EDB
-
+from pyedb import EDB
 ```
 
 ## License

diff --git a/doc/print_errors.py b/doc/print_errors.py
@@ -1,7 +1,7 @@
 """Read errors output from a Sphinx build and remove duplicate groups."""
-import sys
 import os
 import pathlib
+import sys
 
 sys.tracebacklimit = 0
 my_path = pathlib.Path(__file__).parent.resolve()
@@ -26,6 +26,6 @@
     # There should be no errors here since sphinx will have exited
     print()
     if errors:
-        raise Exception(f"Sphinx reported unique {len(errors)} warnings\n\n")
+        raise Exception(f"Sphinx reported {len(errors)} warnings\n\n")
 
 print(f"Sphinx Reported no warnings\n\n")
diff --git a/doc/source/EDBAPI/ComponentsEdb.rst b/doc/source/EDBAPI/ComponentsEdb.rst
@@ -6,9 +6,10 @@ The main component object is called directly from main application using the pro
 .. code:: python
 
     from pyedb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
-    pins =edb.components.get_pin_from_component("U2A5")
+    pins = edb.components.get_pin_from_component("U2A5")
 
     ...
 
@@ -41,6 +42,7 @@ These classes are the containers of data management for components reference des
 .. code:: python
 
     from pyedb.legacy.edb import EdbLegacy
+
     edb = EdbLegacy(myedb, edbversion="2023.1")
 
     comp = edb.components["C1"]

diff --git a/doc/source/EDBAPI/CoreEdb.rst b/doc/source/EDBAPI/CoreEdb.rst
@@ -20,6 +20,7 @@ It can be opened and edited using the ``Edb`` class.
 .. code:: python
 
     from pyedb.legacy.edb import EdbLegacy
+
     # this call returns the Edb class initialized on 2023 R1
     edb = EdbLegacy(myedb, edbversion="2023.1")
 
@@ -57,7 +58,8 @@ to AEDB files.
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     # this call returns the EdbHfss Class

diff --git a/doc/source/EDBAPI/LayerData.rst b/doc/source/EDBAPI/LayerData.rst
@@ -5,7 +5,8 @@ These classes are the containers of the layer and stackup manager of the EDB API
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     # this call returns the EDBLayers class

diff --git a/doc/source/EDBAPI/NetsEdb.rst b/doc/source/EDBAPI/NetsEdb.rst
@@ -5,10 +5,11 @@ The main component object is called directly from main application using the pro
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
-    edb.nets.plot(None,None)
+    edb.nets.plot(None, None)
 
     ...
 
@@ -40,7 +41,8 @@ The following class is the container of data management for nets, extended nets
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     edb.nets["M_MA<6>"].delete()

diff --git a/doc/source/EDBAPI/PadstackEdb.rst b/doc/source/EDBAPI/PadstackEdb.rst
@@ -5,11 +5,15 @@ The main padstack object is called directly from main application using the prop
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     edb.padstacks.create_padstack(
-    padstackname="SVIA", holediam="$via_hole_size", antipaddiam="$antipaddiam", paddiam="$paddiam"
+        padstackname="SVIA",
+        holediam="$via_hole_size",
+        antipaddiam="$antipaddiam",
+        paddiam="$paddiam",
     )
 
 

diff --git a/doc/source/EDBAPI/PortsEdb.rst b/doc/source/EDBAPI/PortsEdb.rst
@@ -7,7 +7,8 @@ These classes are the containers of ports methods of the EDB for both HFSS and S
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     # this call returns the EDB excitations dictionary

diff --git a/doc/source/EDBAPI/PrimitivesEdb.rst b/doc/source/EDBAPI/PrimitivesEdb.rst
@@ -6,12 +6,13 @@ Primitives are planes, lines, rectangles, and circles.
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
-    top_layer_obj = edb.modeler.create_rectangle("TOP", net_name="gnd",
-                                                 lower_left_point=plane_lw_pt,
-                                                 upper_right_point=plane_up_pt)
+    top_layer_obj = edb.modeler.create_rectangle(
+        "TOP", net_name="gnd", lower_left_point=plane_lw_pt, upper_right_point=plane_up_pt
+    )
 
     ...
 
@@ -42,7 +43,8 @@ These classes are the containers of data management for primitives and arcs.
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     polygon = edbapp.modeler.polygons[0]

diff --git a/doc/source/EDBAPI/SiWave.rst b/doc/source/EDBAPI/SiWave.rst
@@ -22,6 +22,7 @@ accessed from PyEDB in Windows only. All setups can be implemented through EDB A
 .. code:: python
 
     from pyedb.legacy.edb_core.siwave import EdbSiwave
+
     # this call returns the Edb class initialized on 2023 R1
     siwave = EdbSiwave(specified_version="2023.1")
     siwave.open_project("pyproject.siw")

diff --git a/doc/source/EDBAPI/SimulationConfigurationEdb.rst b/doc/source/EDBAPI/SimulationConfigurationEdb.rst
@@ -18,16 +18,23 @@ These classes are the containers of simulation configuration constructors for th
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edbapp = Edb(myedb, edbversion="2023.1")
 
     sim_setup = edbapp.new_simulation_configuration()
     sim_setup.solver_type = sim_setup.SOLVER_TYPE.SiwaveSYZ
     sim_setup.batch_solve_settings.cutout_subdesign_expansion = 0.01
     sim_setup.batch_solve_settings.do_cutout_subdesign = True
     sim_setup.use_default_cutout = False
-    sim_setup.batch_solve_settings.signal_nets = ["PCIE0_RX0_P", "PCIE0_RX0_N", "PCIE0_TX0_P_C", "PCIE0_TX0_N_C",
-                                                  "PCIE0_TX0_P", "PCIE0_TX0_N"]
+    sim_setup.batch_solve_settings.signal_nets = [
+        "PCIE0_RX0_P",
+        "PCIE0_RX0_N",
+        "PCIE0_TX0_P_C",
+        "PCIE0_TX0_N_C",
+        "PCIE0_TX0_P",
+        "PCIE0_TX0_N",
+    ]
     sim_setup.batch_solve_settings.components = ["U2A5", "J2L1"]
     sim_setup.batch_solve_settings.power_nets = ["GND"]
     sim_setup.ac_settings.start_freq = "100Hz"

diff --git a/doc/source/EDBAPI/SimulationEdb.rst b/doc/source/EDBAPI/SimulationEdb.rst
@@ -5,7 +5,8 @@ These classes are the containers of ``setup`` classes in EDB for both HFSS and S
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     # this call create a setup and returns the object

diff --git a/doc/source/EDBAPI/SourcesEdb.rst b/doc/source/EDBAPI/SourcesEdb.rst
@@ -5,7 +5,8 @@ These classes are the containers of sources methods of the EDB for both HFSS and
 
 .. code:: python
 
-    from from pyedb.legacy.edb_core.edb import Edb
+    from pyedb.legacy.edb_core.edb import Edb
+
     edb = Edb(myedb, edbversion="2023.1")
 
     # this call returns the EDB excitations dictionary

diff --git a/doc/source/EDBAPI/index.rst b/doc/source/EDBAPI/index.rst
@@ -23,6 +23,7 @@ Example:
 .. code:: python
 
     from pyaedt import Edb
+
     edb = Edb("my_project.aedb", edbversion="2023.1")
     edb.core_components.components["R1"].r_value = 40
     edb.close_edb()

diff --git a/doc/source/Getting_started/Contributing.rst b/doc/source/Getting_started/Contributing.rst
@@ -9,7 +9,7 @@ in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
 with this guide, paying particular attention to `Guidelines and Best Practices
 <https://dev.docs.pyansys.com/how-to/index.html>`_, before attempting
 to contribute to PyEDB.
- 
+
 The following contribution information is specific to PyEDB.
 
 Clone the repository
@@ -110,7 +110,7 @@ For example:
    def my_method(self, var):
        pass
 
-Every method can return a value of ``True`` when successful or 
+Every method can return a value of ``True`` when successful or
 ``False`` when failed. When a failure occurs, the error
 handler returns information about the error in both the console and
 log file.

diff --git a/doc/source/Getting_started/Installation.rst b/doc/source/Getting_started/Installation.rst
@@ -1,7 +1,7 @@
 Installation
 ============
 PyEDB consolidates and extends all existing capital around scripting for AEDB,
-allowing re-use of existing code, sharing of best practices, and collaboration.
+allowing reuse of existing code, sharing of best practices, and collaboration.
 
 This PyAnsys library has been tested on HFSS, Icepak, SIWave.
 
@@ -29,9 +29,9 @@ Install on CPython from PyPI
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 You can install PyEDB on CPython 3.7 through 3.10 from PyPI:
 
-.. code:: python
+.. code:: shell
 
-    pip install pyansys-edb
+    pip install pyedb
 
 
 Linux support

diff --git a/doc/source/Getting_started/Quickcode.rst b/doc/source/Getting_started/Quickcode.rst
@@ -45,7 +45,7 @@ Explicit PyEDB declaration and error management
 
     from pyedb.legacy.edb_core.edb import EdbLegacy
 
-    edb_file = pyedb.layout_examples.ANSYS-HSD_V1.aedb
+    edb_file = pyedb.layout_examples.ANSYS - HSD_V1.aedb
     edb = EdbLegacy(edbversion="2023.2", edbpath=edb_file)
 
 
@@ -56,7 +56,7 @@ Variables
 
     from pyedb.legacy.edb_core.edb import EdbLegacy
 
-    edb_file = pyedb.layout_examples.ANSYS-HSD_V1.aedb
+    edb_file = pyedb.layout_examples.ANSYS - HSD_V1.aedb
     edb = EdbLegacy(edbversion="2023.2", edbpath=edb_file)
-    edb["dim"] = "1mm"   # design variable
+    edb["dim"] = "1mm"  # design variable
     edb["$dim"] = "1mm"  # project variable
diff --git a/doc/source/Getting_started/Troubleshooting.rst b/doc/source/Getting_started/Troubleshooting.rst
@@ -18,7 +18,7 @@ Here is the path to the Python 3.7 interpreter for the 2023 R1 installation:
 
 .. code:: python
 
-   path\to\AnsysEM\v231\commonfiles\CPython\3_7\winx64\Release\python"
+   "path\to\AnsysEM\v231\commonfiles\CPython\3_7\winx64\Release\python"
 
 
 Error installing PyEDB using pip
@@ -44,9 +44,9 @@ The wheelhouse for PyAEDT can be found `here <https://github.com/ansys/pyaedt/re
 After downloading the wheelhouse for your distribution and Python release, unzip the file to a folder and
 run the Python command:
 
-.. code:: python
+.. code:: shell
 
-    >>> pip install --no-cache-dir --no-index --find-links=/path/to/pyansys-edb/wheelhouse pyansys-edb
+   pip install --no-cache-dir --no-index --find-links=/path/to/pyansys-edb/wheelhouse pyansys-edb
 
 
 Run PyEDB with gRPC

diff --git a/doc/source/Getting_started/versioning.rst b/doc/source/Getting_started/versioning.rst
@@ -25,8 +25,8 @@ and files from the MAPDL service.
 Legacy interfaces
 =================
 
-.NET interface
---------------
+Working with .NET interface
+---------------------------
 
 PyEDB supports the legacy .NET interface, enabled with the settings option.
 

diff --git a/doc/source/Scripts_resources/SI/create_hfss_excitation_ports.py b/doc/source/Scripts_resources/SI/create_hfss_excitation_ports.py
@@ -4,9 +4,9 @@
 # Ansys release version
 desktop_version = "2023.2"
 
-#download and copy the layout file from examples
+# download and copy the layout file from examples
 temp_folder = pyaedt.generate_unique_folder_name()
-targetfile = pyaedt.downloads.download_file('edb/ANSYS-HSD_V1.aedb', destination=temp_folder)
+targetfile = pyaedt.downloads.download_file("edb/ANSYS-HSD_V1.aedb", destination=temp_folder)
 
 # loading EDB
 edbapp = Edb(edbpath=targetfile, edbversion=desktop_version)
@@ -27,4 +27,4 @@
 edbapp.save_edb()
 edbapp.close_edb()
 hfss = Hfss3dLayout(projectname=targetfile, specified_version=desktop_version)
-hfss.release_desktop(close_desktop=False, close_projects=False)
+hfss.release_desktop(close_desktop=False, close_projects=False)