refactor: move util function (now no longer exclusively used in tests)

Flix6x · Flix6x · commit 9e331761d89e · 2026-01-26T10:02:49.000+01:00
Signed-off-by: F.N. Claessen &lt;felix@seita.nl&gt;
diff --git a/flexmeasures/api/v3_0/tests/test_asset_schedules_fresh_db.py b/flexmeasures/api/v3_0/tests/test_asset_schedules_fresh_db.py
@@ -11,7 +11,7 @@
 from flexmeasures import Sensor
 from flexmeasures.api.v3_0.tests.utils import message_for_trigger_schedule
 from flexmeasures.data.models.planning.tests.utils import check_constraints
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import (
     handle_scheduling_exception,
     get_data_source_for_job,
diff --git a/flexmeasures/api/v3_0/tests/test_forecasting_api.py b/flexmeasures/api/v3_0/tests/test_forecasting_api.py
@@ -6,7 +6,7 @@
     get_data_source_for_job,
 )
 from rq.job import Job
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.api.tests.utils import get_auth_token
 from flexmeasures.data.services.forecasting import handle_forecasting_exception
 from flexmeasures.data.models.forecasting.pipelines import TrainPredictPipeline
diff --git a/flexmeasures/api/v3_0/tests/test_sensor_schedules.py b/flexmeasures/api/v3_0/tests/test_sensor_schedules.py
@@ -9,7 +9,7 @@
 from flexmeasures.api.tests.utils import check_deprecation
 from flexmeasures.api.v3_0.tests.utils import message_for_trigger_schedule
 from flexmeasures.data.models.data_sources import DataSource
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import handle_scheduling_exception
 from flexmeasures.tests.utils import get_test_sensor
 from flexmeasures.utils.unit_utils import ur
