pyedb 0.43.0__py3-none-any.whl → 0.45.0__py3-none-any.whl

pyedb/grpc/database/terminal/padstack_instance_terminal.py

@@ -20,10 +20,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from ansys.edb.core.terminal.terminals import (
+from ansys.edb.core.terminal.padstack_instance_terminal import (
     PadstackInstanceTerminal as GrpcPadstackInstanceTerminal,
 )
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
+from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
+
+from pyedb.misc.misc import deprecated_property
 
 
 class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
@@ -45,6 +47,18 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
         pos_x, pos_y, rotation = self.padstack_instance.get_position_and_rotation()
         return [pos_x.value, pos_y.value]
 
+    @property
+    def padstack_instance(self):
+        from pyedb.grpc.database.primitive.padstack_instance import PadstackInstance
+
+        return PadstackInstance(self._pedb, super().padstack_instance)
+
+    @property
+    def component(self):
+        from pyedb.grpc.database.hierarchy.component import Component
+
+        return Component(self._pedb, super().component)
+
     @property
     def location(self):
         """Terminal position.
@@ -169,3 +183,29 @@ class PadstackInstanceTerminal(GrpcPadstackInstanceTerminal):
             "pec": GrpcBoundaryType.PEC,
         }
         super(PadstackInstanceTerminal, self.__class__).boundary_type.__set__(self, mapping[value.name.lower()])
+
+    @property
+    def is_port(self):
+        if self.boundary_type == "port":
+            return True
+        return False
+
+    @property
+    @deprecated_property
+    def ref_terminal(self):
+        """Return reference terminal.
+
+        ..deprecated:: 0.43.0
+           Use: func:`reference_terminal` property instead.
+        """
+        self._pedb.logger.warning("ref_terminal property is deprecated, use reference_terminal property instead.")
+        return self.reference_terminal
+
+    @ref_terminal.setter
+    def ref_terminal(self, value):
+        if isinstance(value, PadstackInstanceTerminal):
+            self.reference_terminal = value
+
+    @property
+    def terminal_type(self):
+        return "PadstackInstanceTerminal"

pyedb/grpc/database/terminal/pingroup_terminal.py

@@ -20,10 +20,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
-from ansys.edb.core.terminal.terminals import PinGroupTerminal as GrpcPinGroupTerminal
+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.misc.misc import deprecated_property
 
 
 class PinGroupTerminal(GrpcPinGroupTerminal):
@@ -56,6 +59,12 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
             value = GrpcBoundaryType.VOLTAGE_PROBE
         super(PinGroupTerminal, self.__class__).boundary_type.__set__(self, value)
 
+    @property
+    def is_port(self):
+        if self.boundary_type == "port":
+            return True
+        return False
+
     @property
     def magnitude(self):
         """Source magnitude.
@@ -160,3 +169,40 @@ class PinGroupTerminal(GrpcPinGroupTerminal):
         from pyedb.grpc.database.hierarchy.pingroup import PinGroup
 
         return PinGroup(self._pedb, super().pin_group)
+
+    @property
+    def terminal_type(self):
+        return "PinGroupTerminal"
+
+    @property
+    @deprecated_property
+    def ref_terminal(self):
+        """Property keeping DotNet compatibility
+
+        ..deprecated:: 0.43.0
+           Use: func:`reference_terminal` property instead.
+
+        """
+        self._pedb.logger.warning("ref_terminal property is deprecated, use reference_terminal property instead.")
+        return PinGroupTerminal(self._pedb, self.reference_terminal)
+
+    @ref_terminal.setter
+    def ref_terminal(self, value):
+        self._pedb.logger.warning("ref_terminal is deprecated, use reference_terminal instead.")
+        self.reference_terminal = value
+
+    @property
+    def hfss_type(self):
+        return "circuit"
+
+    @property
+    def is_current_source(self):
+        if self.boundary_type == "current_source":
+            return True
+        return False
+
+    @property
+    def is_voltage_source(self):
+        if self.boundary_type == "voltage_source":
+            return True
+        return False

pyedb/grpc/database/terminal/point_terminal.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
-from ansys.edb.core.terminal.terminals import PointTerminal as GrpcPointTerminal
+from ansys.edb.core.terminal.point_terminal import PointTerminal as GrpcPointTerminal
 from ansys.edb.core.utility.value import Value as GrpcValue
 
 
@@ -97,3 +97,12 @@ class PointTerminal(GrpcPointTerminal):
     @reference_terminal.setter
     def reference_terminal(self, value):
         super(PointTerminal, self.__class__).reference_terminal.__set__(self, value)
+
+    @property
+    def terminal_type(self):
+        return "PointTerminal"
+
+    @property
+    def is_port(self):
+        """Adding DotNet compatibility."""
+        return True

pyedb/grpc/database/terminal/terminal.py

@@ -22,10 +22,10 @@
 
 import re
 
-from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
-from ansys.edb.core.terminal.terminals import EdgeType as GrpcEdgeType
-from ansys.edb.core.terminal.terminals import Terminal as GrpcTerminal
-from ansys.edb.core.terminal.terminals import TerminalType as GrpcTerminalType
+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.utility.value import Value as GrpcValue
 
 from pyedb.dotnet.database.edb_data.padstacks_data import EDBPadstackInstance

pyedb/grpc/database/utility/hfss_extent_info.py

@@ -20,7 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from ansys.edb.core.utility.hfss_extent_info import (
+    HFSSExtentInfoType as GrpcHfssExtentInfoType,
+)
 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
 
 
@@ -37,14 +41,14 @@ class HfssExtentInfo(GrpcHfssExtentInfo):
         self._pedb = pedb
         super().__init__()
         self.extent_type_mapping = {
-            "bounding_box": GrpcHfssExtentInfo.HFSSExtentInfoType.BOUNDING_BOX,
-            "conforming": GrpcHfssExtentInfo.HFSSExtentInfoType.CONFORMING,
-            "convex_hull": GrpcHfssExtentInfo.HFSSExtentInfoType.CONVEX_HUL,
-            "polygon": GrpcHfssExtentInfo.HFSSExtentInfoType.POLYGON,
+            "bounding_box": GrpcHfssExtentInfoType.BOUNDING_BOX,
+            "conforming": GrpcHfssExtentInfoType.CONFORMING,
+            "convex_hull": GrpcHfssExtentInfoType.CONVEX_HUL,
+            "polygon": GrpcHfssExtentInfoType.POLYGON,
         }
         self._open_region_type = {
-            "radiation": GrpcHfssExtentInfo.OpenRegionType.RADIATION,
-            "pml": GrpcHfssExtentInfo.OpenRegionType.PML,
+            "radiation": GrpcOpenRegionType.RADIATION,
+            "pml": GrpcOpenRegionType.PML,
         }
         self.hfss_extent_type = self._hfss_extent_info.extent_type
 
@@ -258,13 +262,13 @@ class HfssExtentInfo(GrpcHfssExtentInfo):
         hfss_extent = self._hfss_extent_info
         if isinstance(value, str):
             if value.lower() == "bounding_box":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.BOUNDING_BOX
+                value = GrpcHfssExtentInfoType.BOUNDING_BOX
             elif value.lower() == "conforming":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.CONFORMING
+                value = GrpcHfssExtentInfoType.CONFORMING
             elif value.lower() == "convex_hul":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.CONVEX_HUL
+                value = GrpcHfssExtentInfoType.CONVEX_HUL
             elif value.lower() == "polygon":
-                value = GrpcHfssExtentInfo.HFSSExtentInfoType.POLYGON
+                value = GrpcHfssExtentInfoType.POLYGON
             else:
                 raise f"Invalid extent type : {value}"
         hfss_extent.extent_type = value

pyedb/grpc/edb.py

@@ -198,7 +198,6 @@ class Edb(EdbInit):
         use_ppe=False,
         technology_file=None,
         restart_rpc_server=False,
-        kill_all_instances=False,
     ):
         edbversion = get_string_version(edbversion)
         self._clean_variables()
