add support for the simulators endpoint #2066

abdullah-cognite · 2024-12-17T09:05:38Z

Description

Added the /simulators endpoint to the SDK. This is the first PR coming from the split of this big PR: https://github.com/cognitedata/cognite-sdk-python/pull/2006/files

Adds support for the following Resource:

Simulator resource
Simulator integration resource

Checklist:

Tests added/updated.
Documentation updated. Documentation is generated from docstrings - these must be updated according to your change.
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.
Changelog updated in CHANGELOG.md.
Version bumped. If triggering a new release is desired, bump the version number in _version.py and pyproject.toml per semantic versioning.

abdullah-cognite · 2024-12-17T09:25:14Z

tests/tests_integration/test_api/test_simulators/test_simulators.py

+    simulators = cognite_client.simulators.list()
+    simulator_exists = len(list(filter(lambda x: x.external_id == simulator_external_id, simulators))) > 0
+    if not simulator_exists:
+        cognite_client.post(


We won't have a simulator.create function in the sdk

codecov · 2024-12-17T10:10:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.60%. Comparing base (89849d2) to head (f1c34ac).
Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2066      +/-   ##
==========================================
+ Coverage   90.49%   90.60%   +0.10%     
==========================================
  Files         141      145       +4     
  Lines       22557    22742     +185     
==========================================
+ Hits        20414    20606     +192     
+ Misses       2143     2136       -7

Files with missing lines	Coverage Δ
cognite/client/_api/simulators/__init__.py	`100.00% <100.00%> (ø)`
cognite/client/_api/simulators/integrations.py	`100.00% <100.00%> (ø)`
cognite/client/_api_client.py	`90.34% <ø> (ø)`
cognite/client/_cognite_client.py	`93.81% <100.00%> (+0.13%)`	⬆️
cognite/client/data_classes/simulators/__init__.py	`100.00% <100.00%> (ø)`
cognite/client/data_classes/simulators/filters.py	`100.00% <100.00%> (ø)`
...gnite/client/data_classes/simulators/simulators.py	`100.00% <100.00%> (ø)`
cognite/client/testing.py	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

tests/tests_integration/test_api/test_simulators/test_simulators.py

abdullah-cognite · 2024-12-18T15:00:14Z

tests/tests_integration/test_api/test_simulators/seed/data.py

@@ -0,0 +1,216 @@
+# This file contains the data used to seed the test environment for the simulator tests
+
+data_set_id = 1521375514069


There was a comment about having this in a fixture. The reason we have it here as a common variable is that we need it as part of the resources being seeded in this file (simulator integration) and models and routines in the other pr.

I don't understand this, but feel free to leave it as is - but, please add a comment on why it is necessary - or why it is just temporarily needed.

Can you change it to a data set external id? Then do lookup in a fixture? (That would make running the test suite against different CDF projects much simpler. Note also that we are going to change the test project next year, as using a staging cluster is not ideal for test flakyness 😅 )

haakonvt

Clean and easily readable code!

Here's a few comments to get this over the finish line

cognite/client/_api/simulators/__init__.py

haakonvt · 2024-12-19T00:25:24Z

cognite/client/_api/simulators/__init__.py

+            List simulators:
+
+                    >>> from cognite.client import CogniteClient
+                    >>> client = CogniteClient()
+                    >>> res = client.simulators.list()


Are you planning to add __call__ & __iter__? I do think almost all our APIs support the "iterative" approach.

cognite/client/_api/simulators/integrations.py

cognite/client/data_classes/simulators/simulators.py

polomani · 2024-12-19T14:08:07Z

tests/tests_integration/test_api/test_simulators/seed/data.py

@@ -0,0 +1,216 @@
+# This file contains the data used to seed the test environment for the simulator tests
+
+data_set_id = 1521375514069


I agree this should no be hardcoded as an internal id. it should be an external id + lookup

polomani · 2025-01-06T09:38:58Z

cognite/client/data_classes/simulators/simulators.py

+        model_types: SimulatorModelType | Sequence[SimulatorModelType] | None = None,
+        step_fields: SimulatorStep | Sequence[SimulatorStep] | None = None,
+        unit_quantities: SimulatorQuantity | Sequence[SimulatorQuantity] | None = None,


polomani · 2025-01-06T09:39:29Z

cognite/client/data_classes/simulators/simulators.py

+        model_types (SimulatorModelType | Sequence[SimulatorModelType] | None): Model types supported by the simulator
+        step_fields (SimulatorStep | Sequence[SimulatorStep] | None): Step types supported by the simulator when creating routines
+        unit_quantities (SimulatorQuantity | Sequence[SimulatorQuantity] | None): Quantities and their units supported by the simulator


Suggested change

model_types (SimulatorModelType | Sequence[SimulatorModelType] | None): Model types supported by the simulator

step_fields (SimulatorStep | Sequence[SimulatorStep] | None): Step types supported by the simulator when creating routines

unit_quantities (SimulatorQuantity | Sequence[SimulatorQuantity] | None): Quantities and their units supported by the simulator

model_types (Sequence[SimulatorModelType] | None): Model types supported by the simulator

step_fields (Sequence[SimulatorStep] | None): Step types supported by the simulator when creating routines

unit_quantities (Sequence[SimulatorQuantity] | None): Quantities and their units supported by the simulator

polomani · 2025-01-06T09:39:59Z

cognite/client/data_classes/simulators/simulators.py

+        external_id: str,
+        id: int,
+        name: str,
+        file_extension_types: str | Sequence[str],


Suggested change

file_extension_types: str | Sequence[str],

file_extension_types: Sequence[str],

Co-authored-by: Ivan Polomani <[email protected]>

abdullah-cognite added 3 commits December 17, 2024 09:05

first draft

4826ed3

add SimulatorsApi

5dcc0c8

add simulator test

ae25ff0

abdullah-cognite commented Dec 17, 2024

View reviewed changes

abdullah-cognite added 3 commits December 17, 2024 09:30

add simulators api to mock

f6beb03

remove simulators from retryable apis

efa9fa0

update tests

a22e52b

add retryable endpoint test

6559c2d

abdullah-cognite commented Dec 17, 2024

View reviewed changes

tests/tests_integration/test_api/test_simulators/test_simulators.py Outdated Show resolved Hide resolved

abdullah-cognite requested a review from haakonvt December 17, 2024 10:33

abdullah-cognite marked this pull request as ready for review December 17, 2024 10:35

abdullah-cognite requested review from a team as code owners December 17, 2024 10:35

abdullah-cognite mentioned this pull request Dec 17, 2024

Simulators API #2006

Open

5 tasks

abdullah-cognite requested a review from a team December 17, 2024 11:46

abdullah-cognite added 7 commits December 18, 2024 12:52

move fixtures to conftest

6fbc679

add integrations

98a1388

fix MagicMock error

ddd34a4

add delete functionality to integrations

f35fc50

fix typo

e6e76c0

update __init__

00eaafd

update dataset id

1f694cc

abdullah-cognite commented Dec 18, 2024

View reviewed changes

haakonvt reviewed Dec 19, 2024

View reviewed changes

polomani reviewed Dec 19, 2024

View reviewed changes

abdullah-cognite added 4 commits January 5, 2025 16:11

address comments

27ab947

Merge branch 'master' into simulators-sdk-first

f2983cf

data-set creation update

4c839b3

data-set creation update

7bee982

abdullah-cognite added 3 commits January 5, 2025 19:45

data-set creation update

7f6ae3f

data-set creation update

640c110

replace datasetids with externalid

1475737

polomani reviewed Jan 6, 2025

View reviewed changes

abdullah-cognite and others added 4 commits January 6, 2025 12:20

Update cognite/client/data_classes/simulators/simulators.py

76423ab

Co-authored-by: Ivan Polomani <[email protected]>

Update cognite/client/data_classes/simulators/simulators.py

9af1932

Co-authored-by: Ivan Polomani <[email protected]>

Update cognite/client/data_classes/simulators/simulators.py

20594b2

Co-authored-by: Ivan Polomani <[email protected]>

reverting last change

f1c34ac

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for the simulators endpoint #2066

add support for the simulators endpoint #2066

abdullah-cognite commented Dec 17, 2024 •

edited

Loading

abdullah-cognite Dec 17, 2024

codecov bot commented Dec 17, 2024 •

edited

Loading

abdullah-cognite Dec 18, 2024

haakonvt Dec 19, 2024

haakonvt left a comment

haakonvt Dec 19, 2024

polomani Dec 19, 2024

polomani Jan 6, 2025

polomani Jan 6, 2025

polomani Jan 6, 2025

		@@ -0,0 +1,216 @@
		# This file contains the data used to seed the test environment for the simulator tests

		data_set_id = 1521375514069

	file_extension_types: str \| Sequence[str],
	file_extension_types: Sequence[str],

add support for the simulators endpoint #2066

Are you sure you want to change the base?

add support for the simulators endpoint #2066

Conversation

abdullah-cognite commented Dec 17, 2024 • edited Loading

Description

Adds support for the following Resource:

Checklist:

Choose a reason for hiding this comment

codecov bot commented Dec 17, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

haakonvt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abdullah-cognite commented Dec 17, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading