10888083970

Committed 16 Sep 2024 04:31PM UTC coverage: 67.273% (-0.008%) from 67.281%

Build # 10888083970

Build Type

Pull #1113

github

Committed by

Ahmad-Wahid

Commit Message

fix: search asset annotations

Signed-off-by: Ahmad Wahid <ahmedwahid16101@gmail.com>

Pull Request Pull Request #1113: Add endpoint for getting asset annotations

Run Details

6239 of 10108 branches covered (61.72%)

Branch coverage included in aggregate %.

13 of 27 new or added lines in 3 files covered. (48.15%)

1 existing line in 1 file now uncovered.

7881 of 10881 relevant lines covered (72.43%)

5.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

73.68

/flexmeasures/api/dev/sensors.py

from __future__ import annotations

import json
import warnings
from typing import Any

from flask_classful import FlaskView, route
from flask_security import current_user
from marshmallow import fields
from webargs.flaskparser import use_kwargs
from werkzeug.exceptions import abort

from flexmeasures.data import db
from flexmeasures.auth.policy import ADMIN_ROLE, ADMIN_READER_ROLE
from flexmeasures.auth.decorators import permission_required_for_context
from flexmeasures.data.schemas import (
    AssetIdField,
    AwareDateTimeField,
    DurationField,
    SensorIdField,
)
from flexmeasures.data.models.generic_assets import GenericAsset
from flexmeasures.data.models.time_series import Sensor
from flexmeasures.data.services.annotations import prepare_annotations_for_chart
from flexmeasures.ui.utils.view_utils import set_session_variables
from flexmeasures.data.models.annotations import (
    SensorAnnotationRelationship,
    GenericAssetAnnotationRelationship,
)


class SensorAPI(FlaskView):
    """
    This view exposes sensor attributes through API endpoints under development.
    These endpoints are not yet part of our official API, but support the FlexMeasures UI.
    """

    route_base = "/sensor"
    trailing_slash = False
    # Note: when promoting these endpoints to the main API, we aim to be strict with trailing slashes, see #1014

    @route("/<id>/chart", strict_slashes=False)
    @use_kwargs(
        {"sensor": SensorIdField(data_key="id")},
        location="path",
    )
    @use_kwargs(
        {
            "event_starts_after": AwareDateTimeField(format="iso", required=False),
            "event_ends_before": AwareDateTimeField(format="iso", required=False),
            "beliefs_after": AwareDateTimeField(format="iso", required=False),
            "beliefs_before": AwareDateTimeField(format="iso", required=False),
            "include_data": fields.Boolean(required=False),
            "include_sensor_annotations": fields.Boolean(required=False),
            "include_asset_annotations": fields.Boolean(required=False),
            "include_account_annotations": fields.Boolean(required=False),
            "dataset_name": fields.Str(required=False),
            "chart_type": fields.Str(required=False),
            "height": fields.Str(required=False),
            "width": fields.Str(required=False),
        },
        location="query",
    )
    @permission_required_for_context("read", ctx_arg_name="sensor")
    def get_chart(self, id: int, sensor: Sensor, **kwargs):
        """GET from /sensor/<id>/chart

        .. :quickref: Chart; Download a chart with time series

        **Optional fields**

        - "event_starts_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "event_ends_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "beliefs_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "beliefs_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "include_data" (if true, chart specs include the data; if false, use the `GET /api/dev/sensor/(id)/chart_data <../api/dev.html#get--api-dev-sensor-(id)-chart_data->`_ endpoint to fetch data)
        - "chart_type" (currently 'bar_chart' and 'daily_heatmap' are supported types)
        - "width" (an integer number of pixels; without it, the chart will be scaled to the full width of the container (hint: use ``<div style="width: 100%;">`` to set a div width to 100%)
        - "height" (an integer number of pixels; without it, FlexMeasures sets a default, currently 300)
        """
        # Store selected time range and chart type as session variables, for a consistent UX across UI page loads
        set_session_variables("event_starts_after", "event_ends_before", "chart_type")
        return json.dumps(sensor.chart(**kwargs))

    @route("/<id>/chart_data", strict_slashes=False)
    @use_kwargs(
        {"sensor": SensorIdField(data_key="id")},
        location="path",
    )
    @use_kwargs(
        {
            "event_starts_after": AwareDateTimeField(format="iso", required=False),
            "event_ends_before": AwareDateTimeField(format="iso", required=False),
            "beliefs_after": AwareDateTimeField(format="iso", required=False),
            "beliefs_before": AwareDateTimeField(format="iso", required=False),
            "resolution": DurationField(required=False),
            "most_recent_beliefs_only": fields.Boolean(required=False, default=True),
        },
        location="query",
    )
    @permission_required_for_context("read", ctx_arg_name="sensor")
    def get_chart_data(self, id: int, sensor: Sensor, **kwargs):
        """GET from /sensor/<id>/chart_data

        .. :quickref: Chart; Download time series for use in charts

        Data for use in charts (in case you have the chart specs already).

        **Optional fields**

        - "event_starts_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "event_ends_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "beliefs_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "beliefs_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
        - "resolution" (see :ref:`resolutions`)
        - "most_recent_beliefs_only" (if true, returns the most recent belief for each event; if false, returns each belief for each event; defaults to true)
        """
        return sensor.search_beliefs(as_json=True, **kwargs)

    @route("/<id>/chart_annotations", strict_slashes=False)
    @use_kwargs(
        {"sensor": SensorIdField(data_key="id")},
        location="path",
    )
    @use_kwargs(
        {
            "event_starts_after": AwareDateTimeField(format="iso", required=False),
            "event_ends_before": AwareDateTimeField(format="iso", required=False),
            "beliefs_after": AwareDateTimeField(format="iso", required=False),
            "beliefs_before": AwareDateTimeField(format="iso", required=False),
        },
        location="query",
    )
    @permission_required_for_context("read", ctx_arg_name="sensor")
    def get_chart_annotations(self, id: int, sensor: Sensor, **kwargs):
        """GET from /sensor/<id>/chart_annotations

        .. :quickref: Chart; Download annotations for use in charts

        Annotations for use in charts (in case you have the chart specs already).
        """
        df = get_annotations_data(
            sensor_id=id,
            asset_or_sensor=sensor,
            relationship_module=SensorAnnotationRelationship,
            kwargs=kwargs,
        )

        return df.to_json(orient="records")

    @route("/<id>", strict_slashes=False)
    @use_kwargs(
        {"sensor": SensorIdField(data_key="id")},
        location="path",
    )
    @permission_required_for_context("read", ctx_arg_name="sensor")
    def get(self, id: int, sensor: Sensor):
        """GET from /sensor/<id>

        .. :quickref: Chart; Download sensor attributes for use in charts
        """
        attributes = ["name", "timezone", "timerange"]
        return {attr: getattr(sensor, attr) for attr in attributes}