@@ -273,9 +272,9 @@ class Edb(EdbInit):
             self.logger.info("EDB %s was created correctly from %s file.", self.edbpath, edbpath[-2:])
         elif edbpath.endswith("edb.def"):
             self.edbpath = os.path.dirname(edbpath)
-            self.open_edb(restart_rpc_server=restart_rpc_server, kill_all_instances=kill_all_instances)
+            self.open_edb(restart_rpc_server=restart_rpc_server)
         elif not os.path.exists(os.path.join(self.edbpath, "edb.def")):
-            self.create_edb(restart_rpc_server=restart_rpc_server, kill_all_instances=kill_all_instances)
+            self.create_edb(restart_rpc_server=restart_rpc_server)
             self.logger.info("EDB %s created correctly.", self.edbpath)
         elif ".aedb" in edbpath:
             self.edbpath = edbpath
@@ -290,8 +289,7 @@ class Edb(EdbInit):
         return self
 
     def __exit__(self, ex_type, ex_value, ex_traceback):
-        if ex_type:
-            self.edb_exception(ex_value, ex_traceback)
+        self._signal_handler(ex_type, ex_value)
 
     def __getitem__(self, variable_name):
         """Get a variable to the Edb project. The variable can be project using ``$`` prefix or
@@ -493,7 +491,9 @@ class Edb(EdbInit):
         """
         terminals = [term for term in self.layout.terminals if not term.is_reference_terminal]
         ports = {}
