pyedb 0.12.2__py3-none-any.whl → 0.13.dev0__py3-none-any.whl

pyedb/dotnet/edb_core/definition/component_def.py

@@ -23,7 +23,7 @@
 import os
 
 from pyedb.dotnet.edb_core.definition.component_model import NPortComponentModel
-from pyedb.dotnet.edb_core.obj_base import ObjBase
+from pyedb.dotnet.edb_core.utilities.obj_base import ObjBase
 from pyedb.generic.general_methods import pyedb_function_handler
 
 

pyedb/dotnet/edb_core/definition/component_model.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from pyedb.dotnet.edb_core.obj_base import ObjBase
+from pyedb.dotnet.edb_core.utilities.obj_base import ObjBase
 from pyedb.generic.general_methods import pyedb_function_handler
 
 

pyedb/dotnet/edb_core/definition/definition_obj.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from pyedb.dotnet.edb_core.obj_base import ObjBase
+from pyedb.dotnet.edb_core.utilities.obj_base import ObjBase
 
 
 class DefinitionObj(ObjBase):

pyedb/dotnet/edb_core/definition/package_def.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 from pyedb.dotnet.edb_core.geometry.polygon_data import PolygonData
-from pyedb.dotnet.edb_core.obj_base import ObjBase
+from pyedb.dotnet.edb_core.utilities.obj_base import ObjBase
 from pyedb.generic.general_methods import pyedb_function_handler
 
 
@@ -155,6 +155,7 @@ class PackageDef(ObjBase):
 
     @property
     def heatsink(self):
+        """Component heatsink."""
         from pyedb.dotnet.edb_core.utilities.heatsink import HeatSink
 
         flag, edb_object = self._edb_object.GetHeatSink()

pyedb/dotnet/edb_core/edb_data/components_data.py

@@ -288,10 +288,21 @@ class EDBComponent(object):
         bool
             ``True`` if component is active, ``False`` if is disabled..
         """
-        return self.component_property.IsEnabled()
+        warnings.warn("Use new property :func:`enabled` instead.", DeprecationWarning)
+        return self.enabled
 
     @is_enabled.setter
     def is_enabled(self, value):
+        warnings.warn("Use new property :func:`enabled` instead.", DeprecationWarning)
+        self.enabled = value
+
+    @property
+    def enabled(self):
+        """Get or Set the component to active mode."""
+        return self.component_property.IsEnabled()
+
+    @enabled.setter
+    def enabled(self, value):
         cmp_prop = self.component_property.Clone()
         cmp_prop.SetEnabled(value)
         self.edbcomponent.SetComponentProperty(cmp_prop)
@@ -773,17 +784,18 @@ class EDBComponent(object):
             Type of the component. Options are ``"Resistor"``,  ``"Inductor"``, ``"Capacitor"``,
             ``"IC"``, ``"IO"`` and ``"Other"``.
         """
-        if new_type == "Resistor":
+        new_type = new_type.lower()
+        if new_type == "resistor":
             type_id = self._pedb.definition.ComponentType.Resistor
-        elif new_type == "Inductor":
+        elif new_type == "inductor":
             type_id = self._pedb.definition.ComponentType.Inductor
-        elif new_type == "Capacitor":
+        elif new_type == "capacitor":
             type_id = self._pedb.definition.ComponentType.Capacitor
-        elif new_type == "IC":
+        elif new_type == "ic":
             type_id = self._pedb.definition.ComponentType.IC
-        elif new_type == "IO":
+        elif new_type == "io":
             type_id = self._pedb.definition.ComponentType.IO
-        elif new_type == "Other":
+        elif new_type == "other":
             type_id = self._pedb.definition.ComponentType.Other
         else:
             return

pyedb/dotnet/edb_core/edb_data/padstacks_data.py

@@ -26,9 +26,9 @@ import re
 import warnings
 
 from pyedb.dotnet.clr_module import String, _clr
+from pyedb.dotnet.edb_core.cell.primitive import Primitive
 from pyedb.dotnet.edb_core.dotnet.database import PolygonDataDotNet
 from pyedb.dotnet.edb_core.edb_data.edbvalue import EdbValue
