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

pyedb/grpc/database/nets.py

@@ -22,6 +22,7 @@
 
 from __future__ import absolute_import  # noreorder
 
+from typing import Any, Dict, List, Optional, Set, Tuple, Union
 import warnings
 
 from pyedb.common.nets import CommonNets
@@ -152,7 +153,7 @@ class Nets(CommonNets):
     >>> edbapp.close()
     """
 
-    def __getitem__(self, name):
+    def __getitem__(self, name: str) -> Net:
         """Get a net by name.
 
         Parameters
@@ -172,7 +173,7 @@ class Nets(CommonNets):
         """
         return Net(self._pedb, Net.find_by_name(self._active_layout, name))
 
-    def __contains__(self, name):
+    def __contains__(self, name: str) -> bool:
         """Check if a net exists in the layout.
 
         Parameters
@@ -192,11 +193,11 @@ class Nets(CommonNets):
         """
         return name in self.nets
 
-    def __init__(self, p_edb):
+    def __init__(self, p_edb: Any) -> None:
         """Initialize the Nets class."""
         CommonNets.__init__(self, p_edb)
-        self._nets_by_comp_dict = {}
-        self._comps_by_nets_dict = {}
+        self._nets_by_comp_dict: Dict[str, List[str]] = {}
+        self._comps_by_nets_dict: Dict[str, List[str]] = {}
 
     @property
     def _edb(self):
@@ -229,7 +230,7 @@ class Nets(CommonNets):
         return self._pedb.logger
 
     @property
-    def nets(self):
+    def nets(self) -> Dict[str, Net]:
         """All nets in the layout.
 
         Returns
@@ -246,7 +247,7 @@ class Nets(CommonNets):
         return {i.name: i for i in self._pedb.layout.nets}
 
     @property
-    def netlist(self):
+    def netlist(self) -> List[str]:
         """List of all net names.
 
         Returns
@@ -262,7 +263,7 @@ class Nets(CommonNets):
         return list(self.nets.keys())
 
     @property
-    def signal(self):
+    def signal(self) -> Dict[str, Net]:
         """Signal nets in the layout.
 
         Returns
@@ -282,7 +283,7 @@ class Nets(CommonNets):
         return nets
 
     @property
-    def power(self):
+    def power(self) -> Dict[str, Net]:
         """Power and ground nets in the layout.
 
         Returns
@@ -301,7 +302,7 @@ class Nets(CommonNets):
                 nets[net] = value
         return nets
 
-    def eligible_power_nets(self, threshold=0.3):
+    def eligible_power_nets(self, threshold: float = 0.3) -> List[Net]:
         """Identify nets eligible for power/ground classification based on area ratio.
 
         Uses the same algorithm implemented in SIwave.
@@ -343,7 +344,7 @@ class Nets(CommonNets):
         return pwr_gnd_nets
 
     @property
-    def nets_by_components(self):
+    def nets_by_components(self) -> Dict[str, List[str]]:
         """Mapping of components to their associated nets.
 
         Returns
@@ -361,7 +362,7 @@ class Nets(CommonNets):
         return self._nets_by_comp_dict
 
     @property
-    def components_by_nets(self):
+    def components_by_nets(self) -> Dict[str, List[str]]:
         """Mapping of nets to their associated components.
 
         Returns
@@ -384,13 +385,13 @@ class Nets(CommonNets):
 
     def generate_extended_nets(
         self,
-        resistor_below=10,
-        inductor_below=1,
-        capacitor_above=1,
-        exception_list=None,
-        include_signal=True,
-        include_power=True,
-    ):
+        resistor_below: Union[int, float] = 10,
+        inductor_below: Union[int, float] = 1,
+        capacitor_above: Union[int, float] = 1,
+        exception_list: Optional[List[str]] = None,
+        include_signal: bool = True,
+        include_power: bool = True,
+    ) -> List[Any]:
         """Generate extended nets based on component thresholds.
 
         .. deprecated:: pyedb 0.30.0
@@ -430,7 +431,7 @@ class Nets(CommonNets):
         )
 
     @staticmethod
-    def _get_points_for_plot(my_net_points):
+    def _get_points_for_plot(my_net_points: List[Any]) -> Tuple[List[float], List[float]]:
         """Get points for plotting.
 
         Parameters