+        from pyedb.grpc.database.ports.ports import WavePort
         from pyedb.grpc.database.terminal.bundle_terminal import BundleTerminal
+        from pyedb.grpc.database.terminal.edge_terminal import EdgeTerminal
         from pyedb.grpc.database.terminal.padstack_instance_terminal import (
             PadstackInstanceTerminal,
         )
@@ -504,6 +504,11 @@ class Edb(EdbInit):
                 ports[bundle_ter.name] = bundle_ter
             elif isinstance(t, PadstackInstanceTerminal):
                 ports[t.name] = CoaxPort(self, t)
+            elif isinstance(t, EdgeTerminal):
+                if t.is_wave_port:
+                    ports[t.name] = WavePort(self, t)
+                else:
+                    ports[t.name] = EdgeTerminal(self, t)
             else:
                 ports[t.name] = GapPort(self, t)
         return ports
@@ -572,7 +577,6 @@ class Edb(EdbInit):
                     self.edbpath,
                     self.isreadonly,
                     restart_rpc_server=restart_rpc_server,
-                    kill_all_instances=kill_all_instances,
                 )
                 n_try -= 1
             except Exception as e:
@@ -613,7 +617,7 @@ class Edb(EdbInit):
         n_try = 10
         while not self.db and n_try:
             try:
-                self.create(self.edbpath, restart_rpc_server=restart_rpc_server, kill_all_instances=kill_all_instances)
+                self.create(self.edbpath, restart_rpc_server=restart_rpc_server)
                 n_try -= 1
             except Exception as e:
                 self.logger.error(e.args[0])
@@ -1085,7 +1089,7 @@ class Edb(EdbInit):
         :class:`Circle <pyedb.grpc.database.primitive.circle.Circle>`,
         :class:`Polygon <pyedb.grpc.database.primitive.polygon.Polygon>`]
         """
-        from ansys.edb.core.terminal.terminals import (
+        from ansys.edb.core.terminal.padstack_instance_terminal import (
             PadstackInstanceTerminal as GrpcPadstackInstanceTerminal,
         )
 
@@ -2015,8 +2019,8 @@ class Edb(EdbInit):
                     nets_to_preserve.extend(el.nets)
         if include_pingroups:
             for pingroup in self.layout.pin_groups:
-                for pin in pingroup.pins:
-                    if pin.net_name in reference_list:
+                for pin_name, pin in pingroup.pins.items():
+                    if pin_name in reference_list:
                         pins_to_preserve.append(pin.edb_uid)
         if check_terminals:
             terms = [
@@ -2324,7 +2328,7 @@ class Edb(EdbInit):
             ids.append(lobj.id)
         if include_partial_instances:
             from ansys.edb.core.geometry.point_data import PointData as GrpcPointData
-            from ansys.edb.core.primitive.primitive import (
+            from ansys.edb.core.primitive.padstack_instance import (
                 PadstackInstance as GrpcPadstackInstance,
             )
 
@@ -3384,15 +3388,15 @@ class Edb(EdbInit):
         list: [:class:`GapPort <pyedb.grpc.database.ports.ports.GapPort`>,
             :class:`WavePort <pyedb.grpc.database.ports.ports.WavePort>`].
         """
-        from ansys.edb.core.terminal.terminals import BoundaryType as GrpcBoundaryType
+        from ansys.edb.core.terminal.terminal import BoundaryType as GrpcBoundaryType
 