diff --git a/flexmeasures/api/v3_0/tests/test_sensor_schedules_fresh_db.py b/flexmeasures/api/v3_0/tests/test_sensor_schedules_fresh_db.py
@@ -11,7 +11,7 @@
 from flexmeasures.data.models.generic_assets import GenericAsset
 from flexmeasures.data.models.planning.utils import get_power_values
 from flexmeasures.data.models.time_series import Sensor, TimedBelief
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import (
     handle_scheduling_exception,
     get_data_source_for_job,
diff --git a/flexmeasures/cli/jobs.py b/flexmeasures/cli/jobs.py
@@ -31,7 +31,7 @@
 from flexmeasures.data.schemas import AssetIdField, SensorIdField
 from flexmeasures.data.services.scheduling import handle_scheduling_exception
 from flexmeasures.data.services.forecasting import handle_forecasting_exception
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.cli.utils import MsgStyle
 from flexmeasures.utils.flexmeasures_inflection import join_words_into_a_list
 
diff --git a/flexmeasures/data/tests/test_forecasting_jobs.py b/flexmeasures/data/tests/test_forecasting_jobs.py
@@ -9,7 +9,7 @@
 
 from flexmeasures.data.models.data_sources import DataSource
 from flexmeasures.data.models.time_series import Sensor, TimedBelief
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.forecasting import (
     create_forecasting_jobs,
     handle_forecasting_exception,
diff --git a/flexmeasures/data/tests/test_forecasting_jobs_fresh_db.py b/flexmeasures/data/tests/test_forecasting_jobs_fresh_db.py
@@ -14,7 +14,7 @@
     check_failures,
     get_data_source,
 )
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.utils.time_utils import as_server_time
 
 
diff --git a/flexmeasures/data/tests/test_scheduling_jobs.py b/flexmeasures/data/tests/test_scheduling_jobs.py
@@ -14,7 +14,8 @@
 from flexmeasures.data.models.planning.utils import initialize_series
 from flexmeasures.data.models.data_sources import DataSource
 from flexmeasures.data.models.time_series import TimedBelief
-from flexmeasures.data.tests.utils import work_on_rq, exception_reporter
+from flexmeasures.data.tests.utils import exception_reporter
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import (
     create_scheduling_job,
     load_custom_scheduler,
diff --git a/flexmeasures/data/tests/test_scheduling_jobs_fresh_db.py b/flexmeasures/data/tests/test_scheduling_jobs_fresh_db.py
@@ -7,7 +7,8 @@
 from flexmeasures.data.models.data_sources import DataSource
 from flexmeasures.data.models.time_series import TimedBelief
 from flexmeasures.data.services.scheduling import create_scheduling_job
-from flexmeasures.data.tests.utils import work_on_rq, exception_reporter
+from flexmeasures.data.tests.utils import exception_reporter
+from flexmeasures.utils.job_utils import work_on_rq
 
 
 def test_scheduling_a_charging_station(
diff --git a/flexmeasures/data/tests/test_scheduling_repeated_jobs.py b/flexmeasures/data/tests/test_scheduling_repeated_jobs.py
@@ -12,7 +12,8 @@
 from flexmeasures.data.models.data_sources import DataSource
 from flexmeasures.data.models.generic_assets import GenericAsset
 from flexmeasures.data.models.time_series import Sensor
-from flexmeasures.data.tests.utils import work_on_rq, exception_reporter
+from flexmeasures.data.tests.utils import exception_reporter
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import create_scheduling_job
 from flexmeasures.data.services.utils import hash_function_arguments, job_cache
 
diff --git a/flexmeasures/data/tests/test_scheduling_repeated_jobs_fresh_db.py b/flexmeasures/data/tests/test_scheduling_repeated_jobs_fresh_db.py
@@ -4,7 +4,8 @@
 
 import pytz
 
-from flexmeasures.data.tests.utils import work_on_rq, exception_reporter
+from flexmeasures.data.tests.utils import exception_reporter
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import create_scheduling_job
 from flexmeasures.data.models.planning import Scheduler
 from flexmeasures.data.services.scheduling import load_custom_scheduler
diff --git a/flexmeasures/data/tests/test_scheduling_sequential.py b/flexmeasures/data/tests/test_scheduling_sequential.py
@@ -4,7 +4,7 @@
 import pandas as pd
 from rq.job import Job
 from flexmeasures.data.services.scheduling import create_sequential_scheduling_job
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.scheduling import handle_scheduling_exception
 from flexmeasures.data.models.time_series import Sensor
 
diff --git a/flexmeasures/data/tests/test_scheduling_simultaneous.py b/flexmeasures/data/tests/test_scheduling_simultaneous.py
@@ -3,7 +3,7 @@
 import numpy as np
 import pandas as pd
 from flexmeasures.data.services.scheduling import create_simultaneous_scheduling_job
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.models.time_series import Sensor
 
 
diff --git a/flexmeasures/data/tests/test_train_predict_pipeline.py b/flexmeasures/data/tests/test_train_predict_pipeline.py
@@ -10,7 +10,7 @@
 
 from flexmeasures.data.models.forecasting.pipelines import TrainPredictPipeline
 from flexmeasures.data.models.forecasting.exceptions import CustomException
-from flexmeasures.data.tests.utils import work_on_rq
+from flexmeasures.utils.job_utils import work_on_rq
 from flexmeasures.data.services.forecasting import handle_forecasting_exception
 
 
diff --git a/flexmeasures/data/tests/utils.py b/flexmeasures/data/tests/utils.py
@@ -1,39 +1,8 @@
 from __future__ import annotations
 
-import os
 from traceback import print_tb
 
 import click
-from rq import Queue
-from rq.job import Job
-
-
-def work_on_rq(
-    redis_queue: Queue, job: Job | str | None = None, exc_handler=None, max_jobs=None
-):
-
-    #  we only want this import distinction to matter when we actually are testing
-    if os.name == "nt":
-        from rq_win import WindowsWorker as SimpleWorker
-    else:
-        from rq import SimpleWorker
-
-    exc_handlers = []
-    if exc_handler is not None:
-        exc_handlers.append(exc_handler)
-    print("STARTING SIMPLE RQ WORKER, seeing %d job(s)" % redis_queue.count)
-    worker = SimpleWorker(
-        [redis_queue],
-        connection=redis_queue.connection,
-        exception_handlers=exc_handlers,
-    )
-
-    if job:
-        if isinstance(job, str):
-            job = Job.fetch(job, connection=redis_queue.connection)
-        worker.perform_job(job, redis_queue)
-    else:
-        worker.work(burst=True, max_jobs=max_jobs)
 
 
 def exception_reporter(job, exc_type, exc_value, traceback):
diff --git a/flexmeasures/utils/job_utils.py b/flexmeasures/utils/job_utils.py
@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import os
+
+from rq import Queue
+from rq.job import Job
+
+
+def work_on_rq(
+    redis_queue: Queue, job: Job | str | None = None, exc_handler=None, max_jobs=None
+):
+
+    #  we only want this import distinction to matter when we actually are testing
+    if os.name == "nt":
+        from rq_win import WindowsWorker as SimpleWorker
+    else:
+        from rq import SimpleWorker
+
+    exc_handlers = []
+    if exc_handler is not None:
+        exc_handlers.append(exc_handler)
+    print("STARTING SIMPLE RQ WORKER, seeing %d job(s)" % redis_queue.count)
+    worker = SimpleWorker(
+        [redis_queue],
+        connection=redis_queue.connection,
+        exception_handlers=exc_handlers,
+    )
+
+    if job:
+        if isinstance(job, str):
+            job = Job.fetch(job, connection=redis_queue.connection)
+        worker.perform_job(job, redis_queue)
+    else:
+        worker.work(burst=True, max_jobs=max_jobs)

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`get_data_source_for_job,`
`7`	`7`	`)`
`8`	`8`	`from rq.job import Job`
`9`		`-from flexmeasures.data.tests.utils import work_on_rq`
	`9`	`+from flexmeasures.utils.job_utils import work_on_rq`
`10`	`10`	`from flexmeasures.api.tests.utils import get_auth_token`
`11`	`11`	`from flexmeasures.data.services.forecasting import handle_forecasting_exception`
`12`	`12`	`from flexmeasures.data.models.forecasting.pipelines import TrainPredictPipeline`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`check_failures,`
`15`	`15`	`get_data_source,`
`16`	`16`	`)`
`17`		`-from flexmeasures.data.tests.utils import work_on_rq`
	`17`	`+from flexmeasures.utils.job_utils import work_on_rq`
`18`	`18`	`from flexmeasures.utils.time_utils import as_server_time`
`19`	`19`
`20`	`20`