class AssetAPI(FlaskView):
    """
    This view exposes asset attributes through API endpoints under development.
    These endpoints are not yet part of our official API, but support the FlexMeasures UI.
    """

    route_base = "/asset"
    trailing_slash = False

    @route("/<id>", strict_slashes=False)
    @use_kwargs(
        {"asset": AssetIdField(data_key="id")},
        location="path",
    )
    @permission_required_for_context("read", ctx_arg_name="asset")
    def get(self, id: int, asset: GenericAsset):
        """GET from /asset/<id>

        .. :quickref: Chart; Download asset attributes for use in charts
        """
        attributes = ["name", "timezone", "timerange_of_sensors_to_show"]
        return {attr: getattr(asset, attr) for attr in attributes}

    @route("/<id>/chart_annotations", strict_slashes=False)
    @use_kwargs(
        {"asset": AssetIdField(data_key="id")},
        location="path",
    )
    @use_kwargs(
        {
            "event_starts_after": AwareDateTimeField(format="iso", required=False),
            "event_ends_before": AwareDateTimeField(format="iso", required=False),
            "beliefs_after": AwareDateTimeField(format="iso", required=False),
            "beliefs_before": AwareDateTimeField(format="iso", required=False),
        },
        location="query",
    )
    @permission_required_for_context("read", ctx_arg_name="asset")
    def get_chart_annotations(self, id: int, asset: GenericAsset, **kwargs):
        """GET from /asset/<id>/chart_annotations

        .. :quickref: Chart; Download annotations for use in charts

        Annotations for use in charts (in case you have the chart specs already).
        """
        df = get_annotations_data(
            sensor_id=None,
            asset_or_sensor=asset,
            relationship_module=GenericAssetAnnotationRelationship,
            kwargs=kwargs,
        )

        return df.to_json(orient="records")


