pyedb 0.57.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

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

@@ -38,6 +38,16 @@ from ansys.edb.core.terminal.terminal import (
 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):
@@ -202,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:
@@ -250,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:

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
@@ -1188,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":

pyedb/grpc/edb.py

@@ -60,7 +60,7 @@ from itertools import combinations
 import os
 import re
 import shutil
-import subprocess
+import subprocess  # nosec B404
 import sys
 import tempfile
 import time
@@ -217,8 +217,8 @@ class Edb(EdbInit):
         self.standalone = True
         self.oproject = oproject
         self._main = sys.modules["__main__"]
-        self.edbversion = edbversion
-        if not float(self.edbversion) >= 2025.2:
+        self.version = edbversion
+        if not float(self.version) >= 2025.2:
             raise "EDB gRPC is only supported with ANSYS release 2025R2 and higher."
         self.logger.info("Using PyEDB with gRPC as Beta until ANSYS 2025R2 official release.")
         self.isaedtowned = isaedtowned
@@ -620,7 +620,7 @@ class Edb(EdbInit):
             if self.db.is_null:
                 self.logger.warning("Error Opening db")
                 self._active_cell = None
-            self.logger.info(f"Database {os.path.split(self.edbpath)[-1]} Opened in {self.edbversion}")
+            self.logger.info(f"Database {os.path.split(self.edbpath)[-1]} Opened in {self.version}")
             self._active_cell = None
             if self.cellname:
                 for cell in self.active_db.circuit_cells:
@@ -761,6 +761,11 @@ class Edb(EdbInit):
 
         This function supports all AEDT formats, including DXF, GDS, SML (IPC2581), BRD, MCM, SIP, ZIP and TGZ.
 
+        .. 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
         ----------
         input_file : str
@@ -803,16 +808,16 @@ class Edb(EdbInit):
         self._nets = None
         aedb_name = os.path.splitext(os.path.basename(input_file))[0] + ".aedb"
         if anstranslator_full_path and os.path.exists(anstranslator_full_path):
-            command = anstranslator_full_path
+            executable_path = anstranslator_full_path
         else:
-            command = os.path.join(self.base_path, "anstranslator")
+            executable_path = os.path.join(self.base_path, "anstranslator")
             if is_windows:
-                command += ".exe"
+                executable_path += ".exe"
 
         if not working_dir:
             working_dir = os.path.dirname(input_file)
         cmd_translator = [
-            command,
+            executable_path,
             input_file,
             os.path.join(working_dir, aedb_name),
             "-l={}".format(os.path.join(working_dir, "Translator.log")),
@@ -830,7 +835,10 @@ class Edb(EdbInit):
             cmd_translator.append('-t="{}"'.format(tech_file))
         if layer_filter:
             cmd_translator.append('-f="{}"'.format(layer_filter))
-        subprocess.run(cmd_translator)
+        try:
+            subprocess.run(cmd_translator, check=True)  # nosec
+        except subprocess.CalledProcessError as e:  # nosec
+            raise RuntimeError("An error occurred while translating board file to ``edb.def`` file") from e
         if not os.path.exists(os.path.join(working_dir, aedb_name)):
             self.logger.error("Translator failed to translate.")
             return False
@@ -1340,6 +1348,11 @@ class Edb(EdbInit):
     ):
         """Import GDS file.
 
+        .. 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
         ----------
         inputGDS : str
@@ -1358,7 +1371,7 @@ class Edb(EdbInit):
             Layer filter file.
         """
         control_file_temp = os.path.join(tempfile.gettempdir(), os.path.split(inputGDS)[-1][:-3] + "xml")
-        if float(self.edbversion) < 2024.1:
+        if float(self.version) < 2024.1:
             if not is_linux and tech_file:
                 self.logger.error("Technology files are supported only in Linux. Use control file instead.")
                 return False
@@ -1403,9 +1416,12 @@ class Edb(EdbInit):
                     f'-f="{layer_filter}"',
                 ]
 
