ready for release 2.4.2

Author: dadyownes15

carbontracker/tracker.py

@@ -62,7 +62,7 @@ def _fetch_carbon_intensity(self):
 
     def predict_carbon_intensity(self, pred_time_dur) -> float:
         new_fetch = self.carbon_intensity_service.fetch_carbon_intensity(time_duration=pred_time_dur)
-        
+
 
         weighted_intensities = [
             fetch.carbon_intensity for fetch in self.carbon_intensities_fetches
@@ -256,8 +256,7 @@ class CarbonTracker:
 
     Args:
         epochs (int): Total epochs of your training loop.
-        api_keys (dict, optional): Dictionary of Carbon Intensity API keys following the {name:key} format. Can also be set using `CarbonTracker.set_api_keys`
-
+        api_keys (dict, optional): Dictionary of Carbon Intensity API keys following the {name:key} format. 
             Example: `{ \\"electricitymaps\\": \\"abcdefg\\" }`
         epochs_before_pred (int, optional): Epochs to monitor before outputting predicted consumption. Set to -1 for all epochs. Set to 0 for no prediction.
         monitor_epochs (int, optional): Total number of epochs to monitor. Outputs actual consumption when reached. Set to -1 for all epochs. Cannot be less than `epochs_before_pred` or equal to 0.
@@ -461,6 +460,10 @@ def stop(self):
         self._output_actual()
         self._delete()
 
+    def set_api_keys(self, api_keys):
+        self.api_keys = api_keys
+        self._get_fetcher()
+
     def _handle_error(self, error):
         err_str = traceback.format_exc()
         if self.ignore_errors:
@@ -508,7 +511,7 @@ def _output_actual(self):
             )
         else:
             self._output_energy(
-                f"Actual consumption for {self.epoch_counter+1} epoch(s):",
+                f"Actual consumption for {self.epoch_counter} epoch(s):",
                 time,
                 energy,
                 _co2eq,
@@ -639,7 +642,6 @@ def _get_fetcher(self) -> Optional[IntensityFetcher]:
             except Exception:
                 provider_name = provider_id
 
-            # Try to initialize the provider
             try:
                 initialized_provider = constructor(logger=self.logger, api_key=api_key)
                 self.logger.err_info(f"Using intensity provider: {provider_name} ('{provider_id}').")
@@ -653,7 +655,7 @@ def _get_fetcher(self) -> Optional[IntensityFetcher]:
             msg = f"No matching provider for API keys: {', '.join(unknown_keys)}."
             if available_display:
                 msg += f" Supported providers: {available_display}."
-            self.logger.err_warn(msg)
+            self.logger.err_critical(msg)
+            sys.exit(70)
 
         return None
-

tests/test_loggerutil.py

@@ -162,7 +162,7 @@ def test_output(self, mock_info):
 
         logger.output(test_message)
 
-        mock_info.assert_called_once_with(f"CarbonTracker: {test_message}")
+        mock_info.assert_called_once_with(f"CarbonTracker: {test_message}", extra={'verbose_level':0})
 
     def test_multiple_loggers(self):
         logger1 = loggerutil.Logger(logger_id="1")

tests/test_tracker.py

@@ -618,7 +618,7 @@ def test_output_actual_zero_epochs(self):
             "\tEnergy:\t60.000000 kWh\n"
             "\tCO2eq:\t150.000000 g"
             "\n\tThis is equivalent to:\n"
-            "\t1.395349 km travelled by car"
+            "\t1.404494 km travelled by car"
         )
 
         self.mock_logger.output.assert_called_once_with(
@@ -648,7 +648,7 @@ def test_output_actual_nonzero_epochs(self):
             "\tEnergy:\t60.000000 kWh\n"
             "\tCO2eq:\t150.000000 g"
             "\n\tThis is equivalent to:\n"
-            "\t1.395349 km travelled by car"
+            "\t1.404494 km travelled by car"
         )
 
         self.mock_logger.output.assert_called_once_with(
@@ -681,7 +681,7 @@ def test_output_pred(self):
             "\tEnergy:\t100.000000 kWh\n"
             "\tCO2eq:\t150.000000 g"
             "\n\tThis is equivalent to:\n"
-            "\t1.395349 km travelled by car"
+            "\t1.404494 km travelled by car"
         )
 
         self.mock_logger.output.assert_called_once_with(
@@ -692,7 +692,7 @@ def test_co2eq_with_pred_time_dur(self):
         assert self.tracker is not None
         intensity_updater = MagicMock()
         intensity_updater.predict_carbon_intensity = MagicMock(
-            return_value=MagicMock(carbon_intensity=0.5)
+            return_value=0.5
         )
 
         energy_usage = 100
@@ -709,7 +709,7 @@ def test_co2eq_without_pred_time_dur(self):
         assert self.tracker is not None
         intensity_updater = MagicMock()
         intensity_updater.average_carbon_intensity = MagicMock(
-            return_value=MagicMock(carbon_intensity=0.5)
+            return_value=0.5
         )
 
         energy_usage = 100
@@ -928,5 +928,75 @@ def test_all_sim_parameters_ok(self):
         self.assertEqual(tracker.sim_gpu_util, 0.8)
 
 
+class TestCarbonTrackerFetcherInitialization(unittest.TestCase):
+    def setUp(self):
+        self.mock_logger = MagicMock()
+        self.mock_tracker_thread_instance = MagicMock()
+        self.mock_intensity_thread_instance = MagicMock()
+        self.patcher_logger = patch(
+            "carbontracker.tracker.loggerutil.Logger", return_value=self.mock_logger
+        )
+        self.patcher_tracker_thread = patch(
+            "carbontracker.tracker.CarbonTrackerThread",
+            return_value=self.mock_tracker_thread_instance,
+        )
+        self.patcher_intensity_thread = patch("carbontracker.tracker.CarbonIntensityThread")
+        self.patcher_get_pids = patch(
+            "carbontracker.tracker.CarbonTracker._get_pids", return_value=[]
+        )
+        self.patcher_components = patch(
+            "carbontracker.tracker.component.create_components", return_value=[]
+        )
+
+        self.patcher_logger.start()
+        self.patcher_tracker_thread.start()
+        self.mock_intensity_thread_class = self.patcher_intensity_thread.start()
+        self.mock_intensity_thread_class.return_value = self.mock_intensity_thread_instance
+        self.patcher_get_pids.start()
+        self.patcher_components.start()
+
+    def tearDown(self):
+        self.patcher_components.stop()
+        self.patcher_get_pids.stop()
+        self.patcher_intensity_thread.stop()
+        self.patcher_tracker_thread.stop()
+        self.patcher_logger.stop()
+
+    def _build_tracker(self, api_keys):
+        return CarbonTracker(epochs=1, api_keys=api_keys)
+
+    def _assert_intensity_fetcher_used(self, provider_key, patch_target, api_key):
+        expected_fetcher = MagicMock(name=f"{provider_key}_fetcher")
+        with patch(patch_target, return_value=expected_fetcher) as mock_constructor:
+            self._build_tracker({provider_key: api_key})
+
+        mock_constructor.assert_called_once_with(logger=self.mock_logger, api_key=api_key)
+        self.mock_intensity_thread_class.assert_called_once()
+        intensity_fetcher = self.mock_intensity_thread_class.call_args.kwargs[
+            "intensity_fetcher"
+        ]
+        self.assertIs(intensity_fetcher, expected_fetcher)
+
+    def test_electricitymaps_api_key_attaches_fetcher(self):
+        self._assert_intensity_fetcher_used(
+            "electricitymaps",
+            "carbontracker.tracker.electricitymaps.ElectricityMap",
+            "electric_key",
+        )
+
+    def test_carbonintensitygb_api_key_attaches_fetcher(self):
+        self._assert_intensity_fetcher_used(
+            "carbonintensityGB",
+            "carbontracker.tracker.carbonintensitygb.CarbonIntensityGB",
+            "gb_key",
+        )
+
+    def test_energidataservice_api_key_attaches_fetcher(self):
+        self._assert_intensity_fetcher_used(
+            "energidataservice",
+            "carbontracker.tracker.energidataservice.EnergiDataService",
+            "dk_key",
+        )
+
 if __name__ == "__main__":
     unittest.main()