def get_annotations_data(
    sensor_id: int | None,
    asset_or_sensor: GenericAsset | Sensor,
    relationship_module: Any,
    kwargs,
):
    """
    This function fetches a sensor or an asset annotations data
    """
    event_starts_after = kwargs.get("event_starts_after", None)
    event_ends_before = kwargs.get("event_ends_before", None)
    if asset_or_sensor is GenericAsset:
        asset_or_sensor_class = asset_or_sensor.generic_asset
    else:
        asset_or_sensor_class = asset_or_sensor

    df = asset_or_sensor_class.search_annotations(
        annotations_after=event_starts_after,
        annotations_before=event_ends_before,
        as_frame=True,
        sensor_id=sensor_id,
        relationship_module=relationship_module,
    )

    # Wrap and stack annotations
    df = prepare_annotations_for_chart(df)

    # Return JSON records
    df = df.reset_index()
    df["source"] = df["source"].astype(str)
    return df


def get_sensor_or_abort(id: int) -> Sensor:
    """
    Util function to help the GET requests. Will be obsolete..
    """
    warnings.warn(
        "Util function will be deprecated. Switch to using SensorIdField to suppress this warning.",
        FutureWarning,
    )
    sensor = db.session.get(Sensor, id)
    if sensor is None:
        raise abort(404, f"Sensor {id} not found")
    if not (
        current_user.has_role(ADMIN_ROLE)
        or current_user.has_role(ADMIN_READER_ROLE)
        or sensor.generic_asset.owner is None  # public
        or sensor.generic_asset.owner == current_user.account  # private but authorized
    ):
        raise abort(403)
    return sensor

