cognite-neat 0.120.0__py3-none-any.whl → 0.121.0__py3-none-any.whl

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.120.0"
+__version__ = "0.121.0"
 __engine__ = "^2.0.4"

cognite/neat/core/_graph/extractors/_classic_cdf/_files.py

@@ -20,7 +20,7 @@ class FilesExtractor(ClassicCDFBaseExtractor[FileMetadata]):
         data_set_external_id: str,
     ) -> tuple[int | None, Iterable[FileMetadata]]:
         items = client.files(data_set_external_ids=data_set_external_id)
-        return None, items
+        return None, cls._filter_out_instance_id(items)
 
     @classmethod
     def _from_hierarchy(
@@ -30,9 +30,16 @@ class FilesExtractor(ClassicCDFBaseExtractor[FileMetadata]):
             filter=FileMetadataFilter(asset_subtree_ids=[{"externalId": root_asset_external_id}])
         )[0].count
         items = client.files(asset_subtree_external_ids=root_asset_external_id)
-        return total, items
+        return total, cls._filter_out_instance_id(items)
 
     @classmethod
     def _from_file(cls, file_path: str | Path) -> tuple[int | None, Iterable[FileMetadata]]:
         file_metadata = FileMetadataList.load(Path(file_path).read_text())
-        return len(file_metadata), file_metadata
+        return len(file_metadata), cls._filter_out_instance_id(file_metadata)
+
+    @classmethod
+    def _filter_out_instance_id(cls, items: Iterable[FileMetadata]) -> Iterable[FileMetadata]:
+        """Filter out TimeSeries with InstanceId."""
+        # If the InstanceId is not None, it means that the TimeSeries is already connected to CogniteTimeSeries in DMS.
+        # We do not want to download it again.
+        return (item for item in items if item.instance_id is None)

cognite/neat/session/_read.py

@@ -468,6 +468,63 @@ class CDFClassicAPI(BaseReadAPI):
 
         return extract_issues
 
+    def file_metadata(self, data_set_external_id: str, identifier: Literal["id", "externalId"] = "id") -> IssueList:
+        """Read the file metadata from CDF into NEAT.
+
+        Note all files that have InstanceId set will be silently skipped. This method is for extracting
+        non-contextualized file medata only. If you want to include the potential connection from file metadata
+        to assets, use the `neat.read.cdf.graph()` method instead and select the asset hierarchy connected to this file.
+
+        Args:
+            data_set_external_id: The external id of the data set
+            identifier: The identifier to use for the file metadata. Note selecting "id" can cause issues
+                if the external ID of the file metadata is missing. Default is "id".
+
+        Returns:
+            IssueList: A list of issues that occurred during the extraction.
+
+        Example:
+            ```python
+            neat.read.cdf.time_series("data_set_external_id")
+            ```
+        """
+        namespace = CLASSIC_CDF_NAMESPACE
+        self._state._raise_exception_if_condition_not_met(
+            "Read time series",
+            empty_rules_store_required=True,
+            empty_instances_store_required=True,
+            client_required=True,
+        )
+        extractor = extractors.FilesExtractor.from_dataset(
+            cast(NeatClient, self._state.client),
+            data_set_external_id=data_set_external_id,
+            namespace=namespace,
+            identifier=identifier,
+            prefix="Classic",
+            skip_connections=True,
+        )
+        self._state.instances.neat_prefix_by_predicate_uri.update(
+            {
+                namespace["dataSetId"]: InstanceIdPrefix.data_set,
+                namespace["assetId"]: InstanceIdPrefix.asset,
+            }
+        )
+        self._state.instances.neat_prefix_by_type_uri.update(
+            {namespace[f"Classic{extractor._default_rdf_type}"]: InstanceIdPrefix.time_series}
+        )
+        extract_issues = self._state.instances.store.write(extractor)
+
+        if identifier == "externalId":
+            self._state.quoted_source_identifiers = True
+
+        self._state.instances.store.transform(
+            LiteralToEntity(None, namespace["source"], "ClassicSourceSystem", "name"),
+        )
+        # The above transformations creates a new type, so we need to update
+        self._state.instances.neat_prefix_by_type_uri.update({namespace["ClassicSourceSystem"]: "ClassicSourceSystem_"})
+
+        return extract_issues
+
 
 @session_class_wrapper
 class ExcelReadAPI(BaseReadAPI):

