Skip to content

Commit 15bc400

Browse files
polomanierlendvollset
polomani
and
erlendvollset
authored
feat(simint-alpha): change mouthfull class names (#2277)
Co-authored-by: Erlend vollset <erlendvollset@gmail.com>
1 parent ce8cbc2 commit 15bc400

6 files changed

Lines changed: 41 additions & 34 deletions

File tree

‎cognite/client/_api/simulators/models_revisions.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,7 @@ def create(
247247
Examples:
248248
Create new simulator model revisions:
249249
>>> from cognite.client import CogniteClient
250-
>>> from cognite.client.data_classes.simulators import SimulatorModelRevisionWrite
251-
>>> from cognite.client.data_classes.simulators.models import SimulatorExternalDependencyFileInternalId, SimulatorModelRevisionExternalDependency
250+
>>> from cognite.client.data_classes.simulators import SimulatorModelRevisionWrite, SimulatorModelDependencyFileId, SimulatorModelRevisionDependency
252251
>>> client = CogniteClient()
253252
>>> revisions = [
254253
... SimulatorModelRevisionWrite(
@@ -261,8 +260,8 @@ def create(
261260
... file_id=2,
262261
... model_external_id="a_2",
263262
... external_dependencies = [
264-
... SimulatorModelRevisionExternalDependency(
265-
... file=SimulatorExternalDependencyFileInternalId(id=123),
263+
... SimulatorModelRevisionDependency(
264+
... file=SimulatorModelDependencyFileId(id=123),
266265
... arguments={
267266
... "fieldA": "value1",
268267
... "fieldB": "value2",

‎cognite/client/data_classes/simulators/__init__.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,15 @@
88
)
99
from cognite.client.data_classes.simulators.models import (
1010
SimulatorModel,
11+
SimulatorModelDependencyFileId,
12+
SimulatorModelDependencyFileReference,
1113
SimulatorModelList,
1214
SimulatorModelRevision,
15+
SimulatorModelRevisionDependency,
1316
SimulatorModelRevisionList,
1417
SimulatorModelRevisionWrite,
18+
SimulatorModelRevisionWriteList,
19+
SimulatorModelUpdate,
1520
SimulatorModelWrite,
1621
)
1722
from cognite.client.data_classes.simulators.runs import (
@@ -44,11 +49,16 @@
4449
"SimulatorIntegrationList",
4550
"SimulatorList",
4651
"SimulatorModel",
52+
"SimulatorModelDependencyFileId",
53+
"SimulatorModelDependencyFileReference",
4754
"SimulatorModelList",
4855
"SimulatorModelRevision",
56+
"SimulatorModelRevisionDependency",
4957
"SimulatorModelRevisionList",
5058
"SimulatorModelRevisionWrite",
59+
"SimulatorModelRevisionWriteList",
5160
"SimulatorModelRevisionsFilter",
61+
"SimulatorModelUpdate",
5262
"SimulatorModelWrite",
5363
"SimulatorModelsFilter",
5464
"SimulatorStep",

‎cognite/client/data_classes/simulators/models.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(
3030
model_external_id: str,
3131
file_id: int,
3232
description: str | None = None,
33-
external_dependencies: list[SimulatorModelRevisionExternalDependency] | None = None,
33+
external_dependencies: list[SimulatorModelRevisionDependency] | None = None,
3434
) -> None:
3535
self.external_id = external_id
3636
self.model_external_id = model_external_id
@@ -45,7 +45,7 @@ def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None =
4545
model_external_id=resource["modelExternalId"],
4646
file_id=resource["fileId"],
4747
description=resource.get("description"),
48-
external_dependencies=SimulatorModelRevisionExternalDependency._load_list(
48+
external_dependencies=SimulatorModelRevisionDependency._load_list(
4949
resource["externalDependencies"], cognite_client
5050
)
5151
if "externalDependencies" in resource
@@ -74,7 +74,7 @@ def _load(
7474
model_external_id=resource["modelExternalId"],
7575
file_id=resource["fileId"],
7676
description=resource.get("description"),
77-
external_dependencies=SimulatorModelRevisionExternalDependency._load_list(
77+
external_dependencies=SimulatorModelRevisionDependency._load_list(
7878
resource["externalDependencies"], cognite_client
7979
)
8080
if "externalDependencies" in resource
@@ -103,7 +103,7 @@ class SimulatorModelRevision(SimulatorModelRevisionCore):
103103
log_id (int): The id of the log associated with the simulator model revision
104104
description (str | None): The description of the simulator model revision
105105
status_message (str | None): The current status message of the simulator model revision
106-
external_dependencies (list[SimulatorModelRevisionExternalDependency] | None): A list of external dependencies for the simulator model revision
106+
external_dependencies (list[SimulatorModelRevisionDependency] | None): A list of external dependencies for the simulator model revision
107107
"""
108108

109109
def __init__(
@@ -122,7 +122,7 @@ def __init__(
122122
log_id: int,
123123
description: str | None = None,
124124
status_message: str | None = None,
125-
external_dependencies: list[SimulatorModelRevisionExternalDependency] | None = None,
125+
external_dependencies: list[SimulatorModelRevisionDependency] | None = None,
126126
) -> None:
127127
super().__init__(
128128
external_id=external_id,
@@ -159,7 +159,7 @@ def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None =
159159
log_id=resource["logId"],
160160
description=resource.get("description"),
161161
status_message=resource.get("statusMessage"),
162-
external_dependencies=SimulatorModelRevisionExternalDependency._load_list(
162+
external_dependencies=SimulatorModelRevisionDependency._load_list(
163163
resource["externalDependencies"], cognite_client
164164
)
165165
if "externalDependencies" in resource
@@ -355,11 +355,11 @@ def _get_update_properties(cls, item: CogniteResource | None = None) -> list[Pro
355355

356356

357357
@dataclass
358-
class SimulatorExternalDependencyFileReference(CogniteObject): ...
358+
class SimulatorModelDependencyFileReference(CogniteObject): ...
359359

360360

361361
@dataclass
362-
class SimulatorExternalDependencyFileInternalId(SimulatorExternalDependencyFileReference):
362+
class SimulatorModelDependencyFileId(SimulatorModelDependencyFileReference):
363363
id: int
364364

365365
@classmethod
@@ -370,21 +370,21 @@ def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None =
370370

371371

372372
@dataclass
373-
class SimulatorModelRevisionExternalDependency(CogniteObject):
373+
class SimulatorModelRevisionDependency(CogniteObject):
374374
"""
375375
Represents an external dependency for a simulator model revision.
376376
Args:
377377
file (int): The file ID associated with the external dependency.
378378
arguments (dict[str, str]): A dictionary that contains the key-value pairs (fields) for the external dependency.
379379
"""
380380

381-
file: SimulatorExternalDependencyFileReference
381+
file: SimulatorModelDependencyFileReference
382382
arguments: dict[str, str]
383383

384384
@classmethod
385385
def _load(cls, resource: dict[str, Any], cognite_client: CogniteClient | None = None) -> Self:
386386
return cls(
387-
file=SimulatorExternalDependencyFileInternalId.load(resource["file"])
387+
file=SimulatorModelDependencyFileId.load(resource["file"])
388388
if "id" in resource["file"]
389389
else resource["file"],
390390
arguments=resource["arguments"],
@@ -394,13 +394,13 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
394394
output = super().dump(camel_case=camel_case)
395395
output["file"] = (
396396
self.file.dump(camel_case=camel_case)
397-
if isinstance(self.file, SimulatorExternalDependencyFileReference)
397+
if isinstance(self.file, SimulatorModelDependencyFileReference)
398398
else self.file
399399
)
400400
return output
401401

402402
@classmethod
403403
def _load_list(
404404
cls, resource: list[dict[str, Any]], cognite_client: CogniteClient | None = None
405-
) -> list[SimulatorModelRevisionExternalDependency]:
405+
) -> list[SimulatorModelRevisionDependency]:
406406
return [cls._load(item, cognite_client) for item in resource]

‎tests/tests_integration/test_api/test_simulators/conftest.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from cognite.client._cognite_client import CogniteClient
1212
from cognite.client.data_classes.data_sets import DataSetWrite
1313
from cognite.client.data_classes.files import FileMetadata
14-
from cognite.client.data_classes.simulators.models import SimulatorModelWrite
14+
from cognite.client.data_classes.simulators import SimulatorModelWrite
1515
from cognite.client.data_classes.simulators.routine_revisions import SimulatorRoutineRevisionWrite
1616
from cognite.client.data_classes.simulators.routines import SimulatorRoutineWrite
1717
from tests.tests_integration.test_api.test_simulators.seed.data import (

‎tests/tests_integration/test_api/test_simulators/test_models.py‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
from cognite.client._cognite_client import CogniteClient
66
from cognite.client.data_classes import TimestampRange
77
from cognite.client.data_classes.files import FileMetadata
8-
from cognite.client.data_classes.simulators.filters import PropertySort
9-
from cognite.client.data_classes.simulators.models import (
10-
SimulatorExternalDependencyFileInternalId,
11-
SimulatorModelRevisionExternalDependency,
8+
from cognite.client.data_classes.simulators import (
9+
SimulatorModelDependencyFileId,
10+
SimulatorModelRevisionDependency,
1211
SimulatorModelRevisionWrite,
1312
SimulatorModelWrite,
1413
)
14+
from cognite.client.data_classes.simulators.filters import PropertySort
1515
from cognite.client.utils._text import random_string
1616
from tests.tests_integration.test_api.test_simulators.conftest import upload_file
1717
from tests.tests_integration.test_api.test_simulators.seed.data import ResourceNames
@@ -231,8 +231,8 @@ def test_create_model_and_revisions_with_external_dependencies(
231231
)
232232

233233
external_dependencies = [
234-
SimulatorModelRevisionExternalDependency(
235-
file=SimulatorExternalDependencyFileInternalId(id=seed_external_dependency_file.id),
234+
SimulatorModelRevisionDependency(
235+
file=SimulatorModelDependencyFileId(id=seed_external_dependency_file.id),
236236
arguments={
237237
"fieldA": "value1",
238238
"fieldB": "value2",
@@ -251,9 +251,7 @@ def test_create_model_and_revisions_with_external_dependencies(
251251

252252
assert model_revision_created is not None
253253
assert model_revision_created.external_id == model_revision_external_id
254-
assert isinstance(
255-
model_revision_created.external_dependencies[0].file, SimulatorExternalDependencyFileInternalId
256-
)
254+
assert isinstance(model_revision_created.external_dependencies[0].file, SimulatorModelDependencyFileId)
257255
assert model_revision_created.external_dependencies[0].file.id == external_dependencies[0].file.id
258256
finally:
259257
cognite_client.simulators.models.delete(external_ids=[model_external_id])

‎tests/tests_unit/test_data_classes/test_simulators.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import pytest
22

33
from cognite.client.data_classes.simulators.models import (
4-
SimulatorExternalDependencyFileInternalId,
5-
SimulatorModelRevisionExternalDependency,
4+
SimulatorModelDependencyFileId,
5+
SimulatorModelRevisionDependency,
66
)
77

88

9-
class TestSimulatorModelRevisionExternalDependency:
9+
class TestSimulatorModelRevisionDependency:
1010
@pytest.mark.parametrize(
1111
["input_data"],
1212
[
@@ -19,12 +19,12 @@ class TestSimulatorModelRevisionExternalDependency:
1919
],
2020
)
2121
def test_load_list(self, input_data):
22-
result = SimulatorModelRevisionExternalDependency._load_list(input_data)
22+
result = SimulatorModelRevisionDependency._load_list(input_data)
2323
assert isinstance(result, list)
24-
assert all(isinstance(item, SimulatorModelRevisionExternalDependency) for item in result)
24+
assert all(isinstance(item, SimulatorModelRevisionDependency) for item in result)
2525
assert len(result) == 2
26-
assert isinstance(result[0].file, SimulatorExternalDependencyFileInternalId)
26+
assert isinstance(result[0].file, SimulatorModelDependencyFileId)
2727
assert result[0].file.id == 1111
2828
assert result[0].arguments == {"fieldA": "valueA"}
29-
assert isinstance(result[0].file, SimulatorExternalDependencyFileInternalId)
29+
assert isinstance(result[0].file, SimulatorModelDependencyFileId)
3030
assert result[1].file.id == 2222

0 commit comments

Comments
 (0)