pyedb 0.50.1__py3-none-any.whl → 0.52.0__py3-none-any.whl

pyedb/grpc/database/nets.py

@@ -36,11 +36,120 @@ from pyedb.misc.utilities import compute_arc_points
 class Nets(CommonNets):
     """Manages EDB methods for nets management accessible from `Edb.nets` property.
 
-    Examples
-    --------
+        Examples
+        --------
     >>> from pyedb import Edb
-    >>> edbapp = Edb("myaedbfolder", edbversion="2021.2")
-    >>> edb_nets = edbapp.nets
+
+    >>> # Initialize EDB session
+    >>> edbapp = Edb(edbversion="2025.2")
+
+    >>> # Access Nets class
+    >>> nets = edbapp.nets
+
+    >>> # =================
+    >>> # Property examples
+    >>> # =================
+
+    >>> # Get all nets dictionary
+    >>> all_nets = nets.nets
+    >>> print("All nets:", list(all_nets.keys()))
+
+    >>> # Get net names list
+    >>> net_names = nets.netlist
+    >>> print("Net names:", net_names)
+
+    >>> # Get signal nets
+    >>> signal_nets = nets.signal
+    >>> print("Signal nets:", list(signal_nets.keys()))
+
+    >>> # Get power/ground nets
+    >>> power_nets = nets.power
+    >>> print("Power nets:", list(power_nets.keys()))
+
+    >>> # Get nets by components
+    >>> nets_by_comps = nets.nets_by_components
+    >>> print("Nets by components:", nets_by_comps)
+
+    >>> # Get components by nets
+    >>> comps_by_nets = nets.components_by_nets
+    >>> print("Components by nets:", comps_by_nets)
+
+    >>> # ===============
+    >>> # Method examples
+    >>> # ===============
+
+    >>> # Get net by name
+    >>> net_obj = nets["GND"]
+    >>> print(f"Net object: {net_obj.name}")
+
+    >>> # Check net existence
+    >>> if "PCIe_RX" in nets:
+    >>>    print("PCIe_RX exists")
+
+    >>> # Identify eligible power nets
+    >>> eligible_pwr = nets.eligible_power_nets(threshold=0.25)
+    >>> print("Eligible power nets:", [net.name for net in eligible_pwr])
+
+    >>> # Generate extended nets (deprecated)
+    >>> nets.generate_extended_nets(
+    >>> resistor_below=5,
+    >>>inductor_below=0.5,
+    >>> capacitor_above=0.1
+    >>> )
+
+    >>> # Classify nets
+    >>> nets.classify_nets(
+    >>> power_nets=["VDD_CPU", "VDD_MEM"],
+    >>> signal_nets=["PCIe_TX", "ETH_RX"]
+    >>> )
+
+    >>> # Check power/ground status
+    >>> is_power = nets.is_power_gound_net(["VDD_CPU", "PCIe_TX"])
+    >>> print("Is power net:", is_power)
+
+    >>> # Get DC-connected nets
+    >>> dc_connected = nets.get_dcconnected_net_list(
+    >>> ground_nets=["GND"],
+    >>> res_value=0.002
+    >>> )
+        print("DC-connected nets:", dc_connected)
+
+    >>> # Get power tree
+    >>> comp_list, columns, net_group = nets.get_powertree(
+    >>> power_net_name="VDD_CPU",
+    >>> ground_nets=["GND"]
+    >>> )
+    >>> print("Power tree components:", comp_list)
+
+    >>> # Find net by name
+    >>> found_net = nets.get_net_by_name("PCIe_TX")
+    >>> print(f"Found net: {found_net.name}")
+
+    >>> # Delete nets
+    >>> deleted = nets.delete(["Unused_Net", "Test_Net"])
+    >>> print("Deleted nets:", deleted)
+
+    >>> # Find or create net
+    >>> new_net = nets.find_or_create_net(net_name="New_Net")
+    >>> print(f"Created net: {new_net.name}")
+
+    >>> # Check net-component association
+    >>> in_component = nets.is_net_in_component("U1", "VDD_CPU")
+    >>> print("Net in component:", in_component)
+
+    >>> # Find and fix disjoint nets (deprecated)
+    >>> fixed_nets = nets.find_and_fix_disjoint_nets(
+    >>> net_list=["PCIe_TX"],
+    >>> clean_disjoints_less_than=1e-6
+    >>> )
+    >>> print("Fixed nets:", fixed_nets)
+
+    >>> # Merge net polygons
+    >>> merged = nets.merge_nets_polygons(["VDD_CPU", "VDD_MEM"])
+    >>> print("Polygons merged:", merged)
+
+        # Close EDB session
+    >>> edbapp.close()
     """
 
     def __getitem__(self, name):
