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

pyedb/grpc/database/net/differential_pair.py

@@ -35,7 +35,7 @@ class DifferentialPairs:
         self._pedb = pedb
 
     @property
-    def items(self):
+    def items(self) -> dict[str, any]:
         """Extended nets.
 
         Returns
@@ -71,7 +71,7 @@ class DifferentialPairs:
         GrpcDifferentialPair.create(layout=self._pedb.layout, name=name, pos_net=net_p, neg_net=net_n)
         return self.items[name]
 
-    def auto_identify(self, positive_differentiator="_P", negative_differentiator="_N"):
+    def auto_identify(self, positive_differentiator="_P", negative_differentiator="_N") -> list[str]:
         """Auto identify differential pairs by naming conversion.
 
         Parameters
@@ -128,11 +128,11 @@ class DifferentialPair(GrpcDifferentialPair):
         self._pedb = pedb
 
     @property
-    def positive_net(self):
+    def positive_net(self) -> Net:
         """Positive Net."""
         return Net(self._pedb, super().positive_net)
 
     @property
-    def negative_net(self):
+    def negative_net(self) -> Net:
         """Negative Net."""
         return Net(self._pedb, super().negative_net)

pyedb/grpc/database/net/extended_net.py

@@ -30,7 +30,7 @@ class ExtendedNets:
         self._pedb = pedb
 
     @property
-    def items(self):
+    def items(self) -> dict[str, any]:
         """Extended nets.
 
         Returns
@@ -44,7 +44,6 @@ class ExtendedNets:
         return nets
 
     def create(self, name, net):
-        # type: (str, str|list)->ExtendedNet
         """Create a new Extended net.
 
         Parameters
@@ -70,7 +69,7 @@ class ExtendedNets:
         return self.items[name]
 
     def auto_identify_signal(self, resistor_below=10, inductor_below=1, capacitor_above=1e-9, exception_list=None):
-        # type: (int | float, int | float, int |float, list) -> list
+        # type: (int | float, int | float, int |float, list) -> list[ExtendedNet]
         """Get extended signal net and associated components.
 
         Parameters
@@ -142,7 +141,7 @@ class ExtendedNets:
         include_signal=True,
         include_power=True,
     ):
-        # type: (int | float, int | float, int |float, list, bool, bool) -> list
+        # type: (int | float, int | float, int |float, list, bool, bool) -> list[ExtendedNet]
         """Get extended net and associated components.
 
         Parameters
@@ -275,7 +274,7 @@ class ExtendedNet(GrpcExtendedNet):
         return {net.name: Net(self._pedb, net) for net in super().nets}
 
     @property
-    def components(self):
+    def components(self) -> dict[str, any]:
         """Dictionary of components.
 
         Returns
@@ -289,7 +288,7 @@ class ExtendedNet(GrpcExtendedNet):
         return comps
 
     @property
-    def rlc(self):
+    def rlc(self) -> dict[str, any]:
         """Dictionary of RLC components.
 
         Returns
@@ -302,7 +301,7 @@ class ExtendedNet(GrpcExtendedNet):
         }
 
     @property
-    def serial_rlc(self):
+    def serial_rlc(self) -> dict[str, any]:
         """Dictionary of serial RLC components.
 
         Returns
@@ -321,7 +320,7 @@ class ExtendedNet(GrpcExtendedNet):
         return res
 
     @property
-    def shunt_rlc(self):
+    def shunt_rlc(self) -> dict[str, any]:
         """Dictionary of shunt RLC components.
 
         Returns

pyedb/grpc/database/net/net.py

@@ -20,6 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+from typing import Union
+
 from ansys.edb.core.net.net import Net as GrpcNet
 from ansys.edb.core.primitive.primitive import PrimitiveType as GrpcPrimitiveType
 
@@ -32,16 +34,25 @@ from pyedb.grpc.database.primitive.rectangle import Rectangle
 
 
 class Net(GrpcNet):
-    """Manages EDB functionalities for a primitives.
-    It Inherits EDB Object properties.
+    """Manages EDB functionalities for net objects and their primitives.
+
+    Inherits properties from EDB objects and provides additional functionality
+    specific to nets.
+
+    Parameters
+    ----------
+    pedb : :class:`pyedb.Edb`
+        Main EDB object.
+    raw_net :
+        Raw net object from gRPC.
 
     Examples
     --------
     >>> from pyedb import Edb
     >>> edb = Edb(myedb, edbversion="2021.2")
-    >>> edb_net = edb.nets.nets["GND"]
-    >>> edb_net.name # Class Property
-    >>> edb_net.name # EDB Object Property
+    >>> edb_net = edb.nets["GND"]
+    >>> edb_net.name
+    'GND'
     """
 
     def __init__(self, pedb, raw_net):
@@ -52,14 +63,18 @@ class Net(GrpcNet):
         self._edb_object = raw_net
 
     @property
-    def primitives(self):
-        """Primitives that belongs to the net.
+    def primitives(self) -> list[Union[Path, Polygon, Circle, Rectangle, Bondwire]]:
+        """All primitives belonging to this net.
 
         Returns
         -------
-        List[:class:`Primitive <pyedb.grpc.database.primitive.primitive.Primitive>`].
-            List of Primitive object.
-
+        list
+            List of primitive objects which can be one of:
+            - :class:`Path <pyedb.grpc.database.primitive.path.Path>`
+            - :class:`Polygon <pyedb.grpc.database.primitive.polygon.Polygon>`
+            - :class:`Circle <pyedb.grpc.database.primitive.circle.Circle>`
+            - :class:`Rectangle <pyedb.grpc.database.primitive.rectangle.Rectangle>`
+            - :class:`Bondwire <pyedb.grpc.database.primitive.bondwire.Bondwire>`
         """
         primitives = []
         for primitive in super().primitives:
