11374383990

Committed 16 Oct 2024 09:47PM UTC coverage: 67.274% (-0.2%) from 67.453%

Build # 11374383990

Build Type

Pull #1213

github

Committed by

Flix6x

Commit Message

style: black

Signed-off-by: F.N. Claessen <felix@seita.nl>

Pull Request Pull Request #1213: Fix/sensor stats timezone

Run Details

6270 of 10163 branches covered (61.69%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 1 file covered. (100.0%)

215 existing lines in 13 files now uncovered.

7906 of 10909 relevant lines covered (72.47%)

5.74 hits per line

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

80.39

/flexmeasures/api/common/schemas/sensors.py

from flask import abort
from marshmallow import fields
from sqlalchemy import select

from flexmeasures.data import db
from flexmeasures.api import FMValidationError
from flexmeasures.utils.entity_address_utils import (
    parse_entity_address,
    EntityAddressException,
)
from flexmeasures.data.models.time_series import Sensor


class EntityAddressValidationError(FMValidationError):
    status = "INVALID_DOMAIN"  # USEF error status


class SensorIdField(fields.Integer):
    """
    Field that represents a sensor ID. It de-serializes from the sensor id to a sensor instance.
    """

    def _deserialize(self, sensor_id: int, attr, obj, **kwargs) -> Sensor:
        sensor: Sensor = db.session.execute(
            select(Sensor).filter_by(id=int(sensor_id))
        ).scalar_one_or_none()
        if sensor is None:
            raise abort(404, f"Sensor {sensor_id} not found")
        return sensor

    def _serialize(self, sensor: Sensor, attr, data, **kwargs) -> int:
        return sensor.id


class SensorField(fields.Str):
    """Field that de-serializes to a Sensor,
    and serializes a Sensor into an entity address (string).
    """

    # todo: when Actuators also get an entity address, refactor this class to EntityField,
    #       where an Entity represents anything with an entity address: we currently foresee Sensors and Actuators

    def __init__(
        self,
        entity_type: str = "sensor",
        fm_scheme: str = "fm1",
        *args,
        **kwargs,
    ):
        """
        :param entity_type: "sensor" (in the future, possibly also another type of resource that is assigned an entity address)
        :param fm_scheme:   "fm0" or "fm1"
        """
        self.entity_type = entity_type
        self.fm_scheme = fm_scheme
        super().__init__(*args, **kwargs)

    def _deserialize(self, value, attr, obj, **kwargs) -> Sensor:
        """De-serialize to a Sensor."""
        try:
            ea = parse_entity_address(value, self.entity_type, self.fm_scheme)
            if self.fm_scheme == "fm0":
                raise EntityAddressException("The fm0 scheme is no longer supported.")
            else:
                sensor = db.session.execute(
                    select(Sensor).filter_by(id=ea["sensor_id"])
                ).scalar_one_or_none()
            if sensor is not None:
                return sensor
            else:
                raise EntityAddressValidationError(
                    f"{self.entity_type} with entity address {value} doesn't exist."
                )
        except EntityAddressException as eae:
            raise EntityAddressValidationError(str(eae))

    def _serialize(self, value: Sensor, attr, data, **kwargs):
        """Serialize to an entity address."""
        if self.fm_scheme == "fm0":
            return value.entity_address_fm0
        else:
            return value.entity_address

1	from flask import abort	8✔
2	from marshmallow import fields	8✔
3	from sqlalchemy import select	8✔
4
5	from flexmeasures.data import db	8✔
6	from flexmeasures.api import FMValidationError	8✔
7	from flexmeasures.utils.entity_address_utils import (	8✔
8	parse_entity_address,
9	EntityAddressException,
10	)
11	from flexmeasures.data.models.time_series import Sensor	8✔
12
13
14	class EntityAddressValidationError(FMValidationError):	8✔
15	status = "INVALID_DOMAIN" # USEF error status	8✔
16
17
18	class SensorIdField(fields.Integer):	8✔
19	"""	4✔
20	Field that represents a sensor ID. It de-serializes from the sensor id to a sensor instance.
21	"""
22
23	def _deserialize(self, sensor_id: int, attr, obj, **kwargs) -> Sensor:	8✔
UNCOV 24	sensor: Sensor = db.session.execute(	×
25	select(Sensor).filter_by(id=int(sensor_id))
26	).scalar_one_or_none()
UNCOV 27	if sensor is None:	×
28	raise abort(404, f"Sensor {sensor_id} not found")	×
29	return sensor	×
30
31	def _serialize(self, sensor: Sensor, attr, data, **kwargs) -> int:	8✔
UNCOV 32	return sensor.id	×
33
34
35	class SensorField(fields.Str):	8✔
36	"""Field that de-serializes to a Sensor,	4✔
37	and serializes a Sensor into an entity address (string).
38	"""
39
40	# todo: when Actuators also get an entity address, refactor this class to EntityField,
41	# where an Entity represents anything with an entity address: we currently foresee Sensors and Actuators
42
43	def __init__(	8✔
44	self,
45	entity_type: str = "sensor",
46	fm_scheme: str = "fm1",
47	*args,
48	**kwargs,
49	):
50	"""
51	:param entity_type: "sensor" (in the future, possibly also another type of resource that is assigned an entity address)
52	:param fm_scheme: "fm0" or "fm1"
53	"""
54	self.entity_type = entity_type	8✔
55	self.fm_scheme = fm_scheme	8✔
56	super().__init__(args, *kwargs)	8✔
57
58	def _deserialize(self, value, attr, obj, **kwargs) -> Sensor:	8✔
59	"""De-serialize to a Sensor."""
60	try:	8✔
61	ea = parse_entity_address(value, self.entity_type, self.fm_scheme)	8✔
62	if self.fm_scheme == "fm0":	8✔
63	raise EntityAddressException("The fm0 scheme is no longer supported.")	8✔
64	else:
65	sensor = db.session.execute(	8✔
66	select(Sensor).filter_by(id=ea["sensor_id"])
67	).scalar_one_or_none()
68	if sensor is not None:	8✔
69	return sensor	8✔
70	else:
71	raise EntityAddressValidationError(	8✔
72	f"{self.entity_type} with entity address {value} doesn't exist."
73	)
74	except EntityAddressException as eae:	8✔
75	raise EntityAddressValidationError(str(eae))	8✔
76
77	def _serialize(self, value: Sensor, attr, data, **kwargs):	8✔
78	"""Serialize to an entity address."""
79	if self.fm_scheme == "fm0":	8✔
UNCOV 80	return value.entity_address_fm0	×
81	else:
82	return value.entity_address	8✔

FlexMeasures / flexmeasures / 11374383990

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