@@ -55,6 +164,11 @@ class Nets(CommonNets):
         -------
         pyedb.grpc.database.net.net.Net
             Net object if found, otherwise None.
+
+        Examples
+        --------
+        >>> gnd_net = edb_nets["GND"]
+        >>> print(gnd_net.name)
         """
         return Net(self._pedb, Net.find_by_name(self._active_layout, name))
 
@@ -70,6 +184,11 @@ class Nets(CommonNets):
         -------
         bool
             True if the net exists, False otherwise.
+
+        Examples
+        --------
+        >>> if "PCIe_RX" in edb_nets:
+        >>>     print("Net exists")
         """
         return name in self.nets
 
@@ -117,6 +236,12 @@ class Nets(CommonNets):
         -------
         dict[str, pyedb.grpc.database.net.net.Net]
             Dictionary of net names to Net objects.
+
+         Examples
+        --------
+        >>> all_nets = edb_nets.nets
+        >>> for net_name, net_obj in all_nets.items():
+        ...     print(net_name, net_obj.is_power_ground)
         """
         return {i.name: i for i in self._pedb.layout.nets}
 
@@ -128,6 +253,11 @@ class Nets(CommonNets):
         -------
         list[str]
             Names of all nets in the layout.
+
+        Examples
+        --------
+        >>> net_names = edb_nets.netlist
+        >>> print("Total nets:", len(net_names))
         """
         return list(self.nets.keys())
 
@@ -139,6 +269,11 @@ class Nets(CommonNets):
         -------
         dict[str, pyedb.grpc.database.net.net.Net]
             Dictionary of signal net names to Net objects.
+
+        Examples
+        --------
+        >>> signal_nets = edb_nets.signal
+        >>> print("Signal nets:", list(signal_nets.keys()))
         """
         nets = {}
         for net, value in self.nets.items():
@@ -154,6 +289,11 @@ class Nets(CommonNets):
         -------
         dict[str, pyedb.grpc.database.net.net.Net]
             Dictionary of power/ground net names to Net objects.
+
+        Examples
+        --------
+        >>> power_nets = edb_nets.power
+        >>> print("Power nets:", list(power_nets.keys()))
         """
         nets = {}
         for net, value in self.nets.items():
@@ -176,6 +316,11 @@ class Nets(CommonNets):
         -------
         list[pyedb.grpc.database.net.net.Net]
             List of nets eligible as power/ground nets.
+
+        Examples
+        --------
+        >>> eligible_pwr = edb_nets.eligible_power_nets(threshold=0.25)
+        >>> print([net.name for net in eligible_pwr])
         """
         pwr_gnd_nets = []
         for net in self._layout.nets[:]:
@@ -205,6 +350,11 @@ class Nets(CommonNets):
         -------
         dict[str, list[str]]
             Dictionary mapping component names to list of net names.
+
+        Examples
+        --------
+        >>> nets_by_comps = edb_nets.nets_by_components
+        >>> print("U1 nets:", nets_by_comps.get("U1", []))
         """
         for comp, i in self._pedb.components.instances.items():
             self._nets_by_comp_dict[comp] = i.nets
@@ -218,6 +368,11 @@ class Nets(CommonNets):
         -------
         dict[str, list[str]]
             Dictionary mapping net names to list of component names.
