Skip to content

feat: Allow iterable of ids in retrieve methods for datapoints #2583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MortGron wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: Allow iterable of ids in retrieve methods for datapoints #2583

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad558f1
feat: Allow iterable of ids in retrieve methods for datapoints
MortGron Apr 20, 2026
b595b3d
Merge branch 'master' into retrieve-datapoints-accept-iterable-of-ids
MortGron Apr 20, 2026
f23ab17
Update docstrings
MortGron Apr 21, 2026
0794807
Fix return type issue
MortGron Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions cognite/client/_api/datapoint_tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
time_shift_to_ms,
timestamp_to_ms,
)
from cognite.client.utils.useful_types import SequenceNotStr, is_sequence_not_str
from cognite.client.utils.useful_types import is_sequence_not_str

if NUMPY_IS_AVAILABLE:
import numpy as np
Expand Down Expand Up @@ -154,14 +154,13 @@ def _parse(
arg_name: Literal["id", "external_id", "instance_id"],
exp_type: type,
) -> list[DatapointsQuery]:
user_queries: SequenceNotStr[int | str | NodeId | DatapointsQuery]
if isinstance(identifier, (DatapointsQuery, exp_type)):
# Lazy - we postpone evaluation:
user_queries = [identifier]

elif is_sequence_not_str(identifier):
# We use Sequence because we require an ordering of elements (and finite iterable)
user_queries: Iterable[int | str | NodeId | DatapointsQuery]
if isinstance(identifier, Iterable) and not isinstance(identifier, str):
Comment thread
MortGron marked this conversation as resolved.
user_queries = identifier
elif isinstance(identifier, (DatapointsQuery, exp_type)):
# Lazy - we postpone evaluation:
# mypy 1.19.1 thinks identifier can be an iterable that is not a string
user_queries = [identifier] # type: ignore[list-item]
else:
self._raise_on_wrong_ts_identifier_type(identifier, arg_name, exp_type)
Comment thread
MortGron marked this conversation as resolved.