1	from __future__ import annotations	8✔
2
3	import json	8✔
4	import warnings	8✔
5	from typing import Any	8✔
6
7	from flask_classful import FlaskView, route	8✔
8	from flask_security import current_user	8✔
9	from marshmallow import fields	8✔
10	from webargs.flaskparser import use_kwargs	8✔
11	from werkzeug.exceptions import abort	8✔
12
13	from flexmeasures.data import db	8✔
14	from flexmeasures.auth.policy import ADMIN_ROLE, ADMIN_READER_ROLE	8✔
15	from flexmeasures.auth.decorators import permission_required_for_context	8✔
16	from flexmeasures.data.schemas import (	8✔
17	AssetIdField,
18	AwareDateTimeField,
19	DurationField,
20	SensorIdField,
21	)
22	from flexmeasures.data.models.generic_assets import GenericAsset	8✔
23	from flexmeasures.data.models.time_series import Sensor	8✔
24	from flexmeasures.data.services.annotations import prepare_annotations_for_chart	8✔
25	from flexmeasures.ui.utils.view_utils import set_session_variables	8✔
26	from flexmeasures.data.models.annotations import (	8✔
27	SensorAnnotationRelationship,
28	GenericAssetAnnotationRelationship,
29	)
30
31
32	class SensorAPI(FlaskView):	8✔
33	"""	4✔
34	This view exposes sensor attributes through API endpoints under development.
35	These endpoints are not yet part of our official API, but support the FlexMeasures UI.
36	"""
37
38	route_base = "/sensor"	8✔
39	trailing_slash = False	8✔
40	# Note: when promoting these endpoints to the main API, we aim to be strict with trailing slashes, see #1014
41
42	@route("/<id>/chart", strict_slashes=False)	8✔
43	@use_kwargs(	8✔
44	{"sensor": SensorIdField(data_key="id")},
45	location="path",
46	)
47	@use_kwargs(	8✔
48	{
49	"event_starts_after": AwareDateTimeField(format="iso", required=False),
50	"event_ends_before": AwareDateTimeField(format="iso", required=False),
51	"beliefs_after": AwareDateTimeField(format="iso", required=False),
52	"beliefs_before": AwareDateTimeField(format="iso", required=False),
53	"include_data": fields.Boolean(required=False),
54	"include_sensor_annotations": fields.Boolean(required=False),
55	"include_asset_annotations": fields.Boolean(required=False),
56	"include_account_annotations": fields.Boolean(required=False),
57	"dataset_name": fields.Str(required=False),
58	"chart_type": fields.Str(required=False),
59	"height": fields.Str(required=False),
60	"width": fields.Str(required=False),
61	},
62	location="query",
63	)
64	@permission_required_for_context("read", ctx_arg_name="sensor")	8✔
65	def get_chart(self, id: int, sensor: Sensor, **kwargs):	8✔
66	"""GET from /sensor/<id>/chart
67
68	.. :quickref: Chart; Download a chart with time series
69
70	Optional fields
71
72	- "event_starts_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
73	- "event_ends_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
74	- "beliefs_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
75	- "beliefs_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
76	- "include_data" (if true, chart specs include the data; if false, use the `GET /api/dev/sensor/(id)/chart_data <../api/dev.html#get--api-dev-sensor-(id)-chart_data->`_ endpoint to fetch data)
77	- "chart_type" (currently 'bar_chart' and 'daily_heatmap' are supported types)
78	- "width" (an integer number of pixels; without it, the chart will be scaled to the full width of the container (hint: use ``<div style="width: 100%;">`` to set a div width to 100%)
79	- "height" (an integer number of pixels; without it, FlexMeasures sets a default, currently 300)
80	"""
81	# Store selected time range and chart type as session variables, for a consistent UX across UI page loads
82	set_session_variables("event_starts_after", "event_ends_before", "chart_type")	×
83	return json.dumps(sensor.chart(**kwargs))	×
84
85	@route("/<id>/chart_data", strict_slashes=False)	8✔
86	@use_kwargs(	8✔
87	{"sensor": SensorIdField(data_key="id")},
88	location="path",
89	)
90	@use_kwargs(	8✔
91	{
92	"event_starts_after": AwareDateTimeField(format="iso", required=False),
93	"event_ends_before": AwareDateTimeField(format="iso", required=False),
94	"beliefs_after": AwareDateTimeField(format="iso", required=False),
95	"beliefs_before": AwareDateTimeField(format="iso", required=False),
96	"resolution": DurationField(required=False),
97	"most_recent_beliefs_only": fields.Boolean(required=False, default=True),
98	},
99	location="query",
100	)
101	@permission_required_for_context("read", ctx_arg_name="sensor")	8✔
102	def get_chart_data(self, id: int, sensor: Sensor, **kwargs):	8✔
103	"""GET from /sensor/<id>/chart_data
104
105	.. :quickref: Chart; Download time series for use in charts
106
107	Data for use in charts (in case you have the chart specs already).
108
109	Optional fields
110
111	- "event_starts_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
112	- "event_ends_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
113	- "beliefs_after" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
114	- "beliefs_before" (see the `timely-beliefs documentation <https://github.com/SeitaBV/timely-beliefs/blob/main/timely_beliefs/docs/timing.md/#events-and-sensors>`_)
115	- "resolution" (see :ref:`resolutions`)
116	- "most_recent_beliefs_only" (if true, returns the most recent belief for each event; if false, returns each belief for each event; defaults to true)
117	"""
118	return sensor.search_beliefs(as_json=True, **kwargs)	×
119
120	@route("/<id>/chart_annotations", strict_slashes=False)	8✔
121	@use_kwargs(	8✔
122	{"sensor": SensorIdField(data_key="id")},
123	location="path",
124	)
125	@use_kwargs(	8✔
126	{
127	"event_starts_after": AwareDateTimeField(format="iso", required=False),
128	"event_ends_before": AwareDateTimeField(format="iso", required=False),
129	"beliefs_after": AwareDateTimeField(format="iso", required=False),
130	"beliefs_before": AwareDateTimeField(format="iso", required=False),
131	},
132	location="query",
133	)
134	@permission_required_for_context("read", ctx_arg_name="sensor")	8✔
135	def get_chart_annotations(self, id: int, sensor: Sensor, **kwargs):	8✔
136	"""GET from /sensor/<id>/chart_annotations
137
138	.. :quickref: Chart; Download annotations for use in charts
139
140	Annotations for use in charts (in case you have the chart specs already).
141	"""
NEW 142	df = get_annotations_data(	×
143	sensor_id=id,
144	asset_or_sensor=sensor,
145	relationship_module=SensorAnnotationRelationship,
146	kwargs=kwargs,
147	)
148
UNCOV 149	return df.to_json(orient="records")	×
150
151	@route("/<id>", strict_slashes=False)	8✔
152	@use_kwargs(	8✔
153	{"sensor": SensorIdField(data_key="id")},
154	location="path",
155	)
156	@permission_required_for_context("read", ctx_arg_name="sensor")	8✔
157	def get(self, id: int, sensor: Sensor):	8✔
158	"""GET from /sensor/<id>
159
160	.. :quickref: Chart; Download sensor attributes for use in charts
161	"""
162	attributes = ["name", "timezone", "timerange"]	×
163	return {attr: getattr(sensor, attr) for attr in attributes}	×
164
165
166	class AssetAPI(FlaskView):	8✔
167	"""	4✔
168	This view exposes asset attributes through API endpoints under development.
169	These endpoints are not yet part of our official API, but support the FlexMeasures UI.
170	"""
171
172	route_base = "/asset"	8✔
173	trailing_slash = False	8✔
174
175	@route("/<id>", strict_slashes=False)	8✔
176	@use_kwargs(	8✔
177	{"asset": AssetIdField(data_key="id")},
178	location="path",
179	)
180	@permission_required_for_context("read", ctx_arg_name="asset")	8✔
181	def get(self, id: int, asset: GenericAsset):	8✔
182	"""GET from /asset/<id>
183
184	.. :quickref: Chart; Download asset attributes for use in charts
185	"""
186	attributes = ["name", "timezone", "timerange_of_sensors_to_show"]	8✔
187	return {attr: getattr(asset, attr) for attr in attributes}	8✔
188
189	@route("/<id>/chart_annotations", strict_slashes=False)	8✔
190	@use_kwargs(	8✔
191	{"asset": AssetIdField(data_key="id")},
192	location="path",
193	)
194	@use_kwargs(	8✔
195	{
196	"event_starts_after": AwareDateTimeField(format="iso", required=False),
197	"event_ends_before": AwareDateTimeField(format="iso", required=False),
198	"beliefs_after": AwareDateTimeField(format="iso", required=False),
199	"beliefs_before": AwareDateTimeField(format="iso", required=False),
200	},
201	location="query",
202	)
203	@permission_required_for_context("read", ctx_arg_name="asset")	8✔
204	def get_chart_annotations(self, id: int, asset: GenericAsset, **kwargs):	8✔
205	"""GET from /asset/<id>/chart_annotations
206
207	.. :quickref: Chart; Download annotations for use in charts
208
209	Annotations for use in charts (in case you have the chart specs already).
210	"""
NEW 211	df = get_annotations_data(	×
212	sensor_id=None,
213	asset_or_sensor=asset,
214	relationship_module=GenericAssetAnnotationRelationship,
215	kwargs=kwargs,
216	)
217
NEW 218	return df.to_json(orient="records")	×
219
220
221	def get_annotations_data(	8✔
222	sensor_id: int \| None,
223	asset_or_sensor: GenericAsset \| Sensor,
224	relationship_module: Any,
225	kwargs,
226	):
227	"""
228	This function fetches a sensor or an asset annotations data
229	"""
NEW 230	event_starts_after = kwargs.get("event_starts_after", None)	×
NEW 231	event_ends_before = kwargs.get("event_ends_before", None)	×
NEW 232	if asset_or_sensor is GenericAsset:	×
NEW 233	asset_or_sensor_class = asset_or_sensor.generic_asset	×
234	else:
NEW 235	asset_or_sensor_class = asset_or_sensor	×
236
NEW 237	df = asset_or_sensor_class.search_annotations(	×
238	annotations_after=event_starts_after,
239	annotations_before=event_ends_before,
240	as_frame=True,
241	sensor_id=sensor_id,
242	relationship_module=relationship_module,
243	)
244
245	# Wrap and stack annotations
NEW 246	df = prepare_annotations_for_chart(df)	×
247
248	# Return JSON records
NEW 249	df = df.reset_index()	×
NEW 250	df["source"] = df["source"].astype(str)	×
NEW 251	return df	×
252
253
254	def get_sensor_or_abort(id: int) -> Sensor:	8✔
255	"""
256	Util function to help the GET requests. Will be obsolete..
257	"""
258	warnings.warn(	×
259	"Util function will be deprecated. Switch to using SensorIdField to suppress this warning.",
260	FutureWarning,
261	)
262	sensor = db.session.get(Sensor, id)	×
263	if sensor is None:	×
264	raise abort(404, f"Sensor {id} not found")	×
265	if not (	×
266	current_user.has_role(ADMIN_ROLE)
267	or current_user.has_role(ADMIN_READER_ROLE)
268	or sensor.generic_asset.owner is None # public
269	or sensor.generic_asset.owner == current_user.account # private but authorized
270	):
271	raise abort(403)	×
272	return sensor	×

FlexMeasures / flexmeasures / 10888083970

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous