Merge pull request #609 from powerapi-ng/refactor/cleanup-report-module

refactor: Cleanup `report` module

Author: gfieni

src/powerapi/cli/generator.py

@@ -42,7 +42,7 @@
 from powerapi.processor.processor_actor import ProcessorActor
 from powerapi.puller import PullerActor
 from powerapi.pusher import PusherActor
-from powerapi.report import HWPCReport, PowerReport, ControlReport, ProcfsReport, Report, FormulaReport
+from powerapi.report import HWPCReport, PowerReport, ControlReport, Report, FormulaReport
 
 COMPONENT_TYPE_KEY = 'type'
 COMPONENT_MODEL_KEY = 'model'
@@ -135,7 +135,7 @@ class BaseGenerator(Generator):
 
     def __init__(self, component_group_name: str):
         Generator.__init__(self, component_group_name)
-        self.report_classes = {
+        self.report_classes: dict[str, type[Report]] = {
             'HWPCReport': HWPCReport,
             'PowerReport': PowerReport
         }
@@ -166,7 +166,6 @@ def __init__(self, component_group_name: str):
         BaseGenerator.__init__(self, component_group_name)
         self.report_classes['FormulaReport'] = FormulaReport
         self.report_classes['ControlReport'] = ControlReport
-        self.report_classes['ProcfsReport'] = ProcfsReport
 
         self.db_factory = {
             'mongodb': lambda db_config: MongoDB(report_type=db_config['model'], uri=db_config['uri'],

src/powerapi/dispatch_rule/__init__.py

@@ -30,4 +30,3 @@
 from powerapi.dispatch_rule.dispatch_rule import DispatchRule
 from powerapi.dispatch_rule.hwpc_dispatch_rule import HWPCDispatchRule, HWPCDepthLevel
 from powerapi.dispatch_rule.power_dispatch_rule import PowerDispatchRule, PowerDepthLevel
-from powerapi.dispatch_rule.procfs_dispatch_rule import ProcfsDispatchRule, ProcfsDepthLevel

src/powerapi/dispatch_rule/procfs_dispatch_rule.py

@@ -27,9 +27,8 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-from powerapi.report.report import Report, BadInputData
-from powerapi.report.power_report import PowerReport
-from powerapi.report.hwpc_report import HWPCReport
-from powerapi.report.control_report import ControlReport
-from powerapi.report.procfs_report import ProcfsReport
-from powerapi.report.formula_report import FormulaReport
+from .control_report import ControlReport
+from .formula_report import FormulaReport
+from .hwpc_report import HWPCReport
+from .power_report import PowerReport
+from .report import Report, BadInputData

src/powerapi/report/__init__.py

@@ -185,10 +185,3 @@ def _create_group(row, groups, group_name):
         for current_key, value in row.items():
             if current_key not in CSV_HEADER_HWPC:
                 groups[group_name][row[SOCKET_KEY]][row[CPU_KEY]][current_key] = int(value)
-
-    @staticmethod
-    def create_empty_report():
-        """
-        Creates an empty report
-        """
-        return HWPCReport(None, None, None, {})

src/powerapi/report/hwpc_report.py

@@ -139,17 +139,6 @@ def to_csv_lines(report: PowerReport, tags: list[str]) -> CsvLines:
         final_dict = {'PowerReport': [line]}
         return CSV_HEADER_POWER, final_dict
 
-    @staticmethod
-    def to_virtiofs_db(report: PowerReport) -> tuple[str, str]:
-        """
-        return a tuple containing the power value and the name of the file to store the value.
-        """
-        if 'socket' not in report:
-            raise BadInputData('no tag socket in power report', report)
-        filename = 'power_consumption_package' + str(report['socket'])
-        power = report.power
-        return filename, power
-
     def generate_tags(self, selected_tags: None | list[str] = None) -> dict[str, Any]:
         """
         Generate the report tags from its metadata.
@@ -205,10 +194,3 @@ def from_mongodb(data: dict) -> Report:
         :return: a PowerReport from a dictionary pulled from mongodb
         """
         return PowerReport.from_json(data)
-
-    @staticmethod
-    def create_empty_report():
-        """
-        Creates an empty report
-        """
-        return PowerReport(None, None, None, 0)

src/powerapi/report/power_report.py

@@ -133,13 +133,6 @@ def _extract_timestamp(ts):
 
         raise ValueError('Invalid timestamp format')
 
-    @staticmethod
-    def create_empty_report():
-        """
-        Creates an empty report
-        """
-        return Report(None, None, None)
-
     @staticmethod
     def sanitize_tags_name(tags: Iterable[str]) -> dict[str, str]:
         """

src/powerapi/report/procfs_report.py

@@ -169,12 +169,12 @@ def test_remove_model_factory_that_does_not_exist_on_a_DBActorGenerator_must_rai
     """
     generator = DBActorGenerator('input')
 
-    assert len(generator.report_classes) == 5
+    assert len(generator.report_classes) == 4
 
     with pytest.raises(ModelNameDoesNotExist):
         generator.remove_report_class('model')
 
-    assert len(generator.report_classes) == 5
+    assert len(generator.report_classes) == 4
 
 
 def test_remove_hwpc_report_model_and_generate_puller_from_a_config_with_hwpc_report_model_raise_an_exception(