private _return_estimation_object

Author: tanner-andrulis

hwcomponents/_model_wrapper.py

@@ -4,7 +4,11 @@
 from types import ModuleType
 from typing import Any, Callable, Dict, List, Optional, Set, Union
 from .model import EnergyAreaModel
-from ._logging import move_queue_from_one_logger_to_another, ListLoggable, pop_all_messages
+from ._logging import (
+    move_queue_from_one_logger_to_another,
+    ListLoggable,
+    pop_all_messages,
+)
 
 
 class EstimatorError(Exception):

hwcomponents/_version.py

@@ -28,7 +28,7 @@
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '5.0.7'
-__version_tuple__ = version_tuple = (5, 0, 7)
+__version__ = version = "5.0.12"
+__version_tuple__ = version_tuple = (5, 0, 12)
 
-__commit_id__ = commit_id = 'ga2a56804b'
+__commit_id__ = commit_id = "gb5d4621f3"

hwcomponents/_version_scheme.py

@@ -1,13 +1,18 @@
 """Version scheme for setuptools-scm - creates post-release versions."""
+
 from setuptools_scm.version import guess_next_version
 
 
 def post_version(version):
     """Create post-release versions instead of dev versions."""
     if version.exact:
-        return version.format_with("{tag}").lstrip('v')
+        return version.format_with("{tag}").lstrip("v")
 
-    base = str(version.tag).lstrip('v') if version.tag else (guess_next_version(version) or "1.0")
+    base = (
+        str(version.tag).lstrip("v")
+        if version.tag
+        else (guess_next_version(version) or "1.0")
+    )
     distance = version.distance or 0
 
     return f"{base}.{distance}" if distance > 0 else base

hwcomponents/find_models.py

