feat(streams): Records API

[andersfylling]

Summary

Adds StreamsRecordsAPI at client.streams.records (ingest, upsert, delete, filter, aggregate, sync), record/sync/response data classes, POST retry rules for record write paths, CogniteClientMock wiring, and tests.

Stack

• Base: feat(streams): Streams API #2534 (andersfylling/cognite-sdk/streams-api) — merge that PR first, then rebase this branch onto master if needed or merge as-is after feat(streams): Streams API #2534 lands.

Example: create and delete a stream (live project)

Streams are created and removed with client.streams (see #2534). The API accepts one stream per create/delete request.

import uuid

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

# Build a client (e.g. client credentials against your CDF cluster)
client = CogniteClient.default_oauth_client_credentials(
    project="your-project",
    cdf_cluster="api",  # or greenfield, etc.
    tenant_id="your-azure-tenant-id",
    client_id="your-app-id",
    client_secret="your-secret",
    client_name="my-app-streams-example",
)

# Create (template name must exist in your tenant; rate limits apply)
external_id = f"example_stream_{uuid.uuid4().hex[:12]}"
client.streams.create(
    [StreamWrite(external_id, {"template": {"name": "ImmutableTestStream"}})]
)

# Use the stream (e.g. client.streams.records.ingest_items(...)), then soft-delete when done
client.streams.delete([StreamDeleteItem(external_id)])

End-to-end smoke (list → create → retrieve → delete, and optional records when ILA_E2E_RECORD_JSON is set):

uv run python scripts/ila_streams_e2e_flow.py

Credentials and project access follow the same pattern as other integration tests in CONTRIBUTING.md.

Made with Cursor

[andersfylling]

Tests & local verification

Unit tests: tests/tests_unit/test_api/test_streams_records.py covers all record endpoints (ingest, upsert, delete, filter, aggregate, sync) plus ingest_items / upsert_items / delete_items.

Live smoke script (requires CDF credentials per CONTRIBUTING.md):

poetry install -E all && poetry run python scripts/ila_streams_records_smoke.py --help
poetry run python scripts/ila_streams_records_smoke.py
# optional ingest (set ILA_STREAM_EXTERNAL_ID + ILA_RECORD_ITEM_JSON):
ILA_STREAM_EXTERNAL_ID=my-stream ILA_RECORD_ITEM_JSON='{"space":"...","externalId":"...","sources":[...]}' \
  poetry run python scripts/ila_streams_records_smoke.py --ingest-one

CI note: This PR targets andersfylling/cognite-sdk/streams-api, not master, so the repo\u2019s build workflow (pull_request \u2192 master) does not run on this PR. After #2534 merges, rebase this branch onto master and retarget the PR (or open a new PR) to get test_core / test_full on GitHub Actions.

[codecov]

Codecov Report

❌ Patch coverage is 97.13701% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.45%. Comparing base (ffcc432) to head (9405be5).
⚠️ Report is 12 commits behind head on pysdk-release-v8.

Files with missing lines	Patch %	Lines
tests/tests_integration/test_api/test_workflows.py	61.11%	7 Missing ⚠️
cognite/client/_api/streams/__init__.py	87.17%	5 Missing ⚠️
cognite/client/_api/streams/records.py	97.61%	1 Missing ⚠️
...gnite/client/data_classes/streams/stream_record.py	98.96%	1 Missing ⚠️

Additional details and impacted files

@@                 Coverage Diff                  @@
##           pysdk-release-v8    #2535      +/-   ##
====================================================
+ Coverage             93.41%   93.45%   +0.03%     
====================================================
  Files                   478      488      +10     
  Lines                 48217    48695     +478     
====================================================
+ Hits                  45044    45510     +466     
- Misses                 3173     3185      +12     

Files with missing lines	Coverage Δ
cognite/client/_cognite_client.py	92.72% <100.00%> (+0.13%)	⬆️
cognite/client/_sync_api/streams/__init__.py	100.00% <100.00%> (ø)
cognite/client/_sync_api/streams/records.py	100.00% <100.00%> (ø)
cognite/client/_sync_cognite_client.py	91.42% <100.00%> (+0.16%)	⬆️
cognite/client/data_classes/__init__.py	100.00% <100.00%> (ø)
cognite/client/data_classes/streams/__init__.py	100.00% <100.00%> (ø)
cognite/client/data_classes/streams/stream.py	100.00% <100.00%> (ø)
cognite/client/testing.py	100.00% <100.00%> (ø)
cognite/client/utils/_url.py	100.00% <ø> (ø)
tests/tests_unit/test_api/test_streams.py	100.00% <100.00%> (ø)
... and 7 more

... and 5 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.