Expand Down
70 changes: 35 additions & 35 deletions cognite/client/_api/datapoints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,7 +782,7 @@ async def retrieve(
async def retrieve(
self,
*,
id: Sequence[int | DatapointsQuery],
id: Iterable[int | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -799,7 +799,7 @@ async def retrieve(
) -> DatapointsList: ...

@overload
async def retrieve(
async def retrieve( # type: ignore[overload-overlap]
self,
*,
external_id: str | DatapointsQuery,
Expand All @@ -822,7 +822,7 @@ async def retrieve(
async def retrieve(
self,
*,
external_id: SequenceNotStr[str | DatapointsQuery],
external_id: Iterable[str | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand Down Expand Up @@ -862,7 +862,7 @@ async def retrieve(
async def retrieve(
self,
*,
instance_id: Sequence[NodeId | DatapointsQuery],
instance_id: Iterable[NodeId | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -882,8 +882,8 @@ async def retrieve(
async def retrieve(
self,
*,
id: None | int | DatapointsQuery | Sequence[int | DatapointsQuery],
external_id: None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery],
id: None | int | DatapointsQuery | Iterable[int | DatapointsQuery],
external_id: None | str | DatapointsQuery | Iterable[str | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -903,8 +903,8 @@ async def retrieve(
async def retrieve(
self,
*,
id: None | int | DatapointsQuery | Sequence[int | DatapointsQuery],
instance_id: None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery],
id: None | int | DatapointsQuery | Iterable[int | DatapointsQuery],
instance_id: None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -924,8 +924,8 @@ async def retrieve(
async def retrieve(
self,
*,
external_id: None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery],
instance_id: None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery],
external_id: None | str | DatapointsQuery | Iterable[str | DatapointsQuery],
instance_id: None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -945,9 +945,9 @@ async def retrieve(
async def retrieve(
self,
*,
id: None | int | DatapointsQuery | Sequence[int | DatapointsQuery],
external_id: None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery],
instance_id: None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery],
id: None | int | DatapointsQuery | Iterable[int | DatapointsQuery],
external_id: None | str | DatapointsQuery | Iterable[str | DatapointsQuery],
instance_id: None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -966,9 +966,9 @@ async def retrieve(
async def retrieve(
self,
*,
id: None | int | DatapointsQuery | Sequence[int | DatapointsQuery] = None,
external_id: None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery] = None,
instance_id: None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery] = None,
id: None | int | DatapointsQuery | Iterable[int | DatapointsQuery] = None,
external_id: None | str | DatapointsQuery | Iterable[str | DatapointsQuery] = None,
instance_id: None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery] = None,
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand Down Expand Up @@ -1007,9 +1007,9 @@ async def retrieve(
`status codes. <https://docs.cognite.com/dev/concepts/reference/status_codes/>`_

Args:
id (None | int | DatapointsQuery | Sequence[int | DatapointsQuery]): Id, dict (with id) or (mixed) sequence of these. See examples below.
external_id (None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery]): External id, dict (with external id) or (mixed) sequence of these. See examples below.
instance_id (None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery]): Instance id or sequence of instance ids.
id (None | int | DatapointsQuery | Iterable[int | DatapointsQuery]): Id, dict (with id) or (mixed) sequence of these. See examples below.
external_id (None | str | DatapointsQuery | Iterable[str | DatapointsQuery]): External id, dict (with external id) or (mixed) sequence of these. See examples below.
instance_id (None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery]): Instance id or sequence of instance ids.
start (int | str | datetime.datetime | None): Inclusive start. Default: 1970-01-01 UTC.
end (int | str | datetime.datetime | None): Exclusive end. Default: "now"
aggregates (Aggregate | str | list[Aggregate | str] | None): Single aggregate or list of aggregates to retrieve. Available options: ``average``, ``continuous_variance``, ``count``, ``count_bad``, ``count_good``, ``count_uncertain``, ``discrete_variance``, ``duration_bad``, ``duration_good``, ``duration_uncertain``, ``interpolation``, ``max``, ``max_datapoint``, ``min``, ``min_datapoint``, ``step_interpolation``, ``sum`` and ``total_variation``. Default: None (raw datapoints returned)
Expand Down Expand Up @@ -1242,7 +1242,7 @@ async def retrieve_arrays(
async def retrieve_arrays(
self,
*,
id: Sequence[int | DatapointsQuery],
id: Iterable[int | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -1259,7 +1259,7 @@ async def retrieve_arrays(
) -> DatapointsArrayList: ...

@overload
async def retrieve_arrays(
async def retrieve_arrays( # type: ignore[overload-overlap]
self,
*,
external_id: str | DatapointsQuery,
Expand All @@ -1282,7 +1282,7 @@ async def retrieve_arrays(
async def retrieve_arrays(
self,
*,
external_id: SequenceNotStr[str | DatapointsQuery],
external_id: Iterable[str | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand Down Expand Up @@ -1322,7 +1322,7 @@ async def retrieve_arrays(
async def retrieve_arrays(
self,
*,
instance_id: Sequence[NodeId | DatapointsQuery],
instance_id: Iterable[NodeId | DatapointsQuery],
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -1341,9 +1341,9 @@ async def retrieve_arrays(
async def retrieve_arrays(
self,
*,
id: None | int | DatapointsQuery | Sequence[int | DatapointsQuery] = None,
external_id: None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery] = None,
instance_id: None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery] = None,
id: None | int | DatapointsQuery | Iterable[int | DatapointsQuery] = None,
external_id: None | str | DatapointsQuery | Iterable[str | DatapointsQuery] = None,
instance_id: None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery] = None,
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand All @@ -1367,9 +1367,9 @@ async def retrieve_arrays(
`status codes. <https://docs.cognite.com/dev/concepts/reference/status_codes/>`_

Args:
id (None | int | DatapointsQuery | Sequence[int | DatapointsQuery]): Id, dict (with id) or (mixed) sequence of these. See examples below.
external_id (None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery]): External id, dict (with external id) or (mixed) sequence of these. See examples below.
instance_id (None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery]): Instance id or sequence of instance ids.
id (None | int | DatapointsQuery | Iterable[int | DatapointsQuery]): Id, dict (with id) or (mixed) sequence of these. See examples below.
external_id (None | str | DatapointsQuery | Iterable[str | DatapointsQuery]): External id, dict (with external id) or (mixed) sequence of these. See examples below.
instance_id (None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery]): Instance id or sequence of instance ids.
start (int | str | datetime.datetime | None): Inclusive start. Default: 1970-01-01 UTC.
end (int | str | datetime.datetime | None): Exclusive end. Default: "now"
aggregates (Aggregate | str | list[Aggregate | str] | None): Single aggregate or list of aggregates to retrieve. Available options: ``average``, ``continuous_variance``, ``count``, ``count_bad``, ``count_good``, ``count_uncertain``, ``discrete_variance``, ``duration_bad``, ``duration_good``, ``duration_uncertain``, ``interpolation``, ``max``, ``max_datapoint``, ``min``, ``min_datapoint``, ``step_interpolation``, ``sum`` and ``total_variation``. Default: None (raw datapoints returned)
Expand Down Expand Up @@ -1470,9 +1470,9 @@ async def retrieve_arrays(
async def retrieve_dataframe(
self,
*,
id: None | int | DatapointsQuery | Sequence[int | DatapointsQuery] = None,
external_id: None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery] = None,
instance_id: None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery] = None,
id: None | int | DatapointsQuery | Iterable[int | DatapointsQuery] = None,
external_id: None | str | DatapointsQuery | Iterable[str | DatapointsQuery] = None,
instance_id: None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery] = None,
start: int | str | datetime.datetime | None = None,
end: int | str | datetime.datetime | None = None,
aggregates: Aggregate | str | list[Aggregate | str] | None = None,
Expand Down Expand Up @@ -1500,9 +1500,9 @@ async def retrieve_dataframe(
For many more usage examples, check out the :py:meth:`~DatapointsAPI.retrieve` method which accepts exactly the same arguments.

Args:
id (None | int | DatapointsQuery | Sequence[int | DatapointsQuery]): Id, DatapointsQuery or (mixed) sequence of these. See examples.
external_id (None | str | DatapointsQuery | SequenceNotStr[str | DatapointsQuery]): External id, DatapointsQuery or (mixed) sequence of these. See examples.
instance_id (None | NodeId | DatapointsQuery | Sequence[NodeId | DatapointsQuery]): Instance id, DatapointsQuery or (mixed) sequence of these. See examples.
id (None | int | DatapointsQuery | Iterable[int | DatapointsQuery]): Id, DatapointsQuery or (mixed) sequence of these. See examples.
external_id (None | str | DatapointsQuery | Iterable[str | DatapointsQuery]): External id, DatapointsQuery or (mixed) sequence of these. See examples.
instance_id (None | NodeId | DatapointsQuery | Iterable[NodeId | DatapointsQuery]): Instance id, DatapointsQuery or (mixed) sequence of these. See examples.
start (int | str | datetime.datetime | None): Inclusive start. Default: 1970-01-01 UTC.
end (int | str | datetime.datetime | None): Exclusive end. Default: "now"
aggregates (Aggregate | str | list[Aggregate | str] | None): Single aggregate or list of aggregates to retrieve. Available options: ``average``, ``continuous_variance``, ``count``, ``count_bad``, ``count_good``, ``count_uncertain``, ``discrete_variance``, ``duration_bad``, ``duration_good``, ``duration_uncertain``, ``interpolation``, ``max``, ``max_datapoint``, ``min``, ``min_datapoint``, ``step_interpolation``, ``sum`` and ``total_variation``. Default: None (raw datapoints returned)
Expand Down
Loading
Loading