@@ -155,7 +155,7 @@ def get_models(
             globbed = glob.glob(path_or_package, recursive=True)
             flattened.extend(globbed)
         else:
-            raise ValueError(f'Invalid type: {type(path_or_package)}')
+            raise ValueError(f"Invalid type: {type(path_or_package)}")
 
     if _return_wrappers:
         models = [EnergyAreaModelWrapper(m, m.__name__) for m in models]
@@ -239,7 +239,9 @@ def get_models(
         models.extend(new_models)
 
     if _return_wrappers:
-        models = [m for m in models if name_must_include.lower() in m.model_name.lower()]
+        models = [
+            m for m in models if name_must_include.lower() in m.model_name.lower()
+        ]
         return sorted(models, key=lambda x: x.model_name)
     models = [m for m in models if name_must_include.lower() in m.__name__.lower()]
     return sorted(models, key=lambda x: x.__name__)

hwcomponents/model.py

@@ -8,6 +8,7 @@
 
 T = TypeVar("T", bound="EnergyAreaModel")
 
+
 def actionDynamicEnergy(
     func: Callable[[], float] = None, bits_per_action: str = None
 ) -> Callable[[], float]:
@@ -157,11 +158,11 @@ class EnergyAreaModel(ListLoggable, ABC):
 
     @abstractmethod
     def __init__(
-            self,
-            leak_power: float | None = None,
-            area: float | None = None,
-            subcomponents: list["EnergyAreaModel"] | None = None,
-        ):
+        self,
+        leak_power: float | None = None,
+        area: float | None = None,
+        subcomponents: list["EnergyAreaModel"] | None = None,
+    ):
         if subcomponents is None:
             if leak_power is None or area is None:
                 raise ValueError(
@@ -174,7 +175,9 @@ def __init__(
         self.leak_scale: float = 1
         self._leak_power: float = leak_power if leak_power is not None else 0
         self._area: float = area if area is not None else 0
-        self.subcomponents: list["EnergyAreaModel"] = [] if subcomponents is None else subcomponents
+        self.subcomponents: list["EnergyAreaModel"] = (
+            [] if subcomponents is None else subcomponents
+        )
         self._subcomponents_set = subcomponents is not None
         self._energy_used: float = 0
 
@@ -200,9 +203,7 @@ def area(self) -> Number:
         -------
             The area in m^2 of the component.
         """
-        return self._area * self.area_scale + sum(
-            s.area for s in self.subcomponents
-        )
+        return self._area * self.area_scale + sum(s.area for s in self.subcomponents)
 
     @classmethod
     def _component_name(cls) -> str:
@@ -251,12 +252,8 @@ def scale(
                     f"Scaled {key} from {default} to {target}: {attr} multiplied by {scale}"
                 )
             except:
-                target_float = parse_float(
-                    target, f"{self._component_name()}.{key}"
-                )
-                default_float = parse_float(
-                    default, f"{self._component_name()}.{key}"
-                )
+                target_float = parse_float(target, f"{self._component_name()}.{key}")
+                default_float = parse_float(default, f"{self._component_name()}.{key}")
                 scale = callfunc(target_float, default_float)
                 setattr(self, attr, prev_val * scale)
                 self.logger.info(
@@ -292,7 +289,6 @@ def required_arguments(self, action_name: str | None = None) -> List[str]:
             action_name : str | None
                 The name of the action to get the required arguments for.
                 If None, returns the required arguments for the __init__ method.
-
         Returns
         -------
             list[str]
@@ -309,31 +305,39 @@ def required_arguments(self, action_name: str | None = None) -> List[str]:
         return inspect.signature(action_func).parameters.keys()
 
     @classmethod
-    def try_init_arbitrary_args(cls: Type[T], **kwargs) -> T:
+    def try_init_arbitrary_args(
+        cls: Type[T], _return_estimation_object: bool = False, **kwargs
+    ) -> T:
         """
         Tries to initialize the model with the given arguments.
 
         Parameters
         ----------
             **kwargs : dict
                 The arguments with which to initialize the model.
-
+            _return_estimation_object : bool
+                Whether to return the Estimation object instead of the model.
         Returns
         -------
             The initialized model. If the model cannot be initialized with the given
             arguments, an exception is raised.
         """
         from hwcomponents._model_wrapper import EnergyAreaQuery, EnergyAreaModelWrapper
+
         wrapper = EnergyAreaModelWrapper(cls, cls.component_name)
         cname = cls.component_name
         query = EnergyAreaQuery(
             component_name=cname if isinstance(cname, str) else cname[0],
             component_attributes=kwargs,
         )
-        return wrapper.get_initialized_subclass(query)
-
-
-    def try_call_arbitrary_action(self: T, action_name: str, **kwargs) -> T:
+        value = wrapper.get_initialized_subclass(query)
+        if _return_estimation_object:
+            return value
+        return value.value
+
+    def try_call_arbitrary_action(
+        self: T, action_name: str, _return_estimation_object: bool = False, **kwargs
+    ) -> T:
         """
         Tries to call the given action with the given arguments.
 
@@ -345,11 +349,15 @@ def try_call_arbitrary_action(self: T, action_name: str, **kwargs) -> T:
                 The arguments with which to call the action.
         """
         from hwcomponents._model_wrapper import EnergyAreaQuery, EnergyAreaModelWrapper
+
         wrapper = EnergyAreaModelWrapper(type(self), self.component_name)
         query = EnergyAreaQuery(
             component_name=self.component_name,
             component_attributes={},
             action_name=action_name,
             action_arguments=kwargs,
         )
-        return wrapper.estimate_energy(query, initialized_obj=self)
+        value = wrapper.estimate_energy(query, initialized_obj=self)
+        if _return_estimation_object:
+            return value
+        return value.value

hwcomponents/select_models.py

@@ -127,7 +127,7 @@ def _get_best_estimate(
     query: EnergyAreaQuery,
     target: str,
     models: List[EnergyAreaModelWrapper] | List[EnergyAreaModel] = None,
-    return_estimation_object: bool = False,
+    _return_estimation_object: bool = False,
     _relaxed_component_name_selection: bool = False,
 ) -> FloatEstimation | EnergyAreaModel:
     if models is None:
@@ -263,7 +263,7 @@ def _get_supported_models(relaxed_component_name_selection: bool):
 
     clear_logs()
 
-    if return_estimation_object and estimation is not None:
+    if _return_estimation_object and estimation is not None:
         return estimation
 
     if estimation is not None and estimation.success:
@@ -285,7 +285,7 @@ def get_energy(
     action_name: str,
     action_arguments: Dict[str, Any],
     models: List[EnergyAreaModelWrapper] = None,
-    return_estimation_object: bool = False,
+    _return_estimation_object: bool = False,
     _relaxed_component_name_selection: bool = False,
 ) -> float | Estimation:
     """
@@ -301,7 +301,7 @@ def get_energy(
         action_name: The name of the action.
         action_arguments: The arguments of the action.
         models: The models to use.
-        return_estimation_object: Whether to return the estimation object instead of
+        _return_estimation_object: Whether to return the estimation object instead of
             the energy value.
         _relaxed_component_name_selection: Whether to relax the component name
             selection. Relaxed selection ignores underscores in the component name.
@@ -317,7 +317,7 @@ def get_energy(
         query,
         "energy",
         models,
-        return_estimation_object,
+        _return_estimation_object,
         _relaxed_component_name_selection,
     )
 
@@ -326,7 +326,7 @@ def get_area(
     component_name: str,
     component_attributes: Dict[str, Any],
     models: List[EnergyAreaModelWrapper] = None,
-    return_estimation_object: bool = False,
+    _return_estimation_object: bool = False,
     _relaxed_component_name_selection: bool = False,
 ) -> float | Estimation:
     """
@@ -339,7 +339,7 @@ def get_area(
         component_name: The name of the component.
         component_attributes: The attributes of the component.
         models: The models to use.
-        return_estimation_object: Whether to return the estimation object instead of
+        _return_estimation_object: Whether to return the estimation object instead of
             the area value.
         _relaxed_component_name_selection: Whether to relax the component name
             selection. Relaxed selection ignores underscores in the component name.
@@ -353,7 +353,7 @@ def get_area(
         query,
         "area",
         models,
-        return_estimation_object,
+        _return_estimation_object,
         _relaxed_component_name_selection,
     )
 
@@ -362,7 +362,7 @@ def get_leak_power(
     component_name: str,
     component_attributes: Dict[str, Any],
     models: List[EnergyAreaModelWrapper] = None,
-    return_estimation_object: bool = False,
+    _return_estimation_object: bool = False,
     _relaxed_component_name_selection: bool = False,
 ) -> float | Estimation:
     """
@@ -387,7 +387,7 @@ def get_leak_power(
         query,
         "leak_power",
         models,
-        return_estimation_object,
+        _return_estimation_object,
         _relaxed_component_name_selection,
     )
 
@@ -397,7 +397,7 @@ def get_model(
     component_attributes: Dict[str, Any],
     required_actions: List[str] = (),
     models: List[EnergyAreaModelWrapper] = None,
-    return_estimation_object: bool = False,
+    _return_estimation_object: bool = False,
     _relaxed_component_name_selection: bool = False,
 ) -> EnergyAreaModelWrapper:
     """
@@ -411,7 +411,7 @@ def get_model(
         component_attributes: The attributes of the component.
         required_actions: The actions that are required for the component.
         models: The models to use.
-        return_estimation_object: Whether to return the estimation object instead of
+        _return_estimation_object: Whether to return the estimation object instead of
             the model wrapper.
         _relaxed_component_name_selection: Whether to relax the component name
             selection. Relaxed selection ignores underscores in the component name.
@@ -423,4 +423,10 @@ def get_model(
     query = EnergyAreaQuery(
         component_name.lower(), component_attributes, None, None, required_actions
     )
-    return _get_best_estimate(query, "model", models, return_estimation_object, _relaxed_component_name_selection)
+    return _get_best_estimate(
+        query,
+        "model",
+        models,
+        _return_estimation_object,
+        _relaxed_component_name_selection,
+    )