+
+        Examples
+        --------
+        >>> comps_by_nets = edb_nets.components_by_nets
+        >>> print("Components on GND:", comps_by_nets.get("GND", []))
         """
         for comp, i in self._pedb.components.instances.items():
             for n in i.nets:
@@ -260,6 +415,14 @@ class Nets(CommonNets):
         -------
         list
             List of generated extended nets.
+
+        Examples
+        --------
+        >>> edb_nets.generate_extended_nets(
+        ...     resistor_below=5,
+        ...     inductor_below=0.5,
+        ...     capacitor_above=0.1
+        ... )
         """
         warnings.warn("Use new method :func:`edb.extended_nets.generate_extended_nets` instead.", DeprecationWarning)
         self._pedb.extended_nets.generate_extended_nets(
@@ -315,6 +478,13 @@ class Nets(CommonNets):
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        >>> edb_nets.classify_nets(
+        ...     power_nets=["VDD_CPU", "VDD_MEM"],
+        ...     signal_nets=["PCIe_TX", "ETH_RX"]
+        ... )
         """
         if isinstance(power_nets, str):
             power_nets = []
@@ -344,6 +514,11 @@ class Nets(CommonNets):
         -------
         bool
             True if any net is power/ground, False otherwise.
+
+        Examples
+        --------
+        >>> is_power = edb_nets.is_power_gound_net(["VDD_CPU", "PCIe_TX"])
+        >>> print("Contains power net:", is_power)
         """
         if isinstance(netname_list, str):
             netname_list = [netname_list]
@@ -367,6 +542,15 @@ class Nets(CommonNets):
         -------
         list[set]
             List of sets of connected nets.
+
+        Examples
+        --------
+        >>> dc_connected = edb_nets.get_dcconnected_net_list(
+        ...     ground_nets=["GND"],
+        ...     res_value=0.002
+        ... )
+        >>> for net_group in dc_connected:
+        ...     print("Connected nets:", net_group)
         """
         temp_list = []
         for _, comp_obj in self._pedb.components.inductors.items():
@@ -416,6 +600,14 @@ class Nets(CommonNets):
         -------
         tuple
             (component_list, component_list_columns, net_group)
+
+        Examples
+        --------
+        >>> comp_list, columns, net_group = edb_nets.get_powertree(
+        ...     power_net_name="VDD_CPU",
+        ...     ground_nets=["GND"]
+        ... )
+        >>> print("Power tree components:", comp_list)
         """
         flag_in_ng = False
         net_group = []
@@ -474,6 +666,12 @@ class Nets(CommonNets):
         -------
         pyedb.grpc.database.net.net.Net
             Net object if found, otherwise None.
+
+        Examples
+        --------
+        >>> found_net = edb_nets.get_net_by_name("PCIe_TX")
+        >>> if found_net:
+        ...     print("Net found:", found_net.name)
         """
         edb_net = Net.find_by_name(self._active_layout, net_name)
         if edb_net is not None:
@@ -528,6 +726,20 @@ class Nets(CommonNets):
         -------
         pyedb.grpc.database.net.net.Net | list[pyedb.grpc.database.net.net.Net]
             Net object or list of matching net objects.
+
+        Examples
+        --------
+        >>> # Create new net
+        >>> new_net = edb_nets.find_or_create_net(net_name="New_Net")
+        >>>
+        >>> # Find existing net
+        >>> existing_net = edb_nets.find_or_create_net(net_name="GND")
+        >>>
+        >>> # Find nets starting with "VDD"
+        >>> vdd_nets = edb_nets.find_or_create_net(start_with="VDD")
+        >>>
+        >>> # Find nets ending with "_P"
+        >>> pos_nets = edb_nets.find_or_create_net(end_with="_P")
         """
         if not net_name and not start_with and not contain and not end_with:
             net_name = generate_unique_name("NET_")
@@ -591,6 +803,11 @@ class Nets(CommonNets):
         -------
         bool
             True if the net is found in the component, False otherwise.
+
+        Examples
+        --------
+        >>> in_component = edb_nets.is_net_in_component("U1", "VDD_CPU")
+        >>> print("Net in component:", in_component)
         """
         if component_name not in self._pedb.components.instances:
             return False
@@ -625,6 +842,13 @@ class Nets(CommonNets):
 
             New nets created.
 
+        Examples
+        --------
+        >>> fixed_nets = edb_nets.find_and_fix_disjoint_nets(
+        ...     net_list=["PCIe_TX"],
+        ...     clean_disjoints_less_than=1e-6
+        ... )
+        >>> print("Fixed nets:", fixed_nets)
         """
 
         warnings.warn("Use new function :func:`edb.layout_validation.disjoint_nets` instead.", DeprecationWarning)
@@ -644,6 +868,11 @@ class Nets(CommonNets):
         -------
         bool
             True if successful, False otherwise.
+
+        Examples
+        --------
+        >>> merged = edb_nets.merge_nets_polygons(["VDD_CPU", "VDD_MEM"])
+        >>> print("Merge successful:", merged)
         """
         if isinstance(net_names_list, str):
             net_names_list = [net_names_list]

pyedb/grpc/database/padstacks.py

@@ -130,6 +130,11 @@ class Padstacks(object):
         -------
         object
             EDB.PadType enumerator value.
+
+        Examples
+        --------
+        >>> pad_type = edb_padstacks.int_to_pad_type(0)  # Returns REGULAR_PAD
+        >>> pad_type = edb_padstacks.int_to_pad_type(1)  # Returns ANTI_PAD
         """
 
         if val == 0:
@@ -156,6 +161,11 @@ class Padstacks(object):
         -------
         object
             EDB.PadGeometryType enumerator value.
+
+        Examples
+        --------
+        >>> geom_type = edb_padstacks.int_to_geometry_type(1)  # Returns CIRCLE
+        >>> geom_type = edb_padstacks.int_to_geometry_type(2)  # Returns SQUARE
         """
         if val == 0:
             return GrpcPadGeometryType.PADGEOMTYPE_NO_GEOMETRY
@@ -192,6 +202,12 @@ class Padstacks(object):
         -------
         dict[str, :class:`pyedb.grpc.database.definition.padstack_def.PadstackDef`]
             Dictionary of padstack definitions with definition names as keys.
+
+        Examples
+        --------
+        >>> all_definitions = edb_padstacks.definitions
+        >>> for name, definition in all_definitions.items():
+        ...     print(f"Padstack: {name}")
         """
         if len(self._definitions) == len(self.db.padstack_defs):
             return self._definitions
@@ -209,6 +225,12 @@ class Padstacks(object):
         -------
         dict[int, :class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance`]
             Dictionary of padstack instances with database IDs as keys.
+
+        Examples
+        --------
+        >>> all_instances = edb_padstacks.instances
+        >>> for id, instance in all_instances.items():
+        ...     print(f"Instance {id}: {instance.name}")
         """
         pad_stack_inst = self._pedb.layout.padstack_instances
         if len(self._instances) == len(pad_stack_inst):
@@ -224,6 +246,12 @@ class Padstacks(object):
         -------
         dict[str, :class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance`]
             Dictionary of padstack instances with names as keys.
+
+        Examples
+        --------
+        >>> named_instances = edb_padstacks.instances_by_name
+        >>> for name, instance in named_instances.items():
+        ...     print(f"Instance named {name}")
         """
         padstack_instances = {}
         for _, edb_padstack_instance in self.instances.items():
@@ -243,6 +271,12 @@ class Padstacks(object):
         -------
         :class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance` or None
             Padstack instance if found, otherwise ``None``.
+
+        Examples
+        --------
+        >>> via = edb_padstacks.find_instance_by_id(123)
+        >>> if via:
+        ...     print(f"Found via: {via.name}")
         """
         return self._pedb.modeler.find_object_by_id(value)
 
@@ -254,6 +288,12 @@ class Padstacks(object):
         -------
         dict[int, :class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance`]
             Dictionary of pin instances with database IDs as keys.
+
+        Examples
+        --------
+        >>> all_pins = edb_padstacks.pins
+        >>> for pin_id, pin in all_pins.items():
+        ...     print(f"Pin {pin_id} belongs to {pin.component.refdes}")
         """
         pins = {}
         for instancename, instance in self.instances.items():
@@ -269,6 +309,12 @@ class Padstacks(object):
         -------
         dict[int, :class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance`]
             Dictionary of via instances with database IDs as keys.
+
+        Examples
+        --------
+        >>> all_vias = edb_padstacks.vias
+        >>> for via_id, via in all_vias.items():
+        ...     print(f"Via {via_id} on net {via.net_name}")
         """
         pnames = list(self.pins.keys())
         vias = {i: j for i, j in self.instances.items() if i not in pnames}
@@ -285,6 +331,11 @@ class Padstacks(object):
         -------
         list
             List of all layout pin groups.
+
+        Examples
+        --------
+        >>> groups = edb_padstacks.pingroups  # Deprecated
+        >>> groups = edb_padstacks._layout.pin_groups  # New way
         """
         warnings.warn(
             "`pingroups` is deprecated and is now located here " "`pyedb.grpc.core.layout.pin_groups` instead.",
@@ -328,6 +379,15 @@ class Padstacks(object):
         -------
         str
             Name of the padstack if the operation is successful.
+
+        Examples
+        --------
+        >>> via_name = edb_padstacks.create_circular_padstack(
+        ...     padstackname="VIA1",
+        ...     holediam="200um",
+        ...     paddiam="400um",
+        ...     antipaddiam="600um"
+        ... )
         """
 
         padstack_def = PadstackDef.create(self._pedb.db, padstackname)
@@ -411,6 +471,11 @@ class Padstacks(object):
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        >>> success = edb_padstacks.delete_padstack_instances("GND")
+        >>> success = edb_padstacks.delete_padstack_instances(["GND", "PWR"])
         """
         if not isinstance(net_names, list):  # pragma: no cover
             net_names = [net_names]
@@ -439,6 +504,11 @@ class Padstacks(object):
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        >>> via_id = 123
+        >>> success = edb_padstacks.set_solderball(via_id, "SolderBall_Top", True, 150e-6)
         """
         if isinstance(padstackInst, int):
             psdef = self.definitions[self.instances[padstackInst].padstack_definition].edb_padstack
@@ -512,6 +582,11 @@ class Padstacks(object):
         -------
         list[:class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance`]
             List of matching pin instances.
+
+        Examples
+        --------
+        >>> pins = edb_padstacks.get_pin_from_component_and_net(refdes="U1", netname="VCC")
+        >>> pins = edb_padstacks.get_pin_from_component_and_net(netname="GND")  # All GND pins
         """
         pinlist = []
         if refdes:
@@ -551,6 +626,10 @@ class Padstacks(object):
             Dictionary of pins if the operation is successful.
             ``False`` is returned if the net does not belong to the component.
 
+        Examples
+        --------
+        >>> pins = edb_padstacks.get_pinlist_from_component_and_net(refdes="U1", netname="CLK")  # Deprecated
+        >>> pins = edb_padstacks.get_pin_from_component_and_net(refdes="U1", netname="CLK")  # New way
         """
         warnings.warn(
             "`get_pinlist_from_component_and_net` is deprecated use `get_pin_from_component_and_net` instead.",
@@ -579,6 +658,11 @@ class Padstacks(object):
             - offset_x : float
             - offset_y : float
             - rotation : float
+
+        Examples
+        --------
+        >>> via = edb_padstacks.instances[123]
+        >>> geom_type, params, x, y, rot = edb_padstacks.get_pad_parameters(via, "TOP", "regular_pad")
         """
         if pad_type == "regular_pad":
             pad_type = GrpcPadType.REGULAR_PAD
@@ -622,6 +706,10 @@ class Padstacks(object):
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        >>> success = edb_padstacks.set_all_antipad_value("0.3mm")
         """
         if self.definitions:
             all_succeed = True
@@ -675,6 +763,10 @@ class Padstacks(object):
         -------
         bool
             ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        >>> success = edb_padstacks.check_and_fix_via_plating(minimum_value_to_replace=0.1)
         """
         for padstack_def in list(self.definitions.values()):
             if padstack_def.hole_plating_ratio <= minimum_value_to_replace:
@@ -696,6 +788,11 @@ class Padstacks(object):
         -------
         list[:class:`pyedb.grpc.database.primitive.padstack_instance.PadstackInstance`]
             List of via instances.
+
+        Examples
+        --------
+        >>> vias = edb_padstacks.get_via_instance_from_net("GND")
+        >>> vias = edb_padstacks.get_via_instance_from_net(["GND", "PWR"])
         """
         if net_list and not isinstance(net_list, list):
             net_list = [net_list]

pyedb/grpc/database/primitive/padstack_instance.py

@@ -1095,7 +1095,7 @@ class PadstackInstance(GrpcPadstackInstance):
 
     def get_reference_pins(
         self, reference_net="GND", search_radius=5e-3, max_limit=0, component_only=True
-    ) -> list[PadstackInstance]:
+    ) -> list[any]:
         """Search for reference pins using given criteria.
 
         Parameters

pyedb/grpc/database/primitive/polygon.py

@@ -59,7 +59,7 @@ class Polygon(GrpcPolygon, Primitive):
         """
         return self.polygon_data.has_self_intersections()
 
-    def fix_self_intersections(self) -> list[Polygon]:
+    def fix_self_intersections(self) -> list[any]:
         """Remove self intersections if they exist.
 
         Returns