{cognite_neat-0.120.0.dist-info → cognite_neat-0.121.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite-neat
-Version: 0.120.0
+Version: 0.121.0
 Summary: Knowledge graph transformation
 Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
 Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/

{cognite_neat-0.120.0.dist-info → cognite_neat-0.121.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 cognite/neat/__init__.py,sha256=12StS1dzH9_MElqxGvLWrNsxCJl9Hv8A2a9D0E5OD_U,193
-cognite/neat/_version.py,sha256=p3YU5iJPd4gFVbBY5PpkBA9SgSwq0ABBEatMDUQxTN8,46
+cognite/neat/_version.py,sha256=xJwEparSzjV7HbmKhGalETztG6Tt0qxJf_4jvRe15wA,46
 cognite/neat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cognite/neat/core/_config.py,sha256=WT1BS8uADcFvGoUYOOfwFOVq_VBl472TisdoA3wLick,280
@@ -39,7 +39,7 @@ cognite/neat/core/_graph/extractors/_classic_cdf/_base.py,sha256=IJkdrKhUOfofPa1
 cognite/neat/core/_graph/extractors/_classic_cdf/_classic.py,sha256=bYzTTcjDWgBc7frY-q9cy6Nz8hKSXIex-6nfEv_m_a8,24272
 cognite/neat/core/_graph/extractors/_classic_cdf/_data_sets.py,sha256=xRFv9pVFgIMTZ45E8teMC0Ynku_CuZdcZkVCbhPuPBk,1294
 cognite/neat/core/_graph/extractors/_classic_cdf/_events.py,sha256=B8hRoMAg8GQvApjxals5PfPyjmdPO93U3nj_G7g0kDQ,1394
-cognite/neat/core/_graph/extractors/_classic_cdf/_files.py,sha256=Q816cVQ9qS7Art66HJfErL2OV7MxH_eSIG7bJ8_HJ7Q,1406
+cognite/neat/core/_graph/extractors/_classic_cdf/_files.py,sha256=9lIleYyM3r0_CHteTEWboyknBeHYNtvgpNJuvS9UUU0,1894
 cognite/neat/core/_graph/extractors/_classic_cdf/_labels.py,sha256=7guTZdGFT1r7ItE2VNgXwbBZ1y_005oB3fg1XbwT7WQ,2083
 cognite/neat/core/_graph/extractors/_classic_cdf/_relationships.py,sha256=kNzrqHQuIZMBecZ8957Qs3-Pp2m2-k2CCfiUZlVwaD0,5395
 cognite/neat/core/_graph/extractors/_classic_cdf/_sequences.py,sha256=zwHM52afnq-JHvLOTi4rH6DyfkTftxH6cmODwoZi8uw,11399
@@ -167,7 +167,7 @@ cognite/neat/session/_fix.py,sha256=OJ6xE6Icfdh9pO-ObnlGt-7nwbVVS_nC2fyFoHCDhjg,
 cognite/neat/session/_inspect.py,sha256=Wual0vgetcIOje7IlTE0y-aM43Ydwf4WEr2LjbbBRZA,10116
 cognite/neat/session/_mapping.py,sha256=sRSxrTq_ksUwt9NMgGDNXp5jd9U5ZXxYVZtpjrCBr1c,2670
 cognite/neat/session/_prepare.py,sha256=s3sERSmdEHru80zO2W7CLrz7h9HuGVKubF7KNWK74qo,12742
-cognite/neat/session/_read.py,sha256=kyjCW5AKrstDu7eQ9TVH8fxvXK1Z_v7oTw49B7AMjHk,32471
+cognite/neat/session/_read.py,sha256=otmmTZFH_Cq5SI_ns3pXEJezzzRvwPRVyfjNSJjQkLE,34999
 cognite/neat/session/_set.py,sha256=p6uo3LUUm5XpkotXTfeoVdlETfSVNGBauTKLqa4jW_M,4518
 cognite/neat/session/_show.py,sha256=Psu94RoAaSZ6KyzXFKNHYeOhHjGwz8c3u314X75-oR0,10565
 cognite/neat/session/_state.py,sha256=8yLenza6rcvk1q2hY5mI1-OXfjocoEOHLBRyz23-Lbw,6353
@@ -181,7 +181,7 @@ cognite/neat/session/engine/__init__.py,sha256=D3MxUorEs6-NtgoICqtZ8PISQrjrr4dvc
 cognite/neat/session/engine/_import.py,sha256=1QxA2_EK613lXYAHKQbZyw2yjo5P9XuiX4Z6_6-WMNQ,169
 cognite/neat/session/engine/_interface.py,sha256=3W-cYr493c_mW3P5O6MKN1xEQg3cA7NHR_ev3zdF9Vk,533
 cognite/neat/session/engine/_load.py,sha256=g52uYakQM03VqHt_RDHtpHso1-mFFifH5M4T2ScuH8A,5198
-cognite_neat-0.120.0.dist-info/METADATA,sha256=-ETTM2ywIAhV2IgTB5h3tCxbn4LlBqXVwe51krcOr1o,7608
-cognite_neat-0.120.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cognite_neat-0.120.0.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
-cognite_neat-0.120.0.dist-info/RECORD,,
+cognite_neat-0.121.0.dist-info/METADATA,sha256=kVGUUswt8v2KCpVbTcSLM3Dw1--dcl1vzHyMP3oNl2s,7608
+cognite_neat-0.121.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cognite_neat-0.121.0.dist-info/licenses/LICENSE,sha256=W8VmvFia4WHa3Gqxq1Ygrq85McUNqIGDVgtdvzT-XqA,11351
+cognite_neat-0.121.0.dist-info/RECORD,,