-        if isinstance(terminal.boundary_type, GrpcBoundaryType):
+        if terminal.boundary_type == "port":
             terminal.boundary_type = GrpcBoundaryType.PORT
         terminal.is_circuit_port = is_circuit_port
-
-        if isinstance(ref_terminal.boundary_type, GrpcBoundaryType):
-            ref_terminal.boundary_type = GrpcBoundaryType.PORT
-        terminal.ref_terminal = ref_terminal
+        if ref_terminal:
+            if ref_terminal.boundary_type == "port":
+                ref_terminal.boundary_type = GrpcBoundaryType.PORT
+            terminal.reference_terminal = ref_terminal
         if name:
             terminal.name = name
         return self.ports[terminal.name]

pyedb/grpc/edb_init.py

@@ -22,7 +22,9 @@
 
 
 """Database."""
+import atexit
 import os
+import signal
 import sys
 
 import ansys.edb.core.database as database
@@ -68,13 +70,22 @@ class EdbInit(object):
         oa_directory = os.path.join(self.base_path, "common", "oa")
         os.environ["ANSYS_OADIR"] = oa_directory
         os.environ["PATH"] = "{};{}".format(os.environ["PATH"], self.base_path)
+        # register server kill
+        atexit.register(self._signal_handler)
+        # register signal handlers
+        signal.signal(signal.SIGTERM, self._signal_handler)
+        signal.signal(signal.SIGINT, self._signal_handler)
+
+    @staticmethod
+    def _signal_handler(signum=None, frame=None):
+        RpcSession.kill()
 
     @property
     def db(self):
         """Active database object."""
         return self._db
 
-    def create(self, db_path, port=0, restart_rpc_server=False, kill_all_instances=False):
+    def create(self, db_path, port=0, restart_rpc_server=False):
         """Create a Database at the specified file location.
 
         Parameters
@@ -82,12 +93,12 @@ class EdbInit(object):
         db_path : str
             Path to top-level database folder
 
+        port : int
+            grpc port number.
+
         restart_rpc_server : optional, bool
             Force restarting RPC server when `True`.Default value is `False`
 
-        kill_all_instances : optional, bool.
-            Force killing all RPC server instances, must be used with caution. Default value is `False`.
-
         Returns
         -------
         Database
@@ -97,7 +108,6 @@ class EdbInit(object):
                 edb_version=self.edbversion,
                 port=port,
                 restart_server=restart_rpc_server,
-                kill_all_instances=kill_all_instances,
             )
             if not RpcSession.pid:
                 self.logger.error("Failed to start RPC server.")
@@ -105,7 +115,7 @@ class EdbInit(object):
         self._db = database.Database.create(db_path)
         return self._db
 
-    def open(self, db_path, read_only, port=0, restart_rpc_server=False, kill_all_instances=False):
+    def open(self, db_path, read_only, port=0, restart_rpc_server=False):
         """Open an existing Database at the specified file location.
 
         Parameters
@@ -115,11 +125,9 @@ class EdbInit(object):
         read_only : bool
             Obtain read-only access.
         port : optional, int.
-            Specify the port number.If not provided a randon free one is selected. Default value is `0`.
+            Specify the port number. If not provided a randon free one is selected. Default value is `0`.
         restart_rpc_server : optional, bool
             Force restarting RPC server when `True`. Default value is `False`.
-        kill_all_instances : optional, bool.
-            Force killing all RPC server instances, must be used with caution. Default value is `False`.
 
         Returns
         -------
@@ -133,7 +141,6 @@ class EdbInit(object):
                 edb_version=self.edbversion,
                 port=port,
                 restart_server=restart_rpc_server,
-                kill_all_instances=kill_all_instances,
             )
             if not RpcSession.pid:
                 self.logger.error("Failed to start RPC server.")
@@ -154,7 +161,7 @@ class EdbInit(object):
         """Save any changes into a file."""
         return self._db.save()
 
-    def close(self, terminate_rpc_session=True, kill_all_instances=False):
+    def close(self, terminate_rpc_session=True):
         """Close the database.
 
         Parameters
@@ -167,10 +174,7 @@ class EdbInit(object):
         """
         self._db.close()
         self._db = None
-        if kill_all_instances:
-            RpcSession._kill_all_instances()
-            RpcSession.pid = 0
-        elif terminate_rpc_session:
+        if terminate_rpc_session:
             RpcSession.rpc_session.disconnect()
             RpcSession.pid = 0
         return True

