feat: CLI can delete multiple sensors at once (#734)

This PR let's you delete multiple sensors with a single call to flexmeasures delete sensor by passing the --id option multiple times. I also tried to streamline the help messages a bit for CLI usages of the SensorIDField. * feat: Support deleting multiple sensors with one call to the CLI. Signed-off-by: F.N. Claessen <felix@seita.nl> * docs: CLI changelog entry Signed-off-by: F.N. Claessen <felix@seita.nl> * bug:) trailing space Signed-off-by: F.N. Claessen <felix@seita.nl> * docs: changelog entry Signed-off-by: F.N. Claessen <felix@seita.nl> --------- Signed-off-by: F.N. Claessen <felix@seita.nl>
FlexMeasures · Jun 20, 2023 · 99cf03a · 99cf03a
1 parent 3a54f3a
commit 99cf03a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 9 deletions.
diff --git a/documentation/changelog.rst b/documentation/changelog.rst
@@ -9,6 +9,8 @@ v0.15.0 | July XX, 2023
 New features
 -------------
 
+* Allow deleting multiple sensors with a single call to ``flexmeasures delete sensor`` by passing the ``--id`` option multiple times [see `PR #734 <https://www.github.com/FlexMeasures/flexmeasures/pull/734>`_]
+
 Bugfixes
 -----------
 

diff --git a/documentation/cli/change_log.rst b/documentation/cli/change_log.rst
@@ -4,6 +4,11 @@
 FlexMeasures CLI Changelog
 **********************
 
+since v0.15.0 | July XX, 2023
+=================================
+
+* Allow deleting multiple sensors with a single call to ``flexmeasures delete sensor`` by passing the ``--id`` option multiple times.
+
 since v0.14.0 | June 15, 2023
 =================================
 

diff --git a/flexmeasures/cli/data_add.py b/flexmeasures/cli/data_add.py
@@ -374,7 +374,7 @@ def add_source(name: str, model: str, version: str, source_type: str):
     "sensor",
     required=True,
     type=SensorIdField(),
-    help="Sensor to which the beliefs pertain.",
+    help="Record the beliefs under this sensor. Follow up with the sensor's ID. ",
 )
 @click.option(
     "--source",
@@ -1165,7 +1165,7 @@ def add_schedule_for_storage(
     "sensor",
     type=SensorIdField(),
     required=True,
-    help="ID of the sensor used to save the report."
+    help="Sensor used to save the report. Follow up with the sensor's ID. "
     " If needed, use `flexmeasures add sensor` to create a new sensor first.",
 )
 @click.option(

diff --git a/flexmeasures/cli/data_delete.py b/flexmeasures/cli/data_delete.py
@@ -307,18 +307,26 @@ def delete_nan_beliefs(sensor_id: int | None = None):
 @with_appcontext
 @click.option(
     "--id",
-    "sensor",
+    "sensors",
     type=SensorIdField(),
     required=True,
-    help="Delete a single sensor and its (time series) data. Follow up with the sensor's ID.",
+    multiple=True,
+    help="Delete a sensor and its (time series) data. Follow up with the sensor's ID. "
+    "This argument can be given multiple times",
 )
 def delete_sensor(
-    sensor: Sensor,
+    sensors: list[Sensor],
 ):
-    """Delete a sensor and all beliefs about it."""
-    n = TimedBelief.query.filter(TimedBelief.sensor_id == sensor.id).delete()
-    db.session.delete(sensor)
-    click.confirm(f"Delete {sensor.__repr__()}, along with {n} beliefs?", abort=True)
+    """Delete sensors and their (time series) data."""
+    n = TimedBelief.query.filter(
+        TimedBelief.sensor_id.in_(sensor.id for sensor in sensors)
+    ).delete()
+    for sensor in sensors:
+        db.session.delete(sensor)
+    click.confirm(
+        f"Delete {', '.join(sensor.__repr__() for sensor in sensors)}, along with {n} beliefs?",
+        abort=True,
+    )
     db.session.commit()