pyedb 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

pyedb/grpc/database/stackup.py

@@ -41,15 +41,18 @@ from ansys.edb.core.definition.solder_ball_property import (
 from ansys.edb.core.geometry.point3d_data import Point3DData as GrpcPoint3DData
 from ansys.edb.core.hierarchy.cell_instance import CellInstance as GrpcCellInstance
 from ansys.edb.core.hierarchy.component_group import ComponentType as GrpcComponentType
-from ansys.edb.core.layer.layer import LayerType as GrpcLayerType
-from ansys.edb.core.layer.layer import TopBottomAssociation as GrpcTopBottomAssociation
+from ansys.edb.core.layer.layer import LayerType as GrpcLayerType, TopBottomAssociation as GrpcTopBottomAssociation
 from ansys.edb.core.layer.layer_collection import (
+    LayerCollection as GrpcLayerCollection,
     LayerCollectionMode as GrpcLayerCollectionMode,
+    LayerTypeSet as GrpcLayerTypeSet,
 )
-from ansys.edb.core.layer.layer_collection import LayerCollection as GrpcLayerCollection
-from ansys.edb.core.layer.layer_collection import LayerTypeSet as GrpcLayerTypeSet
 from ansys.edb.core.layer.stackup_layer import StackupLayer as GrpcStackupLayer
 from ansys.edb.core.layout.mcad_model import McadModel as GrpcMcadModel
+from defusedxml.ElementTree import parse as defused_parse
+import matplotlib.colors as colors
+import numpy as np
+import pandas as pd
 
 from pyedb.generic.general_methods import ET, generate_unique_name
 from pyedb.grpc.database.layers.layer import Layer
@@ -57,24 +60,6 @@ from pyedb.grpc.database.layers.stackup_layer import StackupLayer
 from pyedb.grpc.database.utility.value import Value
 from pyedb.misc.aedtlib_personalib_install import write_pretty_xml
 
-colors = None
-pd = None
-np = None
-try:
-    import matplotlib.colors as colors
-except ImportError:
-    colors = None
-
-try:
-    import numpy as np
-except ImportError:
-    np = None
-
-try:
-    import pandas as pd
-except ImportError:
-    pd = None
-
 logger = logging.getLogger(__name__)
 
 
@@ -128,8 +113,9 @@ class LayerCollection(GrpcLayerCollection):
         --------
         >>> from pyedb import Edb
         >>> edb = Edb()
-        >>> top_layer = edb.stackup.add_layer_top("NewTopLayer", layer_type="signal", thickness="0.1mm",
-        ... material="copper")
+        >>> top_layer = edb.stackup.add_layer_top(
+        ...     "NewTopLayer", layer_type="signal", thickness="0.1mm", material="copper"
+        ... )
         """
         thickness = Value(0.0)
         if "thickness" in kwargs:
@@ -167,8 +153,9 @@ class LayerCollection(GrpcLayerCollection):
         --------
         >>> from pyedb import Edb
         >>> edb = Edb()
-        >>> bot_layer = edb.stackup.add_layer_bottom("NewBottomLayer", layer_type="signal", thickness="0.1mm",
-        ... material="copper")
+        >>> bot_layer = edb.stackup.add_layer_bottom(
+        ...     "NewBottomLayer", layer_type="signal", thickness="0.1mm", material="copper"
+        ... )
         """
         thickness = Value(0.0)
         layer_type_map = {"dielectric": GrpcLayerType.DIELECTRIC_LAYER, "signal": GrpcLayerType.SIGNAL_LAYER}
@@ -564,9 +551,6 @@ class Stackup(LayerCollection):
         >>> edb = Edb()
         >>> edb.stackup.create_symmetric_stackup(layer_count=4)
         """
-        if not np:
-            self._pedb.logger.error("Numpy is needed. Please, install it first.")
-            return False
         if not layer_count % 2 == 0:
             return False
 
@@ -1023,10 +1007,6 @@ class Stackup(LayerCollection):
         return self.export(fpath, file_format=file_format, include_material_with_layer=include_material_with_layer)
 
     def _export_layer_stackup_to_csv_xlsx(self, fpath: Optional[str] = None, file_format: Optional[str] = None) -> bool:
-        if not pd:
-            self._pedb.logger.error("Pandas is needed. Please, install it first.")
-            return False
-
         data = {
             "Type": [],
             "Material": [],
@@ -1189,8 +1169,11 @@ class Stackup(LayerCollection):
                         sball_prop = cmp_prop.solder_ball_property
                         sball_prop.placement = GrpcSolderballPlacement.ABOVE_PADSTACK
                         cmp_prop.solder_ball_property = sball_prop
-                except:
-                    pass
+                except Exception as e:
+                    self._logger.warning(
+                        f"A(n) {type(e).__name__} error occurred while attempting to update "
+                        f"solder_ball_property for component {cmp}: {str(e)}"
+                    )
                 if cmp_type == GrpcComponentType.IC:
                     die_prop = cmp_prop.die_property
                     chip_orientation = die_prop.die_orientation
@@ -1236,8 +1219,11 @@ class Stackup(LayerCollection):
             try:
                 if val.solder_ball_height and val.placement_layer == layer_name:
                     height = val.solder_ball_height
-            except:
-                pass
+            except Exception as e:
+                self._logger.error(
+                    f"A(n) {type(e).__name__} error occurred while attempting to retrieve solder_height "
+                    f"for layer {layer_name} - Default value of 0.0 is returned: {str(e)}"
+                )
         return height
 
     def _remove_solder_pec(self, layer_name):
@@ -1330,15 +1316,21 @@ class Stackup(LayerCollection):
         >>> 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")
-        >>> edb2.stackup.place_in_layout(edb1.active_cell, angle=0.0, offset_x=vector[0],
-        ...                              offset_y=vector[1], flipped_stackup=False, place_on_top=True,
-        ...                              )
+        ...     mounted_component=mounted_cmp,
+        ...     hosting_component=hosting_cmp,
+        ...     mounted_component_pin1="A12",
+        ...     mounted_component_pin2="A14",
+        ...     hosting_component_pin1="A12",
+        ...     hosting_component_pin2="A14",
+        ... )
+        >>> edb2.stackup.place_in_layout(
+        ...     edb1.active_cell,
+        ...     angle=0.0,
+        ...     offset_x=vector[0],
+        ...     offset_y=vector[1],
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         # if flipped_stackup and place_on_top or (not flipped_stackup and not place_on_top):
         self.adjust_solder_dielectrics()
@@ -1418,9 +1410,14 @@ class Stackup(LayerCollection):
         >>> edb2 = Edb(edbpath=targetfile2, edbversion="2021.2")
         >>> hosting_cmp = edb1.components.get_component_by_name("U100")
         >>> mounted_cmp = edb2.components.get_component_by_name("BGA")
-        >>> edb2.stackup.place_in_layout(edb1.active_cell, angle=0.0, offset_x="1mm",
-        ...                                   offset_y="2mm", flipped_stackup=False, place_on_top=True,
-        ...                                   )
+        >>> edb2.stackup.place_in_layout(
+        ...     edb1.active_cell,
+        ...     angle=0.0,
+        ...     offset_x="1mm",
+        ...     offset_y="2mm",
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         _angle = angle * math.pi / 180.0
 
@@ -1678,9 +1675,14 @@ class Stackup(LayerCollection):
         --------
         >>> edb1 = Edb(edbpath=targetfile1, edbversion="2021.2")
         >>> a3dcomp_path = "connector.a3dcomp"
-        >>> edb1.stackup.place_a3dcomp_3d_placement(a3dcomp_path, angle=0.0, offset_x="1mm",
-        ...                                   offset_y="2mm", flipped_stackup=False, place_on_top=True,
-        ...                                   )
+        >>> edb1.stackup.place_a3dcomp_3d_placement(
+        ...     a3dcomp_path,
+        ...     angle=0.0,
+        ...     offset_x="1mm",
+        ...     offset_y="2mm",
+        ...     flipped_stackup=False,
+        ...     place_on_top=True,
+        ... )
         """
         rotation_axis_from = GrpcPoint3DData(1.0, 0.0, 0.0)
         _angle = angle * math.pi / 180.0
@@ -1932,10 +1934,6 @@ class Stackup(LayerCollection):
         bool
             ``True`` when successful.
         """
-        if not pd:
-            self._pedb.logger.error("Pandas is needed. You must install it first.")
-            return False
-
         df = pd.read_csv(file_path, index_col=0)
 
         for name in self.layers.keys():  # pragma: no cover
@@ -2204,10 +2202,7 @@ class Stackup(LayerCollection):
         bool
             ``True`` when successful.
         """
-        if not colors:
-            self._pedb.logger.error("Matplotlib is needed. Please, install it first.")
-            return False
-        tree = ET.parse(file_path)
+        tree = defused_parse(file_path)
         root = tree.getroot()
         stackup = root.find("Stackup")
         stackup_dict = {}

pyedb/grpc/database/terminal/bundle_terminal.py

@@ -20,15 +20,20 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pyedb.grpc.database.hierarchy.component import Component
+    from pyedb.grpc.database.net.net import Net
 from ansys.edb.core.terminal.bundle_terminal import BundleTerminal as GrpcBundleTerminal
 from ansys.edb.core.terminal.terminal import (
+    HfssPIType as GrpcHfssPIType,
     SourceTermToGroundType as GrpcSourceTermToGroundType,
 )
-from ansys.edb.core.terminal.terminal import HfssPIType as GrpcHfssPIType
 
-from pyedb.grpc.database.hierarchy.component import Component
 from pyedb.grpc.database.layers.layer import Layer
-from pyedb.grpc.database.net.net import Net
 from pyedb.grpc.database.terminal.terminal import Terminal
 from pyedb.grpc.database.utility.rlc import Rlc
 from pyedb.grpc.database.utility.value import Value
@@ -77,6 +82,7 @@ class BundleTerminal(GrpcBundleTerminal):
         -------
         :class:`Component <pyedb.grpc.database.hierarchy.component.Component`
         """
+
         return Component(self._pedb, self.component)
 
     @property
@@ -102,6 +108,7 @@ class BundleTerminal(GrpcBundleTerminal):
         -------
         :class:`Net <pyedb.grpc.database.net.net.Net>`
         """
+
         return Net(self._pedb, self.net)
 
     @property

pyedb/grpc/database/terminal/padstack_instance_terminal.py

@@ -37,16 +37,6 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
             super().__init__(edb_object.msg)
         self._pedb = pedb
 
-    @property
-    def boundary_type(self) -> str:
-        """Boundary type.
-
-        Returns
-        -------
-        str : boundary type.
-        """
-        return super().boundary_type.name.lower()
-
     @property
     def position(self) -> list[float]:
         """Terminal position.
@@ -193,7 +183,15 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
             "rlc": GrpcBoundaryType.RLC,
             "pec": GrpcBoundaryType.PEC,
         }
-        super(PadstackInstanceTerminal, self.__class__).boundary_type.__set__(self, mapping[value.name.lower()])
+        if isinstance(value, str):
+            key = value.lower()
+        else:
+            key = value.name.lower()
+        new_boundary_type = mapping.get(key)
+        if new_boundary_type is None:
+            valid_types = ", ".join(mapping.keys())
+            raise ValueError(f"Invalid boundary type '{value}'. Valid types are: {valid_types}")
+        super(PadstackInstanceTerminal, self.__class__).boundary_type.__set__(self, new_boundary_type)
 
     @property
     def is_port(self) -> bool:

pyedb/grpc/database/terminal/pingroup_terminal.py

@@ -20,12 +20,17 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pyedb.grpc.database.net.net import Net
 from ansys.edb.core.terminal.pin_group_terminal import (
     PinGroupTerminal as GrpcPinGroupTerminal,
 )
 from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 
-from pyedb.grpc.database.net.net import Net
 from pyedb.grpc.database.utility.value import Value
 from pyedb.misc.decorators import deprecated_property
 
@@ -151,6 +156,8 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
             Terminal Net object.
 
         """
+        from pyedb.grpc.database.net.net import Net
+
         return Net(self._pedb, super().net)
 
     @net.setter

pyedb/grpc/database/terminal/point_terminal.py

@@ -22,9 +22,20 @@
 
 from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
 from ansys.edb.core.terminal.point_terminal import PointTerminal as GrpcPointTerminal
+from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 
 from pyedb.grpc.database.utility.value import Value
 
+mapping_boundary_type = {
+    "port": GrpcBoundaryType.PORT,
+    "dc_terminal": GrpcBoundaryType.DC_TERMINAL,
+    "voltage_probe": GrpcBoundaryType.VOLTAGE_PROBE,
+    "voltage_source": GrpcBoundaryType.VOLTAGE_SOURCE,
+    "current_source": GrpcBoundaryType.CURRENT_SOURCE,
+    "rlc": GrpcBoundaryType.RLC,
+    "pec": GrpcBoundaryType.PEC,
+}
+
 
 class PointTerminal(GrpcPointTerminal):
     """Manages point terminal properties."""
@@ -33,6 +44,25 @@ class PointTerminal(GrpcPointTerminal):
         super().__init__(edb_object.msg)
         self._pedb = pedb
 
+    @property
+    def boundary_type(self):
+        """Boundary type.
+
+        Returns
+        -------
+        str : boundary type.
+
+        """
+        return super().boundary_type.name.lower()
+
+    @boundary_type.setter
+    def boundary_type(self, value):
+        if isinstance(value, str):
+            value = mapping_boundary_type.get(value.lower(), None)
+        if not isinstance(value, GrpcBoundaryType):
+            raise ValueError("Value must be a string or BoundaryType enum.")
+        super(PointTerminal, self.__class__).boundary_type.__set__(self, value)
+
     @property
     def location(self) -> list[float]:
         """Terminal position.

pyedb/grpc/database/terminal/terminal.py

@@ -20,17 +20,34 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
 import re
 
 from ansys.edb.core.terminal.edge_terminal import EdgeType as GrpcEdgeType
-from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
-from ansys.edb.core.terminal.terminal import Terminal as GrpcTerminal
-from ansys.edb.core.terminal.terminal import TerminalType as GrpcTerminalType
+from ansys.edb.core.terminal.terminal import (
+    BoundaryType as GrpcBoundaryType,
+    Terminal as GrpcTerminal,
+    TerminalType as GrpcTerminalType,
+)
 
-from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
 from pyedb.grpc.database.primitive.primitive import Primitive
 from pyedb.grpc.database.utility.value import Value
 
+mapping_boundary_type = {
+    "port": GrpcBoundaryType.PORT,
+    "dc_terminal": GrpcBoundaryType.DC_TERMINAL,
+    "voltage_probe": GrpcBoundaryType.VOLTAGE_PROBE,
+    "voltage_source": GrpcBoundaryType.VOLTAGE_SOURCE,
+    "current_source": GrpcBoundaryType.CURRENT_SOURCE,
+    "rlc": GrpcBoundaryType.RLC,
+    "pec": GrpcBoundaryType.PEC,
+}
+
 
 class Terminal(GrpcTerminal):
     def __init__(self, pedb, edb_object):
@@ -195,7 +212,11 @@ class Terminal(GrpcTerminal):
 
     @boundary_type.setter
     def boundary_type(self, value):
-        super(Terminal, self.__class__).boundary_type.__set__(self, self._boundary_type_mapping[value])
+        if isinstance(value, str):
+            value = mapping_boundary_type.get(value.lower(), None)
+        if not isinstance(value, GrpcBoundaryType):
+            raise ValueError("Value must be a string or BoundaryType enum.")
+        super(Terminal, self.__class__).boundary_type.__set__(self, value)
 
     @property
     def is_port(self) -> bool:
@@ -243,7 +264,7 @@ class Terminal(GrpcTerminal):
 
     @impedance.setter
     def impedance(self, value):
-        self.impedance = Value(value)
+        super(Terminal, self.__class__).impedance.__set__(self, self._pedb.value(value))
 
     @property
     def reference_object(self) -> any:
@@ -364,13 +385,17 @@ class Terminal(GrpcTerminal):
                     return (primitive, self._pedb)
         return None  # pragma: no cover
 
-    def get_point_terminal_reference_primitive(self) -> Primitive:  # pragma : no cover
-        """Find and return the primitive reference for the point terminal or the padstack instance.
+    def get_point_terminal_reference_primitive(self) -> Primitive:
+        """
+        Find and return the primitive reference for the point terminal or the padstack instance.
 
         Returns
         -------
-        :class:`PadstackInstance <pyedb.grpc.database.primitive.padstack_instance.PadstackInstance>` or
-        :class:`Primitive <pyedb.grpc.database.primitive.primitive.Primitive>`
+        Primitive or PadstackInstance
+            The primitive reference for the point terminal or the padstack instance.
+            Returns an instance of :class:`PadstackInstance
+            <pyedb.grpc.database.primitive.padstack_instance.PadstackInstance>`
+            or :class:`Primitive <pyedb.grpc.database.primitive.primitive.Primitive>`.
         """
 
         ref_term = self.reference_terminal  # return value is type terminal

pyedb/grpc/database/utility/heat_sink.py

@@ -27,7 +27,6 @@ from ansys.edb.core.utility.value import Value as GrpcValue
 
 
 class HeatSink:
-
     """Heatsink model description.
 
     Parameters

pyedb/grpc/database/utility/hfss_extent_info.py

@@ -21,10 +21,10 @@
 # SOFTWARE.
 
 from ansys.edb.core.utility.hfss_extent_info import (
+    HfssExtentInfo as GrpcHfssExtentInfo,
     HFSSExtentInfoType as GrpcHfssExtentInfoType,
+    OpenRegionType as GrpcOpenRegionType,
 )
-from ansys.edb.core.utility.hfss_extent_info import HfssExtentInfo as GrpcHfssExtentInfo
-from ansys.edb.core.utility.hfss_extent_info import OpenRegionType as GrpcOpenRegionType
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 

pyedb/grpc/database/utility/xml_control_file.py

@@ -23,9 +23,11 @@
 import copy
 import os
 import re
-import subprocess
+import subprocess  # nosec B404
 import sys
 
+from defusedxml.ElementTree import parse as defused_parse
+
 from pyedb.generic.general_methods import ET, env_path, env_value, is_linux
 from pyedb.generic.settings import settings
 from pyedb.misc.aedtlib_personalib_install import write_pretty_xml
@@ -35,6 +37,11 @@ from pyedb.misc.misc import list_installed_ansysem
 def convert_technology_file(tech_file, edbversion=None, control_file=None):
     """Convert a technology file to edb control file (xml).
 
+    .. warning::
+        Do not execute this function with untrusted function argument, environment
+        variables or pyedb global settings.
+        See the :ref:`security guide<ref_security_consideration>` for details.
+
     Parameters
     ----------
     tech_file : str
@@ -98,10 +105,11 @@ def convert_technology_file(tech_file, edbversion=None, control_file=None):
         ]
         commands.append(command)
         commands.append(["rm", "-r", vlc_file_name + ".aedb"])