@@ -464,7 +465,9 @@ class Nets(CommonNets):
         # fmt: on
         return x, y
 
-    def classify_nets(self, power_nets=None, signal_nets=None):
+    def classify_nets(
+        self, power_nets: Optional[Union[str, List[str]]] = None, signal_nets: Optional[Union[str, List[str]]] = None
+    ) -> bool:
         """Reassign net classifications as power/ground or signal.
 
         Parameters
@@ -502,7 +505,7 @@ class Nets(CommonNets):
                 self.nets[net].is_power_ground = False
         return True
 
-    def is_power_gound_net(self, netname_list):
+    def is_power_gound_net(self, netname_list: Union[str, List[str]]) -> bool:
         """Check if any net in a list is a power/ground net.
 
         Parameters
@@ -528,7 +531,7 @@ class Nets(CommonNets):
                 return True
         return False
 
-    def get_dcconnected_net_list(self, ground_nets=["GND"], res_value=0.001):
+    def get_dcconnected_net_list(self, ground_nets: List[str] = ["GND"], res_value: float = 0.001) -> List[Set[str]]:
         """Get nets connected to DC through inductors and low-value resistors.
 
         Parameters
@@ -586,7 +589,9 @@ class Nets(CommonNets):
 
         return dcconnected_net_list
 
-    def get_powertree(self, power_net_name, ground_nets):
+    def get_powertree(
+        self, power_net_name: str, ground_nets: List[str]
+    ) -> Tuple[List[List[str]], List[str], List[str]]:
         """Retrieve power tree for a given power net.
 
         Parameters
@@ -654,7 +659,7 @@ class Nets(CommonNets):
         ]
         return component_list, component_list_columns, net_group
 
-    def get_net_by_name(self, net_name):
+    def get_net_by_name(self, net_name: str) -> Optional[Net]:
         """Find a net by name.
 
         Parameters
@@ -677,7 +682,7 @@ class Nets(CommonNets):
         if edb_net is not None:
             return edb_net
 
-    def delete(self, netlist):
+    def delete(self, netlist: Union[str, List[str]]) -> List[str]:
         """Delete one or more nets from the layout.
 
         Parameters
@@ -708,7 +713,9 @@ class Nets(CommonNets):
                 nets_deleted.append(i.name)
         return nets_deleted
 
-    def find_or_create_net(self, net_name="", start_with="", contain="", end_with=""):
+    def find_or_create_net(
+        self, net_name: str = "", start_with: str = "", contain: str = "", end_with: str = ""
+    ) -> Union[Net, List[Net]]:
         """Find or create a net based on given criteria.
 
         Parameters
@@ -789,7 +796,7 @@ class Nets(CommonNets):
                 nets_found = [self.nets[net] for net in list(self.nets.keys()) if contain in net.lower()]
                 return nets_found
 
-    def is_net_in_component(self, component_name, net_name):
+    def is_net_in_component(self, component_name: str, net_name: str) -> bool:
         """Check if a net belongs to a component.
 
         Parameters
@@ -817,8 +824,12 @@ class Nets(CommonNets):
         return False
 
     def find_and_fix_disjoint_nets(
-        self, net_list=None, keep_only_main_net=False, clean_disjoints_less_than=0.0, order_by_area=False
-    ):
+        self,
+        net_list: Optional[List[str]] = None,
+        keep_only_main_net: bool = False,
+        clean_disjoints_less_than: float = 0.0,
+        order_by_area: bool = False,
+    ) -> List[str]:
         """Find and fix disjoint nets.
 
         .. deprecated:: pyedb 0.30.0
@@ -856,7 +867,7 @@ class Nets(CommonNets):
             net_list, keep_only_main_net, clean_disjoints_less_than, order_by_area
         )
 
-    def merge_nets_polygons(self, net_names_list):
+    def merge_nets_polygons(self, net_names_list: Union[str, List[str]]) -> bool:
         """Merge polygons for specified nets on each layer.
 
         Parameters