pyedb/grpc/rpc_session.py

@@ -50,7 +50,7 @@ class RpcSession:
     port = 10000
 
     @staticmethod
-    def start(edb_version, port=0, restart_server=False, kill_all_instances=False):
+    def start(edb_version, port=0, restart_server=False):
         """Start RPC-server, the server must be started before opening EDB.
 
         Parameters
@@ -107,10 +107,7 @@ class RpcSession:
         if RpcSession.pid:
             if restart_server:
                 pyedb_logger.logger.info("Restarting RPC server")
-                if kill_all_instances:
-                    RpcSession.__kill_all_instances()
-                else:
-                    RpcSession.__kill()
+                RpcSession.kill()
                 RpcSession.__start_rpc_server()
             else:
                 pyedb_logger.info(f"Server already running on port {RpcSession.port}")
@@ -141,13 +138,18 @@ class RpcSession:
             pyedb_logger.logger.info("Grpc session started")
 
     @staticmethod
-    def __kill():
+    def kill():
         p = psutil.Process(RpcSession.pid)
         time.sleep(latency_delay)
-        p.terminate()
+        try:
+            p.terminate()
+            print(f"RPC session pid: {RpcSession.pid} killed due to execution failure.")
+            RpcSession.pid = 0
+        except:
+            print("RPC session closed.")
 
     @staticmethod
-    def _kill_all_instances():
+    def kill_all_instances():
         proc = [p.pid for p in list(psutil.process_iter()) if "edb_rpc" in p.name().lower()]
         time.sleep(latency_delay)
         for pid in proc:
@@ -163,6 +165,7 @@ class RpcSession:
             end_managing()
             RpcSession.rpc_session.disconnect()
             time.sleep(latency_delay)
+            RpcSession.__get_process_id()
 
     @staticmethod
     def __get_random_free_port():

pyedb/misc/misc.py

@@ -87,3 +87,16 @@ def current_student_version():
         if "SV" in version_key:
             return version_key
     return ""
+
+
+def deprecated_property(func):
+    """
+    This decorator marks a property as deprecated.
+    It will emit a warning when the property is accessed.
+    """
+
+    def wrapper(*args, **kwargs):
+        warnings.warn(f"Access to deprecated property {func.__name__}.", category=DeprecationWarning, stacklevel=2)
+        return func(*args, **kwargs)
+
+    return wrapper

{pyedb-0.43.0.dist-info → pyedb-0.45.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyedb
-Version: 0.43.0
+Version: 0.45.0
 Summary: Higher-Level Pythonic Ansys Electronics Data Base
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: PyEDB developers <simon.vandenbrouck@ansys.com>
@@ -127,15 +127,15 @@ Documentation for the latest stable release of PyEDB is hosted at
 [PyEDB documentation](https://edb.docs.pyansys.com/version/stable/index.html).
 The documentation has five sections:
 
-- [Getting started](https://edb.docs.pyansys.com/version/version/stable/getting_started/index.html): Describes
+- [Getting started](https://edb.docs.pyansys.com/version/stable/getting_started/index.html): Describes
   how to install PyEDB in user mode.
-- [User guide](https://edb.docs.pyansys.com/version/version/stable/user_guide/index.html): Describes how to
+- [User guide](https://edb.docs.pyansys.com/version/stable/user_guide/index.html#user-guide): Describes how to
   use PyEDB.
-- [API reference](https://edb.docs.pyansys.com/version/version/stable/api/index.html): Provides API member descriptions
+- [API reference](https://edb.docs.pyansys.com/version/stable/api/index.html): Provides API member descriptions
   and usage examples.
-- [Examples](https://edb.docs.pyansys.com/version/version/stable/examples/index.html): Provides examples showing
+- [Examples](https://examples.aedt.docs.pyansys.com/version/dev/examples/high_frequency/layout/index.html): Provides examples showing
   end-to-end workflows for using PyEDB.
-- [Contribute](https://edb.docs.pyansys.com/version/version/stable/contribute.html): Describes how to install
+- [Contribute](https://edb.docs.pyansys.com/version/stable/contributing.html): Describes how to install
   PyEDB in developer mode and how to contribute to this PyAnsys library.
 
 In the upper right corner of the documentation's title bar, there is an option