-        my_env = os.environ.copy()
         for command in commands:
-            p = subprocess.Popen(command, env=my_env)
-            p.wait()
+            try:
+                subprocess.run(command, check=True)  # nosec
+            except subprocess.CalledProcessError as e:  # nosec
+                raise RuntimeError("An error occurred while converting a technology file to edb control file") from e
         if os.path.exists(control_file):
             settings.logger.info("Xml file created.")
             return control_file
@@ -122,7 +130,7 @@ class ControlProperty:
                 float(value)
                 self.type = 0
             except TypeError:
-                pass
+                self.type = -1
 
     def _write_xml(self, root):
         try:
@@ -132,8 +140,11 @@ class ControlProperty:
                 double.text = str(self.value)
             else:
                 pass
-        except:
-            pass
+        except Exception as e:
+            settings.logger.error(
+                f"A(n) {type(e).__name__} error occurred while attempting to create a new sub-element {self.name} "
+                f"for element {root}: {str(e)}"
+            )
 
 
 class ControlFileMaterial:
@@ -1185,7 +1196,7 @@ class ControlFile:
         -------
         bool
         """
-        tree = ET.parse(xml_input)
+        tree = defused_parse(xml_input)
         root = tree.getroot()
         for el in root:
             if el.tag == "Stackup":