Add DataCatalog deprecation warning (#4510)

* Added deprecation warnign Signed-off-by: Elena Khaustova <[email protected]> * Fixed typo Signed-off-by: Elena Khaustova <[email protected]> * Updated release notes Signed-off-by: Elena Khaustova <[email protected]> * Updated deprecation warning Signed-off-by: Elena Khaustova <[email protected]> * Updated broken link Signed-off-by: Elena Khaustova <[email protected]> --------- Signed-off-by: Elena Khaustova <[email protected]>
kedro-org · Mar 6, 2025 · 3708823 · 3708823
1 parent 9ec67a3
commit 3708823
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/RELEASE.md b/RELEASE.md
@@ -5,6 +5,7 @@
 * Added `Pipeline.grouped_nodes_by_namespace` property which returns a dictionary of nodes grouped by namespace, intended to be used by plugins to facilitate deployment of namespaced nodes together.
 
 ## Bug fixes and other changes
+* Added `DataCatalog` deprecation warning.
 * Updated `_LazyDataset` representation when printing `KedroDataCatalog`.
 * Fixed `MemoryDataset` to infer `assign` copy mode for Ibis Tables, which previously would be inferred as `deepcopy`.
 * Fixed pipeline packaging issue by ensuring `pipelines/__init__.py` exists when creating new pipelines.

diff --git a/docs/source/integrations/mlflow.md b/docs/source/integrations/mlflow.md
@@ -38,7 +38,7 @@ to a local directory called `mlflow_runs`.
 :::{note}
 If you want to use a more sophisticated setup,
 have a look at the documentation of
-[MLflow tracking server](https://mlflow.org/docs/latest/tracking/server.html),
+[MLflow tracking server](https://mlflow.org/docs/latest/tracking/server),
 {external+mlflow:doc}`the official MLflow tracking server 5 minute overview <getting-started/tracking-server-overview/index>`,
 and {external+mlflow:ref}`the MLflow tracking server documentation <logging_to_a_tracking_server>`.
 :::

diff --git a/kedro/io/data_catalog.py b/kedro/io/data_catalog.py
@@ -11,8 +11,10 @@
 import logging
 import pprint
 import re
+import warnings
 from typing import Any
 
+from kedro import KedroDeprecationWarning
 from kedro.io.catalog_config_resolver import (
     CREDENTIALS_KEY,  # noqa: F401
     CatalogConfigResolver,
@@ -160,6 +162,15 @@ def __init__(  # noqa: PLR0913
             >>>                   save_args={"index": False})
             >>> catalog = DataCatalog(datasets={'cars': cars})
         """
+        warnings.warn(
+            "`DataCatalog` has been deprecated and will be replaced by `KedroDataCatalog`, in Kedro 1.0.0."
+            "Currently some `KedroDataCatalog` APIs have been retained for compatibility with `DataCatalog`, including "
+            "the `datasets` property and the `get_datasets`, `_get_datasets`, `add`,` list`, `add_feed_dict`, "
+            "and `shallow_copy` methods. These will be removed or replaced with updated alternatives in Kedro 1.0.0. "
+            "For more details, refer to the documentation: "
+            "https://docs.kedro.org/en/stable/data/index.html#kedrodatacatalog-experimental-feature",
+            KedroDeprecationWarning,
+        )
         self._config_resolver = config_resolver or CatalogConfigResolver()
         # Kept to avoid breaking changes
         if not config_resolver: