Add endpoint for getting asset annotations #1113
Conversation
|
Also, please check GH Actions, which is reporting a mypy issue on this PR. |
…for-getting-asset-annotations
Signed-off-by: Ahmad Wahid <[email protected]>
…ations Signed-off-by: Felix Claessen <[email protected]>
| @@ -355,6 +359,8 @@ def search_annotations( | |||
| annotation_type: str = None, | |||
| include_account_annotations: bool = False, | |||
| as_frame: bool = False, | |||
| sensor_id: int = None, | |||
There was a problem hiding this comment.
Shouldn't this be named asset_id (or asset_or_sensor_id)?
There was a problem hiding this comment.
Actually, I don't think we need it. See my comment about using calling this method on the instance rather than the class.
| """ | ||
| event_starts_after = kwargs.get("event_starts_after", None) | ||
| event_ends_before = kwargs.get("event_ends_before", None) | ||
| if asset_or_sensor is GenericAsset: |
There was a problem hiding this comment.
This is always False, because this compares an Asset or Sensor instance (in asset_or_sensor) to an Asset class.
|
|
||
|
|
||
| def get_annotations_data( | ||
| sensor_id: int | None, |
There was a problem hiding this comment.
This parameter seems redundant, since we are already passing the sensor or asset instance itself.
| if asset_or_sensor is GenericAsset: | ||
| asset_or_sensor_class = asset_or_sensor.generic_asset | ||
| else: | ||
| asset_or_sensor_class = asset_or_sensor |
There was a problem hiding this comment.
| if asset_or_sensor is GenericAsset: | |
| asset_or_sensor_class = asset_or_sensor.generic_asset | |
| else: | |
| asset_or_sensor_class = asset_or_sensor | |
| asset_or_sensor_class = asset_or_sensor.__class__ |
| else: | ||
| asset_or_sensor_class = asset_or_sensor | ||
|
|
||
| df = asset_or_sensor_class.search_annotations( |
There was a problem hiding this comment.
Why do we need the class, actually? Isn't search_annotations a method we can call on the instance rather than the class? Its function signature does suggest so, because its first parameter is self rather than cls.
| df = asset_or_sensor_class.search_annotations( | |
| df = asset_or_sensor.search_annotations( |
| ) | ||
| from flexmeasures.data.models.data_sources import DataSource | ||
|
|
||
|
|
||
| def query_asset_annotations( | ||
| asset_id: int, | ||
| asset_or_sensor_id: int, | ||
| relationship_module, |
There was a problem hiding this comment.
Missing type annotation, possibly an Enum with the 3 relationship choices we currently have (with Accounts, GenericAssets and Sensors).
In this PR, I have add an
AssetAPIendpoint in thedevmodule to fetch annotations data. Also I have refactored annotations query to be to get data for both asset and sensor annotations.