-            result = subprocess.run(command, capture_output=True, text=True, shell=True)
-            print(result.stdout)
-            print(command)
+            try:
+                result = subprocess.run(command, capture_output=True, text=True, check=True)  # nosec
+                print(result.stdout)
+                print(command)
+            except subprocess.CalledProcessError as e:  # nosec
+                raise RuntimeError("An error occurred while converting file") from e
             temp_inputGDS = inputGDS.split(".gds")[0]
             self.edbpath = temp_inputGDS + ".aedb"
             return self.open()
@@ -3046,7 +3062,7 @@ class Edb(EdbInit):
         if name in self.setups:
             self.logger.error("Setup name already used in the layout")
             return False
-        version = self.edbversion.split(".")
+        version = self.version.split(".")
         if int(version[0]) >= 2024 and int(version[-1]) >= 2 or int(version[0]) > 2024:
             setup = GrpcRaptorXSimulationSetup.create(cell=self.active_cell, name=name)
             return RaptorXSimulationSetup(self, setup)
@@ -3237,7 +3253,7 @@ class Edb(EdbInit):
         defined_ports = {}
         project_connexions = None
         for edb_path, zone_info in zone_dict.items():
-            edb = Edb(edbversion=self.edbversion, edbpath=edb_path)
+            edb = Edb(edbversion=self.version, edbpath=edb_path)
             edb.cutout(
                 use_pyaedt_cutout=True,
                 custom_extent=zone_info[1],
@@ -3779,7 +3795,7 @@ class Edb(EdbInit):
                 "No padstack instances found inside evaluated voids during model creation for arbitrary waveports"
             )
             return False