@@ -76,24 +91,25 @@ class Net(GrpcNet):
         return primitives
 
     @property
-    def padstack_instances(self):
-        """Padstack instance which belong to net.
+    def padstack_instances(self) -> list[PadstackInstance]:
+        """All padstack instances belonging to this net.
 
         Returns
         -------
-        List[:class:`PadstackInstance <pyedb.grpc.database.primitive.padstack_instance.PadstackInstance>`]
-            LIst of PadstackInstance object.
-
+        list of :class:`PadstackInstance <pyedb.grpc.database.primitive.padstack_instance.PadstackInstance>`
+            Padstack instances associated with the net.
         """
         return [PadstackInstance(self._pedb, i) for i in super().padstack_instances]
 
     @property
-    def components(self):
-        """Components connected to net.
+    def components(self) -> dict[str, any]:
+        """Components connected to this net.
 
         Returns
         -------
-        Dict[str, :class:`Component <pyedb.grpc.database.hierarchy.component.Component>`]
+        dict
+            Dictionary of components keyed by component name, with values as
+            :class:`Component <pyedb.grpc.database.hierarchy.component.Component>` objects.
         """
         components = {}
         for padstack_instance in self.padstack_instances:
@@ -105,47 +121,44 @@ class Net(GrpcNet):
                     pass
         return components
 
-    def find_dc_short(self, fix=False):
-        """Find DC-shorted nets.
+    def find_dc_short(self, fix=False) -> list[list[str, str]]:
+        """Find DC-shorted nets connected to this net.
 
         Parameters
         ----------
         fix : bool, optional
-            If `True`, rename all the nets. (default)
-            If `False`, only report dc shorts.
+            Whether to automatically rename nets to resolve shorts.
+            Default: ``False`` (only report shorts).
 
         Returns
         -------
-        List[List[str, str]]
-            [[net name, net name]].
+        list[list[str]]
+            List of shorted net pairs in the format [[net_name1, net_name2], ...].
         """
         return self._pedb.layout_validation.dc_shorts(self.name, fix)
 
     def plot(
         self, layers=None, show_legend=True, save_plot=None, outline=None, size=(2000, 1000), show=True, title=None
     ):
-        """Plot a net to Matplotlib 2D chart.
+        """Plot the net using Matplotlib.
 
         Parameters
         ----------
-        layers : str, list, optional
-            Name of the layers to include in the plot. If `None` all the signal layers will be considered.
+        layers : str or list[str], optional
+            Layer name(s) to include. If ``None``, uses all signal layers.
         show_legend : bool, optional
-            If `True` the legend is shown in the plot. (default)
-            If `False` the legend is not shown.
+            Enable legend display. Default: ``True``.
         save_plot : str, optional
-            If a path is specified the plot will be saved in this location.
-            If ``save_plot`` is provided, the ``show`` parameter is ignored.
+            Full path to save the plot image. If specified, overrides ``show``.
         outline : list, optional
-            List of points of the outline to plot.
+            Outline points for plot boundary.
         size : tuple, optional
-            Image size in pixel (width, height).
+            Image dimensions in pixels (width, height). Default: (2000, 1000).
         show : bool, optional
-            Whether to show the plot or not. Default is ``True``.
+            Display the plot. Default: ``True``.
         title : str, optional
-            Plot title. If value is ``None`` the project name is assigned by default. Default value is ``None``.
+            Plot title. Uses net name if ``None``. Default: ``None``.
         """
-
         self._pedb.nets.plot(
             self.name,
             layers=layers,
@@ -156,18 +169,17 @@ class Net(GrpcNet):
             show=show,
             plot_components=True,
             plot_vias=True,
-            title=None,
+            title=title,
         )
 
-    def get_smallest_trace_width(self):
-        """Retrieve the smallest trace width from paths.
+    def get_smallest_trace_width(self) -> float:
+        """Get the minimum trace width from path primitives in this net.
 
         Returns
         -------
         float
-            Trace smallest width.
+            Smallest width found in database units. Returns 1e10 if no paths exist.
         """
-
         current_value = 1e10
         paths = [prim for prim in self.primitives if prim.primitive_type == GrpcPrimitiveType.PATH]
         for path in paths:
@@ -177,17 +189,16 @@ class Net(GrpcNet):
 
     @property
     def extended_net(self):
-        """Get extended net and associated components.
+        """Extended net associated with this net.
 
         Returns
         -------
-        :class:`ExtendedNet <pyedb.grpc.database.net.extended_net.ExtendedNet>`
+        :class:`ExtendedNet <pyedb.grpc.database.net.extended_net.ExtendedNet>` or None
+            Extended net object if exists, otherwise ``None``.
 
         Examples
         --------
-        >>> from pyedb import Edb
-        >>> app = Edb()
-        >>> app.nets["BST_V3P3_S5"].extended_net
+        >>> edb.nets["BST_V3P3_S5"].extended_net
         """
         if self.name in self._pedb.extended_nets.items:
             return self._pedb.extended_nets.items[self.name]