Add ability to filter on external ID for nodes even when no other fil…

…ter properties are present (#356) * Add ability to filter on external ID for nodes even when no other filter properties are present * Fix tests * Bump version and update changelog * Regenerate examples
cognitedata · Nov 15, 2024 · 0a28ef7 · 0a28ef7
1 parent eb738e6
commit 0a28ef7
Show file tree

Hide file tree

Showing 26 changed files with 67 additions and 18 deletions.
diff --git a/cognite/pygen/_core/templates/data_class_node.py.jinja b/cognite/pygen/_core/templates/data_class_node.py.jinja
@@ -577,9 +577,9 @@ class _{{ data_class.query_cls_name }}(NodeQueryCore[T_DomainModelList, {{ data_
                 connection_name="{{ field.name }}",{% if field.is_reverse_direct_relation and field.reverse_property.is_one_to_many %}
                 connection_type="reverse-list",{% endif %}
             ){% endif %}
-{% endfor %}{% if data_class.has_filtering_fields %}
+{% endfor %}
         self.space = StringFilter(self, ["node", "space"])
-        self.external_id = StringFilter(self, ["node", "externalId"]){% for field in data_class.filtering_fields %}
+        self.external_id = StringFilter(self, ["node", "externalId"]){% if data_class.has_filtering_fields %}{% for field in data_class.filtering_fields %}
         self.{{ field.name }} = {{ field.filtering_cls }}(self, self._view_id.as_property_ref("{{ field.prop_name }}")){% endfor %}
         self._filter_classes.extend([
             self.space,

diff --git a/cognite/pygen/_version.py b/cognite/pygen/_version.py
@@ -1 +1 @@
-__version__ = "0.99.48"
+__version__ = "0.99.49"
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -13,6 +13,10 @@ Changes are grouped as follows
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [0.99.48] - 24-11-14
+### Fixed
+- Add ability to filter on node external ID and space even when no other filterable properties are present.
+
 ## [0.99.48] - 24-11-13
 ### Changed
 - [Experimental feature] Generic query split into three methods `.list()`, `.search()`, and `.aggregate(...)`.

diff --git a/examples/cognite_core/_api_client.py b/examples/cognite_core/_api_client.py
@@ -50,7 +50,7 @@ class CogniteCoreClient:
     CogniteCoreClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -68,7 +68,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self._client = client
 

diff --git a/examples/cognite_core/data_classes/_cognite_cube_map.py b/examples/cognite_core/data_classes/_cognite_cube_map.py
@@ -698,6 +698,9 @@ def __init__(
                 connection_name="top",
             )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_cognite_cube_map(self, limit: int = DEFAULT_QUERY_LIMIT) -> CogniteCubeMapList:
         return self._list(limit=limit)
 

diff --git a/examples/cognite_core/data_classes/_cognite_visualizable.py b/examples/cognite_core/data_classes/_cognite_visualizable.py
@@ -382,6 +382,9 @@ def __init__(
                 connection_name="object_3d",
             )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_cognite_visualizable(self, limit: int = DEFAULT_QUERY_LIMIT) -> CogniteVisualizableList:
         return self._list(limit=limit)
 

diff --git a/examples/equipment_unit/_api_client.py b/examples/equipment_unit/_api_client.py
@@ -23,7 +23,7 @@ class EquipmentUnitClient:
     EquipmentUnitClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -41,7 +41,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self._client = client
 

diff --git a/examples/omni/_api_client.py b/examples/omni/_api_client.py
@@ -41,7 +41,7 @@ class OmniClient:
     OmniClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -59,7 +59,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self._client = client
 

diff --git a/examples/omni/data_classes/_cdf_external_references.py b/examples/omni/data_classes/_cdf_external_references.py
@@ -349,6 +349,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_cdf_external_reference(self, limit: int = DEFAULT_QUERY_LIMIT) -> CDFExternalReferencesList:
         return self._list(limit=limit)
 

diff --git a/examples/omni/data_classes/_cdf_external_references_listed.py b/examples/omni/data_classes/_cdf_external_references_listed.py
@@ -386,6 +386,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_cdf_external_references_listed(self, limit: int = DEFAULT_QUERY_LIMIT) -> CDFExternalReferencesListedList:
         return self._list(limit=limit)
 

diff --git a/examples/omni/data_classes/_connection_item_c_node.py b/examples/omni/data_classes/_connection_item_c_node.py
@@ -479,6 +479,9 @@ def __init__(
                 connection_name="connection_item_b",
             )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_connection_item_c_node(self, limit: int = DEFAULT_QUERY_LIMIT) -> ConnectionItemCNodeList:
         return self._list(limit=limit)
 

diff --git a/examples/omni/data_classes/_primitive_nullable_listed.py b/examples/omni/data_classes/_primitive_nullable_listed.py
@@ -399,6 +399,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_primitive_nullable_listed(self, limit: int = DEFAULT_QUERY_LIMIT) -> PrimitiveNullableListedList:
         return self._list(limit=limit)
 

diff --git a/examples/omni/data_classes/_primitive_required_listed.py b/examples/omni/data_classes/_primitive_required_listed.py
@@ -399,6 +399,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_primitive_required_listed(self, limit: int = DEFAULT_QUERY_LIMIT) -> PrimitiveRequiredListedList:
         return self._list(limit=limit)
 

diff --git a/examples/omni_multi/_api_client.py b/examples/omni_multi/_api_client.py
@@ -111,7 +111,7 @@ class OmniMultiClient:
     OmniMultiClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -125,7 +125,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self.omni_multi_a = OmniMultiAAPIs(client)
         self.omni_multi_b = OmniMultiBAPIs(client)

diff --git a/examples/omni_sub/_api_client.py b/examples/omni_sub/_api_client.py
@@ -23,7 +23,7 @@ class OmniSubClient:
     OmniSubClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -41,7 +41,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self._client = client
 

diff --git a/examples/omni_sub/data_classes/_connection_item_c_node.py b/examples/omni_sub/data_classes/_connection_item_c_node.py
@@ -474,6 +474,9 @@ def __init__(
                 connection_name="connection_item_b",
             )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_connection_item_c_node(self, limit: int = DEFAULT_QUERY_LIMIT) -> ConnectionItemCNodeList:
         return self._list(limit=limit)
 

diff --git a/examples/scenario_instance/client/_api_client.py b/examples/scenario_instance/client/_api_client.py
@@ -21,7 +21,7 @@ class ScenarioInstanceClient:
     ScenarioInstanceClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -39,7 +39,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self._client = client
 

diff --git a/examples/windmill/_api_client.py b/examples/windmill/_api_client.py
@@ -31,7 +31,7 @@ class WindmillClient:
     WindmillClient
 
     Generated with:
-        pygen = 0.99.48
+        pygen = 0.99.49
         cognite-sdk = 7.64.12
         pydantic = 2.9.2
 
@@ -49,7 +49,7 @@ def __init__(self, config_or_client: CogniteClient | ClientConfig):
         else:
             raise ValueError(f"Expected CogniteClient or ClientConfig, got {type(config_or_client)}")
         # The client name is used for aggregated logging of Pygen Usage
-        client.config.client_name = "CognitePygen:0.99.48"
+        client.config.client_name = "CognitePygen:0.99.49"
 
         self._client = client
 

diff --git a/examples/windmill/data_classes/_gearbox.py b/examples/windmill/data_classes/_gearbox.py
@@ -358,6 +358,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_gearbox(self, limit: int = DEFAULT_QUERY_LIMIT) -> GearboxList:
         return self._list(limit=limit)
 

diff --git a/examples/windmill/data_classes/_generator.py b/examples/windmill/data_classes/_generator.py
@@ -347,6 +347,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_generator(self, limit: int = DEFAULT_QUERY_LIMIT) -> GeneratorList:
         return self._list(limit=limit)
 

diff --git a/examples/windmill/data_classes/_high_speed_shaft.py b/examples/windmill/data_classes/_high_speed_shaft.py
@@ -352,6 +352,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_high_speed_shaft(self, limit: int = DEFAULT_QUERY_LIMIT) -> HighSpeedShaftList:
         return self._list(limit=limit)
 

diff --git a/examples/windmill/data_classes/_main_shaft.py b/examples/windmill/data_classes/_main_shaft.py
@@ -396,6 +396,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_main_shaft(self, limit: int = DEFAULT_QUERY_LIMIT) -> MainShaftList:
         return self._list(limit=limit)
 

diff --git a/examples/windmill/data_classes/_nacelle.py b/examples/windmill/data_classes/_nacelle.py
@@ -858,6 +858,9 @@ def __init__(
                 connection_name="power_inverter",
             )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_nacelle(self, limit: int = DEFAULT_QUERY_LIMIT) -> NacelleList:
         return self._list(limit=limit)
 

diff --git a/examples/windmill/data_classes/_power_inverter.py b/examples/windmill/data_classes/_power_inverter.py
@@ -358,6 +358,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_power_inverter(self, limit: int = DEFAULT_QUERY_LIMIT) -> PowerInverterList:
         return self._list(limit=limit)
 

diff --git a/examples/windmill/data_classes/_rotor.py b/examples/windmill/data_classes/_rotor.py
@@ -334,6 +334,9 @@ def __init__(
             reverse_expression,
         )
 
+        self.space = StringFilter(self, ["node", "space"])
+        self.external_id = StringFilter(self, ["node", "externalId"])
+
     def list_rotor(self, limit: int = DEFAULT_QUERY_LIMIT) -> RotorList:
         return self._list(limit=limit)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cognite-pygen"
-version = "0.99.48"
+version = "0.99.49"
 description = "Cognite Python SDK Generator"
 readme = "README.md"
 authors = ["Cognite <[email protected]>"]