mobuchowski commented on code in PR #40335:
URL: https://github.com/apache/airflow/pull/40335#discussion_r1665447888
##########
airflow/providers_manager.py:
##########
@@ -1289,11 +1312,21 @@ def filesystem_module_names(self) -> list[str]:
self.initialize_providers_filesystems()
return sorted(self._fs_set)
+ @property
+ def dataset_factories(self) -> dict[str, Callable[..., Dataset]]:
Review Comment:
I think introducing mechanism as such requires at least single
implementation (maybe even test one?) to properly show how would it affect
providers.
##########
airflow/lineage/hook.py:
##########
@@ -0,0 +1,140 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from __future__ import annotations
+
+from typing import Union
+
+import attr
+
+from airflow.datasets import Dataset, create_dataset
+from airflow.hooks.base import BaseHook
+from airflow.io.store import ObjectStore
+from airflow.providers_manager import ProvidersManager
+from airflow.utils.log.logging_mixin import LoggingMixin
+
+# Store context what sent lineage.
+LineageContext = Union[BaseHook, ObjectStore]
+
+_hook_lineage_collector: HookLineageCollector | None = None
+
+
+@attr.define
+class HookLineage:
+ """Holds lineage collected by HookLineageCollector."""
+
+ inputs: list[tuple[Dataset, LineageContext]] = attr.ib(factory=list)
+ outputs: list[tuple[Dataset, LineageContext]] = attr.ib(factory=list)
+
+
+class HookLineageCollector(LoggingMixin):
+ """
+ HookLineageCollector is a base class for collecting hook lineage
information.
+
+ It is used to collect the input and output datasets of a hook execution.
+ """
+
+ def __init__(self, **kwargs):
+ super().__init__(**kwargs)
+ self.inputs: list[tuple[Dataset, LineageContext]] = []
+ self.outputs: list[tuple[Dataset, LineageContext]] = []
+
+ @staticmethod
+ def create_dataset(dataset_kwargs: dict) -> Dataset:
+ """Create a Dataset instance from the given dataset kwargs."""
+ if "uri" in dataset_kwargs:
+ # Fallback to default factory using the provided URI
+ return create_dataset(dataset_kwargs["uri"])
+
+ scheme: str = dataset_kwargs.pop("scheme", None)
+ if not scheme:
+ raise ValueError(
+ "Missing required parameter: either 'uri' or 'scheme' must be
provided to create a Dataset."
+ )
+
+ dataset_factory = ProvidersManager().dataset_factories.get(scheme)
+ if not dataset_factory:
+ raise ValueError(
+ f"Unsupported scheme: '{scheme}'. Please provide a valid URI
to create a Dataset."
+ )
+
+ return dataset_factory(**dataset_kwargs)
+
+ def add_input_dataset(self, dataset_kwargs: dict, hook: LineageContext):
+ """Add the input dataset and its corresponding hook execution context
to the collector."""
+ dataset = self.create_dataset(dataset_kwargs)
+ self.inputs.append((dataset, hook))
+
+ def add_output_dataset(self, dataset_kwargs: dict, hook: LineageContext):
+ """Add the output dataset and its corresponding hook execution context
to the collector."""
+ dataset = self.create_dataset(dataset_kwargs)
+ self.outputs.append((dataset, hook))
+
+ @property
+ def collected_datasets(self) -> HookLineage:
+ """Get the collected hook lineage information."""
+ return HookLineage(self.inputs, self.outputs)
+
+ @property
+ def has_collected(self) -> bool:
+ """Check if any datasets have been collected."""
+ return len(self.inputs) != 0 or len(self.outputs) != 0
+
+
+class NoOpCollector(HookLineageCollector):
+ """
+ NoOpCollector is a hook lineage collector that does nothing.
+
+ It is used when you want to disable lineage collection.
+ """
+
+ def add_input_dataset(self, *_):
+ pass
+
+ def add_output_dataset(self, *_):
+ pass
+
+ @property
+ def collected_datasets(
+ self,
+ ) -> HookLineage:
+ self.log.warning("You should not call this as there's no reader.")
+ return HookLineage([], [])
+
+
+class HookLineageReader(LoggingMixin):
+ """Class used to retrieve the hook lineage information collected by
HookLineageCollector."""
+
+ def __init__(self, **kwargs):
+ self.lineage_collector = get_hook_lineage_collector()
+
+ def retrieve_hook_lineage(self) -> HookLineage:
+ """Retrieve hook lineage from HookLineageCollector."""
+ hook_lineage = self.lineage_collector.collected_datasets
+ return hook_lineage
+
+
+def get_hook_lineage_collector() -> HookLineageCollector:
+ """Get singleton lineage collector."""
+ global _hook_lineage_collector
+ if not _hook_lineage_collector:
+ # is there a better why how to use noop?
+ if ProvidersManager().hook_lineage_readers:
Review Comment:
I think it's fine - setup on first use.
##########
airflow/lineage/hook.py:
##########
@@ -0,0 +1,140 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from __future__ import annotations
+
+from typing import Union
+
+import attr
+
+from airflow.datasets import Dataset, create_dataset
+from airflow.hooks.base import BaseHook
+from airflow.io.store import ObjectStore
+from airflow.providers_manager import ProvidersManager
+from airflow.utils.log.logging_mixin import LoggingMixin
+
+# Store context what sent lineage.
+LineageContext = Union[BaseHook, ObjectStore]
+
+_hook_lineage_collector: HookLineageCollector | None = None
+
+
+@attr.define
+class HookLineage:
+ """Holds lineage collected by HookLineageCollector."""
+
+ inputs: list[tuple[Dataset, LineageContext]] = attr.ib(factory=list)
+ outputs: list[tuple[Dataset, LineageContext]] = attr.ib(factory=list)
+
+
+class HookLineageCollector(LoggingMixin):
+ """
+ HookLineageCollector is a base class for collecting hook lineage
information.
+
+ It is used to collect the input and output datasets of a hook execution.
+ """
+
+ def __init__(self, **kwargs):
+ super().__init__(**kwargs)
+ self.inputs: list[tuple[Dataset, LineageContext]] = []
+ self.outputs: list[tuple[Dataset, LineageContext]] = []
+
+ @staticmethod
+ def create_dataset(dataset_kwargs: dict) -> Dataset:
+ """Create a Dataset instance from the given dataset kwargs."""
+ if "uri" in dataset_kwargs:
+ # Fallback to default factory using the provided URI
+ return create_dataset(dataset_kwargs["uri"])
+
+ scheme: str = dataset_kwargs.pop("scheme", None)
+ if not scheme:
+ raise ValueError(
+ "Missing required parameter: either 'uri' or 'scheme' must be
provided to create a Dataset."
+ )
+
+ dataset_factory = ProvidersManager().dataset_factories.get(scheme)
+ if not dataset_factory:
+ raise ValueError(
+ f"Unsupported scheme: '{scheme}'. Please provide a valid URI
to create a Dataset."
+ )
+
+ return dataset_factory(**dataset_kwargs)
+
+ def add_input_dataset(self, dataset_kwargs: dict, hook: LineageContext):
+ """Add the input dataset and its corresponding hook execution context
to the collector."""
+ dataset = self.create_dataset(dataset_kwargs)
+ self.inputs.append((dataset, hook))
+
+ def add_output_dataset(self, dataset_kwargs: dict, hook: LineageContext):
+ """Add the output dataset and its corresponding hook execution context
to the collector."""
+ dataset = self.create_dataset(dataset_kwargs)
+ self.outputs.append((dataset, hook))
+
+ @property
+ def collected_datasets(self) -> HookLineage:
+ """Get the collected hook lineage information."""
+ return HookLineage(self.inputs, self.outputs)
+
+ @property
+ def has_collected(self) -> bool:
+ """Check if any datasets have been collected."""
+ return len(self.inputs) != 0 or len(self.outputs) != 0
+
+
+class NoOpCollector(HookLineageCollector):
+ """
+ NoOpCollector is a hook lineage collector that does nothing.
+
+ It is used when you want to disable lineage collection.
+ """
+
+ def add_input_dataset(self, *_):
+ pass
+
+ def add_output_dataset(self, *_):
+ pass
+
+ @property
+ def collected_datasets(
+ self,
+ ) -> HookLineage:
+ self.log.warning("You should not call this as there's no reader.")
Review Comment:
I guess this message should be more descriptive :)
Maybe
```
collected_datasets called on NoOpCollector - hook level lineage was not
collected because nothing registered as hook lineage reader
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