-from pyedb.dotnet.edb_core.edb_data.primitives_data import EDBPrimitivesMain
 from pyedb.dotnet.edb_core.general import PadGeometryTpe, convert_py_list_to_net_list
 from pyedb.generic.general_methods import (
     generate_unique_name,
@@ -1144,7 +1144,7 @@ class EDBPadstack(object):
         return True
 
 
-class EDBPadstackInstance(EDBPrimitivesMain):
+class EDBPadstackInstance(Primitive):
     """Manages EDB functionalities for a padstack.
 
     Parameters
@@ -1162,7 +1162,7 @@ class EDBPadstackInstance(EDBPrimitivesMain):
     """
 
     def __init__(self, edb_padstackinstance, _pedb):
-        super().__init__(edb_padstackinstance, _pedb)
+        super().__init__(_pedb, edb_padstackinstance)
         self._edb_padstackinstance = self._edb_object
         self._bounding_box = []
         self._object_instance = None

pyedb/dotnet/edb_core/edb_data/primitives_data.py

@@ -22,7 +22,7 @@
 
 import math
 
-from pyedb.dotnet.edb_core.dotnet.database import NetDotNet
+from pyedb.dotnet.edb_core.cell.primitive import Primitive
 from pyedb.dotnet.edb_core.dotnet.primitive import (
     BondwireDotNet,
     CircleDotNet,
@@ -32,7 +32,6 @@ from pyedb.dotnet.edb_core.dotnet.primitive import (
     RectangleDotNet,
     TextDotNet,
 )
-from pyedb.dotnet.edb_core.edb_data.connectable import Connectable
 from pyedb.dotnet.edb_core.general import convert_py_list_to_net_list
 from pyedb.generic.general_methods import pyedb_function_handler
 from pyedb.modeler.geometry_operators import GeometryOperators
@@ -78,7 +77,7 @@ def cast(raw_primitive, core_app):
             return None
 
 
-class EDBPrimitivesMain(Connectable):
+class EDBPrimitives(Primitive):
     """Manages EDB functionalities for a primitives.
     It Inherits EDB Object properties.
 
@@ -92,127 +91,7 @@ class EDBPrimitivesMain(Connectable):
     """
 
     def __init__(self, raw_primitive, core_app):
-        super().__init__(core_app, raw_primitive)
-        self._app = self._pedb
-        self._core_stackup = core_app.stackup
-        self._core_net = core_app.nets
-        self.primitive_object = self._edb_object
-
-    @property
-    def type(self):
-        """Return the type of the primitive.
-        Allowed outputs are ``"Circle"``, ``"Rectangle"``,``"Polygon"``,``"Path"`` or ``"Bondwire"``.
-
-        Returns
-        -------
-        str
-        """
-        try:
-            return self._edb_object.GetPrimitiveType().ToString()
-        except AttributeError:  # pragma: no cover
-            return ""
-
-    @property
-    def net_name(self):
-        """Get or Set the primitive net name.
-
-        Returns
-        -------
-        str
-        """
-        return self.net.GetName()
-
-    @net_name.setter
-    def net_name(self, name):
-        if isinstance(name, str):
-            net = self._app.nets.nets[name].net_object
-            self.primitive_object.SetNet(net)
-        else:
-            try:
-                if isinstance(name, str):
-                    self.net = name
-                elif isinstance(name, NetDotNet):
-                    self.net = name.name
-            except:  # pragma: no cover
-                self._app.logger.error("Failed to set net name.")
-
-    @property
-    def layer(self):
-        """Get the primitive edb layer object."""
-        try:
-            layer_name = self.primitive_object.GetLayer().GetName()
-            return self._pedb.stackup.layers[layer_name]
-        except (KeyError, AttributeError):  # pragma: no cover
-            return None
-
-    @property
-    def layer_name(self):
-        """Get or Set the primitive layer name.
-
-        Returns
-        -------
-        str
-        """
-        try:
-            return self.layer.name
-        except (KeyError, AttributeError):  # pragma: no cover
-            return None
-
-    @layer_name.setter
-    def layer_name(self, val):
-        layer_list = list(self._core_stackup.layers.keys())
-        if isinstance(val, str) and val in layer_list:
-            layer = self._core_stackup.layers[val]._edb_layer
-            if layer:
-                self.primitive_object.SetLayer(layer)
-            else:
-                raise AttributeError("Layer {} not found.".format(val))
-        elif isinstance(val, type(self._core_stackup.layers[layer_list[0]])):
-            try:
-                self.primitive_object.SetLayer(val._edb_layer)
-            except:
-                raise AttributeError("Failed to assign new layer on primitive.")
-        else:
-            raise AttributeError("Invalid input value")
-
-    @property
-    def is_void(self):
-        """Either if the primitive is a void or not.
-
-        Returns
-        -------
-        bool
-        """
-        try:
-            return self._edb_object.IsVoid()
-        except AttributeError:  # pragma: no cover
-            return None
-
-    def get_connected_objects(self):
-        """Get connected objects.
-
-        Returns
-        -------
-        list
-        """
-        return self._pedb.get_connected_objects(self._layout_obj_instance)
-
-
-class EDBPrimitives(EDBPrimitivesMain):
-    """Manages EDB functionalities for a primitives.
-    It Inherits EDB Object properties.
-
-    Examples
-    --------
-    >>> from pyedb import Edb
-    >>> edb = Edb(myedb, edbversion="2021.2")
-    >>> edb_prim = edb.modeler.primitives[0]
-    >>> edb_prim.is_void # Class Property
-    >>> edb_prim.IsVoid() # EDB Object Property
-    """
-
-    def __init__(self, raw_primitive, core_app):
-        EDBPrimitivesMain.__init__(self, raw_primitive, core_app)
+        Primitive.__init__(self, core_app, raw_primitive)
 
     @pyedb_function_handler()
     def area(self, include_voids=True):
@@ -1262,13 +1141,13 @@ class EdbPolygon(EDBPrimitives, PolygonDotNet):
     #     return self.add_void(prim)
 
 
-class EdbText(EDBPrimitivesMain, TextDotNet):
+class EdbText(Primitive, TextDotNet):
     def __init__(self, raw_primitive, core_app):
         EDBPrimitives.__init__(self, raw_primitive, core_app)
         TextDotNet.__init__(self, self._app, raw_primitive)
 
 
-class EdbBondwire(EDBPrimitivesMain, BondwireDotNet):
+class EdbBondwire(Primitive, BondwireDotNet):
     def __init__(self, raw_primitive, core_app):
         EDBPrimitives.__init__(self, raw_primitive, core_app)
         BondwireDotNet.__init__(self, self._app, raw_primitive)

pyedb/dotnet/edb_core/edb_data/terminals.py

@@ -22,7 +22,7 @@
 
 import re
 
-from pyedb.dotnet.edb_core.edb_data.connectable import Connectable
+from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
 from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstackInstance
 from pyedb.dotnet.edb_core.edb_data.primitives_data import cast
 from pyedb.dotnet.edb_core.general import convert_py_list_to_net_list
@@ -542,7 +542,7 @@ class PadstackInstanceTerminal(Terminal):
 
         terminal = self._edb.cell.terminal.PadstackInstanceTerminal.Create(
             self._pedb.active_layout,
-            self.net.net_object,
+            padstack_instance.net.net_object,
             name,
             padstack_instance._edb_object,
             layer_obj._edb_layer,

pyedb/dotnet/edb_core/geometry/polygon_data.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 from pyedb.dotnet.edb_core.geometry.point_data import PointData
-from pyedb.dotnet.edb_core.obj_base import BBox
+from pyedb.dotnet.edb_core.utilities.obj_base import BBox
 from pyedb.generic.general_methods import pyedb_function_handler
 
 

pyedb/dotnet/edb_core/materials.py

@@ -513,7 +513,8 @@ class Materials(object):
         if name in curr_materials:
             raise ValueError(f"Material {name} already exists in material library.")
         elif name.lower() in (material.lower() for material in curr_materials):
-            raise ValueError(f"Material names are case-insensitive and {name.lower()} already exists.")
+            m = {material.lower(): material for material in curr_materials}[name.lower()]
+            raise ValueError(f"Material names are case-insensitive and '{name}' already exists as '{m}'.")
 
         material_def = self.__edb_definition.MaterialDef.Create(self.__edb.active_db, name)
         material = Material(self.__edb, material_def)

pyedb/dotnet/edb_core/padstack.py

@@ -29,6 +29,7 @@ import warnings
 import rtree
 
 from pyedb.dotnet.clr_module import Array
+from pyedb.dotnet.edb_core.dotnet.database import PolygonDataDotNet
 from pyedb.dotnet.edb_core.edb_data.padstacks_data import (
     EDBPadstack,
     EDBPadstackInstance,
@@ -868,6 +869,9 @@ class EdbPadstacks(object):
         pad_offset_x="0.0",
         pad_offset_y="0.0",
         pad_rotation="0.0",
+        pad_polygon=None,
+        antipad_polygon=None,
+        polygon_hole=None,
         start_layer=None,
         stop_layer=None,
         add_default_layer=False,
@@ -888,7 +892,7 @@ class EdbPadstacks(object):
         antipaddiam : str, optional
             Diameter of the antipad with units. The default is ``"600um"``.
         pad_shape : str, optional
-            Shape of the pad. The default is ``"Circle``. Options are ``"Circle"`` and ``"Rectangle"``.
+            Shape of the pad. The default is ``"Circle``. Options are ``"Circle"``, ``"Rectangle"`` and ``"Polygon"``.
         antipad_shape : str, optional
             Shape of the antipad. The default is ``"Circle"``. Options are ``"Circle"`` ``"Rectangle"`` and
             ``"Bullet"``.
@@ -934,17 +938,34 @@ class EdbPadstacks(object):
         holediam = self._get_edb_value(holediam)
         paddiam = self._get_edb_value(paddiam)
         antipaddiam = self._get_edb_value(antipaddiam)
-
+        layers = list(self._pedb.stackup.signal_layers.keys())[:]
+        value0 = self._get_edb_value("0.0")
         if not padstackname:
             padstackname = generate_unique_name("VIA")
         # assert not self.isreadonly, "Write Functions are not available within AEDT"
         padstackData = self._edb.definition.PadstackDefData.Create()
-        if has_hole:
+        if has_hole and not polygon_hole:
             ptype = self._edb.definition.PadGeometryType.Circle
+            hole_param = Array[type(holediam)]([holediam])
+            padstackData.SetHoleParameters(ptype, hole_param, value0, value0, value0)
+            padstackData.SetHolePlatingPercentage(self._get_edb_value(20.0))
+        elif polygon_hole:
+            if isinstance(polygon_hole, list):
+                _poly = self._pedb.modeler.create_polygon(polygon_hole, layers[0], net_name="dummy")
+                if not _poly.is_null:
+                    hole_param = _poly.polygon_data
+                    _poly.delete()
+                else:
+                    return False
+            elif isinstance(polygon_hole, PolygonDataDotNet):
+                hole_param = polygon_hole
+            else:
+                return False
+            padstackData.SetPolygonalHoleParameters(hole_param, value0, value0, value0)
+            padstackData.SetHolePlatingPercentage(self._get_edb_value(20.0))
         else:
             ptype = self._edb.definition.PadGeometryType.NoGeometry
-        holparam = Array[type(holediam)]([holediam])
-        value0 = self._get_edb_value("0.0")
+
         x_size = self._get_edb_value(x_size)
         y_size = self._get_edb_value(y_size)
         corner_radius = self._get_edb_value(corner_radius)
@@ -957,8 +978,7 @@ class EdbPadstacks(object):
         pad_rotation = self._get_edb_value(pad_rotation)
         anti_pad_x_size = self._get_edb_value(anti_pad_x_size)
         anti_pad_y_size = self._get_edb_value(anti_pad_y_size)
-        padstackData.SetHoleParameters(ptype, holparam, value0, value0, value0)
-        padstackData.SetHolePlatingPercentage(self._get_edb_value(20.0))
+
         if hole_range == "through":  # pragma no cover
             padstackData.SetHoleRange(self._edb.definition.PadstackHoleRange.Through)
         elif hole_range == "begin_on_upper_pad":  # pragma no cover
@@ -970,7 +990,7 @@ class EdbPadstacks(object):
         else:  # pragma no cover
             self._logger.error("Unknown padstack hole range")
         padstackData.SetMaterial("copper")
-        layers = list(self._pedb.stackup.signal_layers.keys())[:]
+
         if start_layer and start_layer in layers:  # pragma no cover
             layers = layers[layers.index(start_layer) :]
         if stop_layer and stop_layer in layers:  # pragma no cover
@@ -981,37 +1001,76 @@ class EdbPadstacks(object):
         elif pad_shape == "Rectangle":  # pragma no cover
             pad_array = Array[type(x_size)]([x_size, y_size])
             pad_shape = self._edb.definition.PadGeometryType.Rectangle
+        elif pad_shape == "Polygon":
+            if isinstance(pad_polygon, list):
+                _poly = self._pedb.modeler.create_polygon(pad_polygon, layers[0], net_name="dummy")
+                if not _poly.is_null:
+                    pad_array = _poly.polygon_data
+                    _poly.delete()
+                else:
+                    return False
+            elif isinstance(pad_polygon, PolygonDataDotNet):
+                pad_array = pad_polygon
         if antipad_shape == "Bullet":  # pragma no cover
             antipad_array = Array[type(x_size)]([x_size, y_size, corner_radius])
             antipad_shape = self._edb.definition.PadGeometryType.Bullet
         elif antipad_shape == "Rectangle":  # pragma no cover
             antipad_array = Array[type(anti_pad_x_size)]([anti_pad_x_size, anti_pad_y_size])
             antipad_shape = self._edb.definition.PadGeometryType.Rectangle
+        elif antipad_shape == "Polygon":
+            if isinstance(antipad_polygon, list):
+                _poly = self._pedb.modeler.create_polygon(antipad_polygon, layers[0], net_name="dummy")
+                if not _poly.is_null:
+                    antipad_array = _poly.polygon_data
+                    _poly.delete()
+                else:
+                    return False
+            elif isinstance(antipad_polygon, PolygonDataDotNet):
+                antipad_array = antipad_polygon
         else:  # pragma no cover
             antipad_array = Array[type(antipaddiam)]([antipaddiam])
             antipad_shape = self._edb.definition.PadGeometryType.Circle
         if add_default_layer:  # pragma no cover
             layers = layers + ["Default"]
-        for layer in layers:
-            padstackData.SetPadParameters(
-                layer,
-                self._edb.definition.PadType.RegularPad,
-                pad_shape,
-                pad_array,
-                pad_offset_x,
-                pad_offset_y,
-                pad_rotation,
-            )
+        if antipad_shape == "Polygon" and pad_shape == "Polygon":
+            for layer in layers:
+                padstackData.SetPolygonalPadParameters(
+                    layer,
+                    self._edb.definition.PadType.RegularPad,
+                    pad_array.edb_api,
+                    pad_offset_x,
+                    pad_offset_y,
+                    pad_rotation,
+                )
+                padstackData.SetPolygonalPadParameters(
+                    layer,
+                    self._edb.definition.PadType.AntiPad,
+                    antipad_array.edb_api,
+                    pad_offset_x,
+                    pad_offset_y,
+                    pad_rotation,
+                )
+        else:
+            for layer in layers:
+                padstackData.SetPadParameters(
+                    layer,
+                    self._edb.definition.PadType.RegularPad,
+                    pad_shape,
+                    pad_array,
+                    pad_offset_x,
+                    pad_offset_y,
+                    pad_rotation,
+                )
 
-            padstackData.SetPadParameters(
-                layer,
-                self._edb.definition.PadType.AntiPad,
-                antipad_shape,
-                antipad_array,
-                offset_x,
-                offset_y,
-                rotation,
-            )
+                padstackData.SetPadParameters(
+                    layer,
+                    self._edb.definition.PadType.AntiPad,
+                    antipad_shape,
+                    antipad_array,
+                    offset_x,
+                    offset_y,
+                    rotation,
+                )
 
         padstackDefinition = self._edb.definition.PadstackDef.Create(self.db, padstackname)
         padstackDefinition.SetData(padstackData)

pyedb/generic/general_methods.py

@@ -187,6 +187,39 @@ def _function_handler_wrapper(user_function):  # pragma: no cover
     return wrapper
 
 
+import functools
+import warnings
+
+
+def deprecate_argument_name(argument_map):
+    """Decorator to deprecate certain argument names in favor of new ones."""
+
+    def decorator(func):
+        """Decorator that wraps the function to handle deprecated arguments."""
+
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            """Wrapper function that checks for deprecated arguments."""
+            func_name = func.__name__
+            for old_arg, new_arg in argument_map.items():
+                if old_arg in kwargs:
+                    warnings.warn(
+                        f"Argument `{old_arg}` is deprecated for method `{func_name}`; use `{new_arg}` instead.",
+                        DeprecationWarning,
+                        stacklevel=2,
+                    )
+                    # NOTE: Use old argument if new argument is not provided
+                    if new_arg not in kwargs:
+                        kwargs[new_arg] = kwargs.pop(old_arg)
+                    else:
+                        kwargs.pop(old_arg)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
 def pyedb_function_handler(direct_func=None):
     """Provides an exception handler, logging mechanism, and argument converter for client-server
     communications.

{pyedb-0.12.2.dist-info → pyedb-0.13.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyedb
-Version: 0.12.2
+Version: 0.13.dev0
 Summary: Higher-Level Pythonic Ansys Electronics Data Base
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: PyEDB developers <simon.vandenbrouck@ansys.com>