feat(streams): Streams API

[andersfylling]

Summary

Add streams api to sdk.

Example

from cognite.client import CogniteClient
from cognite.client.data_classes.data_modeling.streams import StreamDeleteItem, StreamWrite

client = CogniteClient(...)  # your usual ClientConfig / credentials

external_id = "my_stream"
client.data_modeling.streams.create([StreamWrite(external_id, {"template": {"name": "ImmutableTestStream"}})])
client.data_modeling.streams.list()
client.data_modeling.streams.retrieve(external_id)
client.data_modeling.streams.delete([StreamDeleteItem(external_id)])

This PR does not add the Records API (#2535).

closes #2519
closes #2246

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.80%. Comparing base (c9cc644) to head (ec2959d).
⚠️ Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2534      +/-   ##
==========================================
- Coverage   92.82%   92.80%   -0.03%     
==========================================
  Files         480      485       +5     
  Lines       48502    48763     +261     
==========================================
+ Hits        45021    45253     +232     
- Misses       3481     3510      +29     

Files with missing lines	Coverage Δ
cognite/client/_api/data_modeling/__init__.py	100.00% <100.00%> (ø)
cognite/client/_api/data_modeling/streams.py	100.00% <100.00%> (ø)
cognite/client/_sync_api/data_modeling/__init__.py	100.00% <100.00%> (ø)
cognite/client/_sync_api/data_modeling/streams.py	100.00% <100.00%> (ø)
...nite/client/data_classes/data_modeling/__init__.py	100.00% <100.00%> (ø)
...gnite/client/data_classes/data_modeling/streams.py	100.00% <100.00%> (ø)
cognite/client/testing.py	100.00% <100.00%> (ø)
cognite/client/utils/_url.py	100.00% <ø> (ø)
...s_unit/test_api/test_data_modeling/test_streams.py	100.00% <100.00%> (ø)
tests/tests_unit/test_api_client.py	99.71% <ø> (ø)
... and 1 more

... and 11 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[haakonvt]

Part 1 of review: cognite/client/_api/streams/__init__.py

[polomani]

perhaps it's better to add some warning first in case the SDK implementation changes?

[polomani]

self._warning = FeaturePreviewWarning(
            api_maturity="General Availability",
            sdk_maturity="alpha",
            feature_name="Streams",
        )

[polomani]

@andersfylling is this PR dead?

[haakonvt]

@andersfylling is this PR dead?

He is probably out of Claude tokens 😆

[haakonvt]

Let's use self._list here to avoid having to manually supply the semaphore + load data class

[andersfylling]

we don't support limit, and we don't have cursor implementation there.

[haakonvt]

Using createdFromTemplate seems to not be too reliable according to the docs:

Name of the template used for creating this stream. Note: This value is for information only. The template might have been modified or even entirely deleted after the stream has been created.

[haakonvt]

Let's add a FeaturePreviewWarning here since the docs says:

Note: Stream Templates are in Beta

Optionally - or maybe better - lets add a "SDK in alpha" warning to the StreamsAPI itself to give ourselves some freedom in changing/modifying the SDK API design for some time.

[haakonvt]

Please split mock responses into fixtures in order to keep more "condense test logic" in the actual tests

[haakonvt]

I think most of these tests are already covered by our automatic testing, at least load/dump roundtrips of varying sorts, meaning most if not all of these tests can be removed