|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from collections.abc import Sequence |
| 4 | +from typing import TYPE_CHECKING, Any, NoReturn, overload |
| 5 | + |
| 6 | +from cognite.client._api_client import APIClient |
| 7 | +from cognite.client._constants import DEFAULT_LIMIT_READ |
| 8 | +from cognite.client.data_classes.data_modeling.cdm.v1 import CogniteTimeSeries |
| 9 | +from cognite.client.data_classes.data_modeling.ids import NodeId, ViewId |
| 10 | +from cognite.client.data_classes.data_modeling.instances import InstanceSort, Node, NodeList |
| 11 | +from cognite.client.data_classes.data_modeling.views import View |
| 12 | +from cognite.client.data_classes.filters import Filter |
| 13 | +from cognite.client.utils._data_modeling import resolve_source, strip_canonical_source |
| 14 | +from cognite.client.utils.useful_types import SequenceNotStr |
| 15 | + |
| 16 | +if TYPE_CHECKING: |
| 17 | + from cognite.client import AsyncCogniteClient |
| 18 | + from cognite.client._api.data_modeling.instances import InstancesAPI |
| 19 | + from cognite.client.config import ClientConfig |
| 20 | + |
| 21 | +COGNITE_TIME_SERIES_VIEW_ID = CogniteTimeSeries.get_source() |
| 22 | + |
| 23 | + |
| 24 | +class DataModelingTimeSeriesAPI(APIClient): |
| 25 | + def __init__(self, config: ClientConfig, api_version: str | None, cognite_client: AsyncCogniteClient) -> None: |
| 26 | + # TODO: Add DataModelingDatapointsAPI |
| 27 | + super().__init__(config, api_version, cognite_client) |
| 28 | + |
| 29 | + @property |
| 30 | + def _instances_api(self) -> InstancesAPI: |
| 31 | + return self._cognite_client.data_modeling.instances |
| 32 | + |
| 33 | + async def __call__(self) -> NoReturn: |
| 34 | + raise NotImplementedError("This method is not implemented yet!") |
| 35 | + |
| 36 | + @overload |
| 37 | + async def retrieve( |
| 38 | + self, |
| 39 | + node_ids: NodeId | tuple[str, str], |
| 40 | + *, |
| 41 | + source: View | ViewId | tuple[str, str, str] = COGNITE_TIME_SERIES_VIEW_ID, |
| 42 | + ) -> Node | None: ... |
| 43 | + |
| 44 | + @overload |
| 45 | + async def retrieve( |
| 46 | + self, |
| 47 | + node_ids: Sequence[NodeId] | Sequence[tuple[str, str]], |
| 48 | + *, |
| 49 | + source: View | ViewId | tuple[str, str, str] = COGNITE_TIME_SERIES_VIEW_ID, |
| 50 | + ) -> NodeList[Node]: ... |
| 51 | + |
| 52 | + async def retrieve( |
| 53 | + self, |
| 54 | + node_ids: NodeId | tuple[str, str] | Sequence[NodeId] | Sequence[tuple[str, str]], |
| 55 | + *, |
| 56 | + source: View | ViewId | tuple[str, str, str] = COGNITE_TIME_SERIES_VIEW_ID, |
| 57 | + ) -> Node | NodeList[Node] | None: |
| 58 | + """`Retrieve one or more time series by instance ID <https://api-docs.cognite.com/20230101/tag/Instances/operation/byExternalIdsInstances>`_. |
| 59 | +
|
| 60 | + Only nodes that are time series (i.e. have data in the CogniteTimeSeries view) will be returned. |
| 61 | + If a single instance ID is requested and it is not found, ``None`` is returned. |
| 62 | +
|
| 63 | + Args: |
| 64 | + node_ids (NodeId | tuple[str, str] | Sequence[NodeId] | Sequence[tuple[str, str]]): Single instance ID or a list of instance IDs. |
| 65 | + source (View | ViewId | tuple[str, str, str]): The view to fetch properties from. Defaults to CogniteTimeSeries. |
| 66 | +
|
| 67 | + Returns: |
| 68 | + Node | NodeList[Node] | None: A single ``Node`` (or ``None`` if not found) when given a single identifier, or a ``NodeList`` when given a sequence. |
| 69 | +
|
| 70 | + Examples: |
| 71 | +
|
| 72 | + Retrieve a single time series by instance ID: |
| 73 | +
|
| 74 | + >>> from cognite.client import CogniteClient |
| 75 | + >>> from cognite.client.data_classes.data_modeling import NodeId |
| 76 | + >>> client = CogniteClient() |
| 77 | + >>> res = client.data_modeling.time_series.retrieve(NodeId("my-space", "my-ts")) |
| 78 | +
|
| 79 | + Using a tuple shorthand: |
| 80 | +
|
| 81 | + >>> res = client.data_modeling.time_series.retrieve(("my-space", "my-ts")) |
| 82 | +
|
| 83 | + Retrieve multiple time series nodes: |
| 84 | +
|
| 85 | + >>> res = client.data_modeling.time_series.retrieve( |
| 86 | + ... [("my-space", "ts-1"), ("my-space", "ts-2")] |
| 87 | + ... ) |
| 88 | +
|
| 89 | + Fetch properties from a custom view (note, only time series will be returned): |
| 90 | +
|
| 91 | + >>> from cognite.client.data_classes.data_modeling import ViewId |
| 92 | + >>> res = client.data_modeling.time_series.retrieve( |
| 93 | + ... NodeId("my-space", "my-ts"), |
| 94 | + ... source=ViewId("my-space", "MyTimeSeriesExtension", "v1"), |
| 95 | + ... ) |
| 96 | + """ |
| 97 | + sources, strip = resolve_source(source, COGNITE_TIME_SERIES_VIEW_ID) |
| 98 | + result = await self._instances_api.retrieve_nodes(nodes=node_ids, sources=sources) |
| 99 | + if strip: |
| 100 | + strip_canonical_source(result, COGNITE_TIME_SERIES_VIEW_ID) |
| 101 | + return result |
| 102 | + |
| 103 | + async def list( |
| 104 | + self, |
| 105 | + *, |
| 106 | + source: View | ViewId | tuple[str, str, str] = COGNITE_TIME_SERIES_VIEW_ID, |
| 107 | + space: str | SequenceNotStr[str] | None = None, |
| 108 | + sort: Sequence[InstanceSort | dict] | InstanceSort | dict | None = None, |
| 109 | + filter: Filter | dict[str, Any] | None = None, |
| 110 | + limit: int | None = DEFAULT_LIMIT_READ, |
| 111 | + ) -> NodeList[Node]: |
| 112 | + """`List time series nodes <https://api-docs.cognite.com/20230101/tag/Instances/operation/advancedListInstance>`_. |
| 113 | +
|
| 114 | + Only time series nodes will be returned, regardless of the source passed. |
| 115 | +
|
| 116 | + Args: |
| 117 | + source (View | ViewId | tuple[str, str, str]): The view to fetch properties from. Defaults to CogniteTimeSeries. |
| 118 | + space (str | SequenceNotStr[str] | None): Restrict results to this space (or list of spaces). |
| 119 | + sort (Sequence[InstanceSort | dict] | InstanceSort | dict | None): Sort order for the results. |
| 120 | + filter (Filter | dict[str, Any] | None): Advanced filter to apply. See :class:`~cognite.client.data_classes.filters`. |
| 121 | + limit (int | None): Maximum number of results to return. Defaults to 25. Set to -1, float("inf") or None to return all items. |
| 122 | +
|
| 123 | + Returns: |
| 124 | + NodeList[Node]: The matching time series. |
| 125 | +
|
| 126 | + Examples: |
| 127 | +
|
| 128 | + List a few time series: |
| 129 | +
|
| 130 | + >>> from cognite.client import CogniteClient |
| 131 | + >>> client = CogniteClient() |
| 132 | + >>> res = client.data_modeling.time_series.list(limit=5) |
| 133 | +
|
| 134 | + List all time series in a specific space: |
| 135 | +
|
| 136 | + >>> res = client.data_modeling.time_series.list(space="my-space", limit=None) |
| 137 | +
|
| 138 | + Fetch properties from a custom view (note, only time series will be returned), and |
| 139 | + apply a custom filter on the name: |
| 140 | +
|
| 141 | + >>> from cognite.client.data_classes.data_modeling import ViewId |
| 142 | + >>> from cognite.client.data_classes import filters |
| 143 | + >>> view_id = ViewId("my-space", "MyTimeSeriesExtension", "v1") |
| 144 | + >>> res = client.data_modeling.time_series.list( |
| 145 | + ... source=view_id, |
| 146 | + ... filter=filters.Prefix(view_id.as_property_ref("name"), "sensor"), |
| 147 | + ... limit=None, |
| 148 | + ... ) |
| 149 | + """ |
| 150 | + sources, strip = resolve_source(source, COGNITE_TIME_SERIES_VIEW_ID) |
| 151 | + results = await self._instances_api.list( |
| 152 | + instance_type="node", |
| 153 | + sources=sources, |
| 154 | + space=space, |
| 155 | + sort=sort, |
| 156 | + filter=filter, |
| 157 | + limit=limit, |
| 158 | + ) |
| 159 | + if strip: |
| 160 | + strip_canonical_source(results, COGNITE_TIME_SERIES_VIEW_ID) |
| 161 | + return results |
0 commit comments