-        cloned_edb = Edb(edbpath=output_edb, edbversion=self.edbversion, restart_rpc_server=True)
+        cloned_edb = Edb(edbpath=output_edb, edbversion=self.version, restart_rpc_server=True)
 
         cloned_edb.stackup.add_layer(
             layer_name="ports",
@@ -3908,6 +3924,11 @@ class Edb(EdbInit):
     def compare(self, input_file, results=""):
         """Compares current open database with another one.
 
+        .. 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
         ----------
         input_file : str
@@ -3924,13 +3945,18 @@ class Edb(EdbInit):
         if not results:
             results = self.edbpath[:-5] + "_compare_results"
             os.mkdir(results)
-        command = os.path.join(self.base_path, "EDBDiff.exe")
+        executable_path = os.path.join(self.base_path, "EDBDiff.exe")
         if is_linux:
             mono_path = os.path.join(self.base_path, "common/mono/Linux64/bin/mono")
-            cmd_input = [mono_path, command, input_file, self.edbpath, results]
+            command = [mono_path, executable_path, input_file, self.edbpath, results]
         else:
-            cmd_input = [command, input_file, self.edbpath, results]
-        subprocess.run(cmd_input)
+            command = [executable_path, input_file, self.edbpath, results]
+        try:
+            subprocess.run(command, check=True)  # nosec
+        except subprocess.CalledProcessError as e:  # nosec
+            raise RuntimeError(
+                "EDBDiff.exe execution failed. Please check if the executable is present in the base path."
+            )
 
         if not os.path.exists(os.path.join(results, "EDBDiff.csv")):
             self.logger.error("Comparison execution failed")

pyedb/grpc/edb_init.py

@@ -43,23 +43,23 @@ class EdbInit(object):
     def __init__(self, edbversion):
         self.logger = settings.logger
         self._db = None
-        self.edbversion = edbversion
+        self.version = edbversion
         self.logger.info("Logger is initialized in EDB.")
         self.logger.info("legacy v%s", __version__)
         self.logger.info("Python version %s", sys.version)
         self.session = None
         if is_linux:
-            if env_value(self.edbversion) in os.environ:
-                self.base_path = env_path(self.edbversion)
+            if env_value(self.version) in os.environ:
+                self.base_path = env_path(self.version)
                 sys.path.append(self.base_path)
             else:
                 edb_path = os.getenv("PYAEDT_SERVER_AEDT_PATH")
                 if edb_path:
                     self.base_path = edb_path
                     sys.path.append(edb_path)
-                    os.environ[env_value(self.edbversion)] = self.base_path
+                    os.environ[env_value(self.version)] = self.base_path
         else:
-            self.base_path = env_path(self.edbversion)
+            self.base_path = env_path(self.version)
             sys.path.append(self.base_path)
         os.environ["ECAD_TRANSLATORS_INSTALL_DIR"] = self.base_path
         oa_directory = os.path.join(self.base_path, "common", "oa")
@@ -100,7 +100,7 @@ class EdbInit(object):
         """
         if not RpcSession.pid:
             RpcSession.start(
-                edb_version=self.edbversion,
+                edb_version=self.version,
                 port=port,
                 restart_server=restart_rpc_server,
             )
@@ -133,7 +133,7 @@ class EdbInit(object):
             RpcSession.pid = 0
         if not RpcSession.pid:
             RpcSession.start(
-                edb_version=self.edbversion,
+                edb_version=self.version,
                 port=port,
                 restart_server=restart_rpc_server,
             )
@@ -372,18 +372,6 @@ class EdbInit(object):
         """
         self._db.import_material_from_control_file(control_file, schema_dir, append)
 
-    @property
-    def version(self):
-        """Get version of the Database.
-
-        Returns
-        -------
-        tuple(int, int)
-            A tuple of the version numbers [major, minor]
-        """
-        major, minor = self._db.version
-        return major, minor
-
     def scale(self, scale_factor):
         """Uniformly scale all geometry and their locations by a positive factor.
 

pyedb/misc/aedtlib_personalib_install.py

@@ -20,8 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from xml.dom.minidom import parseString
-import xml.etree.ElementTree as ET
+import defusedxml.ElementTree as ET
+from defusedxml.minidom import parseString
 
 
 def write_pretty_xml(root, file_path):

pyedb/misc/downloads.py

@@ -24,6 +24,7 @@
 
 import os
 import shutil
+import subprocess  # nosec B404
 import tempfile
 import urllib.request
 import zipfile
@@ -48,7 +49,18 @@ def _get_file_url(directory, filename=None):
 
 
 def _retrieve_file(url, filename, directory, destination=None, local_paths=[]):  # pragma: no cover
-    """Download a file from a url"""
+    """Download a file from a url
+
+    .. 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.
+
+    """
+    # Check that provided url is pointing to pyaedt-example repo
+    if not url.startswith(EXAMPLE_REPO):
+        raise ValueError(f"Attempting to download file(s) from url {url} not pointing the to example-data repo.")
+
     # First check if file has already been downloaded
     if not destination:
         destination = EXAMPLES_PATH
@@ -64,8 +76,11 @@ def _retrieve_file(url, filename, directory, destination=None, local_paths=[]):
         os.makedirs(destination_dir)
     # Perform download
     if is_linux:
-        command = "wget {} -O {}".format(url, local_path)
-        os.system(command)
+        command = ["wget", url, "-O", local_path]
+        try:
+            subprocess.run(command, check=True)  # nosec
+        except subprocess.CalledProcessError as e:  # nosec
+            raise RuntimeError("An error occurred while downloading wget") from e
     else:
         _, resp = urlretrieve(url, local_path)
     local_paths.append(local_path)

pyedb/misc/siw_feature_config/emc_rule_checker_settings.py

@@ -23,6 +23,7 @@
 from copy import deepcopy as copy
 import json
 
+from defusedxml.ElementTree import parse as defused_parse
 import numpy as np
 
 from pyedb.generic.general_methods import ET
@@ -78,7 +79,7 @@ class EMCRuleCheckerSettings:
         fpath: str
             Path to file.
         """
-        tree = ET.parse(fpath)
+        tree = defused_parse(fpath)
         root = tree.getroot()
 
         self.tag_library = TagLibrary(root.find("TagLibrary"))

pyedb/misc/siw_feature_config/xtalk_scan/scan_config.py

@@ -22,7 +22,6 @@
 
 from enum import Enum
 import os
-import xml.etree as ET
 
 from pyedb.generic.general_methods import ET
 from pyedb.misc.siw_feature_config.xtalk_scan.fd_xtalk_scan_config import (