pyedb 0.38.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

pyedb/grpc/edb_init.py

@@ -0,0 +1,481 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+"""Database."""
+import os
+import sys
+
+import ansys.edb.core.database as database
+
+from pyedb import __version__
+from pyedb.edb_logger import pyedb_logger
+from pyedb.generic.general_methods import env_path, env_value, is_linux
+from pyedb.grpc.rpc_session import RpcSession
+from pyedb.misc.misc import list_installed_ansysem
+
+
+class EdbInit(object):
+    """Edb Dot Net Class."""
+
+    def __init__(self, edbversion):
+        self.logger = pyedb_logger
+        self._db = None
+        if not edbversion:  # pragma: no cover
+            try:
+                edbversion = "20{}.{}".format(list_installed_ansysem()[0][-3:-1], list_installed_ansysem()[0][-1:])
+                self.logger.info("Edb version " + edbversion)
+            except IndexError:
+                raise Exception("No ANSYSEM_ROOTxxx is found.")
+        self.edbversion = 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)
+                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
+        else:
+            self.base_path = env_path(self.edbversion)
+            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")
+        os.environ["ANSYS_OADIR"] = oa_directory
+        os.environ["PATH"] = "{};{}".format(os.environ["PATH"], self.base_path)
+
+    @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):
+        """Create a Database at the specified file location.
+
+        Parameters
+        ----------
+        db_path : str
+            Path to top-level database folder
+
+        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
+        """
+        if not RpcSession.pid:
+            RpcSession.start(
+                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.")
+                return False
+        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):
+        """Open an existing Database at the specified file location.
+
+        Parameters
+        ----------
+        db_path : str
+            Path to top-level Database folder.
+        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`.
+        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 or None
+            The opened Database object, or None if not found.
+        """
+        if restart_rpc_server:
+            RpcSession.pid = 0
+        if not RpcSession.pid:
+            RpcSession.start(
+                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.")
+                return False
+        self._db = database.Database.open(db_path, read_only)
+
+    def delete(self, db_path):
+        """Delete a database at the specified file location.
+
+        Parameters
+        ----------
+        db_path : str
+            Path to top-level database folder.
+        """
+        return database.Database.delete(db_path)
+
+    def save(self):
+        """Save any changes into a file."""
+        return self._db.save()
+
+    def close(self, terminate_rpc_session=True, kill_all_instances=False):
+        """Close the database.
+
+        Parameters
+        ----------
+        terminate_rpc_session : bool, optional
+
+
+        . note::
+            Unsaved changes will be lost.
+        """
+        self._db.close()
+        self._db = None
+        if kill_all_instances:
+            RpcSession._kill_all_instances()
+            RpcSession.pid = 0
+        elif terminate_rpc_session:
+            RpcSession.rpc_session.disconnect()
+            RpcSession.pid = 0
+        return True
+
+    @property
+    def top_circuit_cells(self):
+        """Get top circuit cells.
+
+        Returns
+        -------
+        list[:class:`Cell <ansys.edb.layout.Cell>`]
+        """
+        return [i for i in self._db.top_circuit_cells]
+
+    @property
+    def circuit_cells(self):
+        """Get all circuit cells in the Database.
+
+        Returns
+        -------
+        list[:class:`Cell <ansys.edb.layout.Cell>`]
+        """
+        return [i for i in self._db.circuit_cells]
+
+    @property
+    def footprint_cells(self):
+        """Get all footprint cells in the Database.
+
+        Returns
+        -------
+        list[:class:`Cell <ansys.edb.layout.Cell>`]
+        """
+        return [i for i in self._db.footprint_cells]
+
+    @property
+    def edb_uid(self):
+        """Get ID of the database.
+
+        Returns
+        -------
+        int
+            The unique EDB id of the Database.
+        """
+        return self._db.id
+
+    @property
+    def is_read_only(self):
+        """Determine if the database is open in a read-only mode.
+
+        Returns
+        -------
+        bool
+            True if Database is open with read only access, otherwise False.
+        """
+        return self._db.is_read_only
+
+    def find_by_id(self, db_id):
+        """Find a database by ID.
+
+        Parameters
+        ----------
+        db_id : int
+            The Database's unique EDB id.
+
+        Returns
+        -------
+        Database
+            The Database or Null on failure.
+        """
+        return database.Database.find_by_id(db_id)
+
+    def save_as(self, path, version=""):
+        """Save this Database to a new location and older EDB version.
+
+        Parameters
+        ----------
+        path : str
+            New Database file location.
+        version : str
+            EDB version to save to. Empty string means current version.
+        """
+        self._db.save_as(path, version)
+
+    @property
+    def directory(self):
+        """Get the directory of the Database.
+
+        Returns
+        -------
+        str
+            Directory of the Database.
+        """
+        return self._db.directory
+
+    def get_product_property(self, prod_id, attr_it):
+        """Get the product-specific property value.
+
+        Parameters
+        ----------
+        prod_id : ProductIdType
+            Product ID.
+        attr_it : int
+            Attribute ID.
+
+        Returns
+        -------
+        str
+            Property value returned.
+        """
+        return self._db.get_product_property(prod_id, attr_it)
+
+    def set_product_property(self, prod_id, attr_it, prop_value):
+        """Set the product property associated with the given product and attribute ids.
+
+        Parameters
+        ----------
+        prod_id : ProductIdType
+            Product ID.
+        attr_it : int
+            Attribute ID.
+        prop_value : str
+            Product property's new value
+        """
+        self._db.set_product_property(prod_id, attr_it, prop_value)
+
+    def get_product_property_ids(self, prod_id):
+        """Get a list of attribute ids corresponding to a product property id.
+
+        Parameters
+        ----------
+        prod_id : ProductIdType
+            Product ID.
+
+        Returns
+        -------
+        list[int]
+            The attribute ids associated with this product property.
+        """
+        return self._db.get_product_property_ids(prod_id)
+
+    def import_material_from_control_file(self, control_file, schema_dir=None, append=True):
+        """Import materials from the provided control file.
+
+        Parameters
+        ----------
+        control_file : str
+            Control file name with full path.
+        schema_dir : str
+            Schema file path.
+        append : bool
+            True if the existing materials in Database are kept. False to remove existing materials in database.
+        """
+        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.
+
+        Parameters
+        ----------
+        scale_factor : float
+            Amount that coordinates are multiplied by.
+        """
+        return self._db.scale(scale_factor)
+
+    @property
+    def source(self):
+        """Get source name for this Database.
+
+        This attribute is also used to set the source name.
+
+        Returns
+        -------
+        str
+            name of the source
+        """
+        return self._db.source
+
+    @source.setter
+    def source(self, source):
+        """Set source name of the database."""
+        self._db.source = source
+
+    @property
+    def source_version(self):
+        """Get the source version for this Database.
+
+        This attribute is also used to set the version.
+
+        Returns
+        -------
+        str
+            version string
+
+        """
+        return self._db.source_version
+
+    @source_version.setter
+    def source_version(self, source_version):
+        """Set source version of the database."""
+        self._db.source_version = source_version
+
+    def copy_cells(self, cells_to_copy):
+        """Copy Cells from other Databases or this Database into this Database.
+
+        Parameters
+        ----------
+        cells_to_copy : list[:class:`Cell <ansys.edb.core.layout.cell.Cell>`]
+            Cells to copy.
+
+        Returns
+        -------
+        list[:class:`Cell <ansys.edb.core.layout.cell.Cell>`]
+        """
+        if not isinstance(cells_to_copy, list):
+            cells_to_copy = [cells_to_copy]
+        return self._db.copy_cells(cells_to_copy)
+
+    @property
+    def apd_bondwire_defs(self):
+        """Get all APD bondwire definitions in this Database.
+
+        Returns
+        -------
+        list[:class:`ApdBondwireDef <ansys.edb.definition.ApdBondwireDef>`]
+        """
+        return list(self._db.apd_bondwire_defs)
+
+    @property
+    def jedec4_bondwire_defs(self):
+        """Get all JEDEC4 bondwire definitions in this Database.
+
+        Returns
+        -------
+        list[:class:`Jedec4BondwireDef <ansys.edb.definition.Jedec4BondwireDef>`]
+        """
+        return list(self._db.jedec4_bondwire_defs)
+
+    @property
+    def jedec5_bondwire_defs(self):
+        """Get all JEDEC5 bondwire definitions in this Database.
+
+        Returns
+        -------
+        list[:class:`Jedec5BondwireDef <ansys.edb.definition.Jedec5BondwireDef>`]
+        """
+        return list(self._db.jedec5_bondwire_defs)
+
+    @property
+    def padstack_defs(self):
+        """Get all Padstack definitions in this Database.
+
+        Returns
+        -------
+        list[:class:`PadstackDef <ansys.edb.definition.PadstackDef>`]
+        """
+        return list(self._db.padstack_defs)
+
+    @property
+    def package_defs(self):
+        """Get all Package definitions in this Database.
+
+        Returns
+        -------
+        list[:class:`PackageDef <ansys.edb.definition.PackageDef>`]
+        """
+        return list(self._db.package_defs)
+
+    @property
+    def component_defs(self):
+        """Get all component definitions in the database.
+
+        Returns
+        -------
+        list[:class:`ComponentDef <ansys.edb.definition.ComponentDef>`]
+        """
+        return list(self._db.component_defs)
+
+    @property
+    def material_defs(self):
+        """Get all material definitions in the database.
+
+        Returns
+        -------
+        list[:class:`MaterialDef <ansys.edb.definition.MaterialDef>`]
+        """
+        return list(self._db.material_defs)
+
+    @property
+    def dataset_defs(self):
+        """Get all dataset definitions in the database.
+
+        Returns
+        -------
+        list[:class:`DatasetDef <ansys.edb.definition.DatasetDef>`]
+        """
+        return list(self._db.dataset_defs)

pyedb/grpc/rpc_session.py

@@ -0,0 +1,177 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import os
+from random import randint
+import sys
+import time
+
+from ansys.edb.core.session import launch_session
+from ansys.edb.core.utility.io_manager import (
+    IOMangementType,
+    end_managing,
+    start_managing,
+)
+import psutil
+
+from pyedb import __version__
+from pyedb.edb_logger import pyedb_logger
+from pyedb.generic.general_methods import env_path, env_value, is_linux
+from pyedb.misc.misc import list_installed_ansysem
+
+latency_delay = 0.1
+
+
+class RpcSession:
+    """Static Class managing RPC server."""
+
+    pid = 0
+    rpc_session = None
+    base_path = None
+    port = 10000
+
+    @staticmethod
+    def start(edb_version, port=0, restart_server=False, kill_all_instances=False):
+        """Start RPC-server, the server must be started before opening EDB.
+
+        Parameters
+        ----------
+        edb_version : str, optional.
+            Specify ANSYS version.
+            If None, the latest installation will be detected on the local machine.
+
+        port : int, optional
+            Port number used for the RPC session.
+            If not provided, a random free port is automatically selected.
+
+        restart_server : bool, optional.
+            Force restarting the RPC server by killing the process in case EDB_RPC is already started.
+            All open EDB
+            connection will be lost.
+            This option must be used at the beginning of an application only to ensure the
+            server is properly started.
+        kill_all_instances : bool, optional.
+            Force killing all RPC sever instances, including a zombie process.
+            To be used with caution, default value is `False`.
+        """
+        if not port:
+            RpcSession.port = RpcSession.__get_random_free_port()
+        else:
+            RpcSession.port = port
+        if not edb_version:  # pragma: no cover
+            try:
+                edb_version = "20{}.{}".format(list_installed_ansysem()[0][-3:-1], list_installed_ansysem()[0][-1:])
+                pyedb_logger.info("Edb version " + edb_version)
+            except IndexError:
+                raise Exception("No ANSYSEM_ROOTxxx is found.")
+        pyedb_logger.info("Logger is initialized in EDB.")
+        pyedb_logger.info("legacy v%s", __version__)
+        pyedb_logger.info("Python version %s", sys.version)
+        if is_linux:
+            if env_value(edb_version) in os.environ:
+                RpcSession.base_path = env_path(edb_version)
+                sys.path.append(RpcSession.base_path)
+            else:
+                edb_path = os.getenv("PYAEDT_SERVER_AEDT_PATH")
+                if edb_path:
+                    RpcSession.base_path = edb_path
+                    sys.path.append(edb_path)
+                    os.environ[env_value(edb_version)] = RpcSession.base_path
+        else:
+            RpcSession.base_path = env_path(edb_version)
+            sys.path.append(RpcSession.base_path)
+        os.environ["ECAD_TRANSLATORS_INSTALL_DIR"] = RpcSession.base_path
+        oa_directory = os.path.join(RpcSession.base_path, "common", "oa")
+        os.environ["ANSYS_OADIR"] = oa_directory
+        os.environ["PATH"] = "{};{}".format(os.environ["PATH"], RpcSession.base_path)
+
+        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.__start_rpc_server()
+            else:
+                pyedb_logger.info(f"Server already running on port {RpcSession.port}")
+        else:
+            RpcSession.__start_rpc_server()
+            if RpcSession.rpc_session:
+                RpcSession.server_pid = RpcSession.rpc_session.local_server_proc.pid
+                pyedb_logger.info(f"Grpc session started: pid={RpcSession.server_pid}")
+            else:
+                pyedb_logger.error("Failed to start EDB_RPC_server process")
+
+    @staticmethod
+    def __get_process_id():
+        proc = [p for p in list(psutil.process_iter()) if "edb_rpc" in p.name().lower()]
+        time.sleep(latency_delay)
+        if proc:
+            RpcSession.pid = proc[-1].pid
+        else:
+            RpcSession.pid = 0
+
+    @staticmethod
+    def __start_rpc_server():
+        RpcSession.rpc_session = launch_session(RpcSession.base_path, port_num=RpcSession.port)
+        start_managing(IOMangementType.READ_AND_WRITE)
+        time.sleep(latency_delay)
+        if RpcSession.rpc_session:
+            RpcSession.pid = RpcSession.rpc_session.local_server_proc.pid
+            pyedb_logger.logger.info("Grpc session started")
+
+    @staticmethod
+    def __kill():
+        p = psutil.Process(RpcSession.pid)
+        time.sleep(latency_delay)
+        p.terminate()
+
+    @staticmethod
+    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:
+            p = psutil.Process(pid)
+            p.terminate()
+
+    @staticmethod
+    def close():
+        """Terminate the current RPC session. Must be executed at the end of the script to close properly the session.
+        If not executed, users should force restarting the process using the flag `restart_server`=`True`.
+        """
+        if RpcSession.rpc_session:
+            end_managing()
+            RpcSession.rpc_session.disconnect()
+            time.sleep(latency_delay)
+
+    @staticmethod
+    def __get_random_free_port():
+        """"""
+        port = randint(49152, 65535)
+        while True:
+            used_ports = [conn.laddr[1] for conn in psutil.net_connections()]
+            if port in used_ports:
+                port = randint(49152, 65535)
+            else:
+                break
+        return port

pyedb/ipc2581/ecad/cad_data/assembly_drawing.py

@@ -27,9 +27,10 @@ from pyedb.ipc2581.ecad.cad_data.polygon import Polygon
 class AssemblyDrawing(object):
     """Class describing an IPC2581 assembly drawing."""
 
-    def __init__(self, ipc):
+    def __init__(self, ipc, pedb):
         self._ipc = ipc
-        self.polygon = Polygon(self._ipc)
+        self._pedb = pedb
+        self.polygon = Polygon(self._ipc, pedb)
         self.line_ref = ""
 
     def write_xml(self, package):  # pragma no cover

pyedb/ipc2581/ecad/cad_data/feature.py

@@ -30,15 +30,16 @@ from pyedb.ipc2581.ecad.cad_data.polygon import Polygon
 class Feature(object):
     """Class describing IPC2581 features."""
 
-    def __init__(self, ipc):
+    def __init__(self, ipc, pedb):
         self._ipc = ipc
+        self._pedb = pedb
         self.feature_type = FeatureType().Polygon
         self.net = ""
         self.x = 0.0
         self.y = 0.0
-        self.polygon = Polygon(self._ipc)
+        self.polygon = Polygon(self._ipc, self._pedb)
         self._cutouts = []
-        self.path = Path(self._ipc)
+        self.path = Path(self._ipc, pedb)
         # self.pad = PadstackDef()
         self.padstack_instance = PadstackInstance()
         self.drill = Drill()