Move transcoding constant/utils back to pipeline (#3826)

Signed-off-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
kedro-org · May 21, 2024 · 8eff357 · 8eff357
1 parent 3ac8b52
commit 8eff357
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 10 deletions.
diff --git a/kedro/framework/context/context.py b/kedro/framework/context/context.py
@@ -15,7 +15,7 @@
 from kedro.config import AbstractConfigLoader, MissingConfigException
 from kedro.framework.project import settings
 from kedro.io import DataCatalog
-from kedro.pipeline._transcoding import _transcode_split
+from kedro.pipeline.transcoding import _transcode_split
 
 
 def _is_relative_path(path_string: str) -> bool:

diff --git a/kedro/pipeline/modular_pipeline.py b/kedro/pipeline/modular_pipeline.py
@@ -8,7 +8,7 @@
 from kedro.pipeline.node import Node
 from kedro.pipeline.pipeline import Pipeline
 
-from ._transcoding import TRANSCODING_SEPARATOR, _strip_transcoding, _transcode_split
+from .transcoding import TRANSCODING_SEPARATOR, _strip_transcoding, _transcode_split
 
 
 class ModularPipelineError(Exception):
@@ -223,7 +223,6 @@ def pipeline(  # noqa: PLR0913
     if not any([inputs, outputs, parameters, namespace]):
         return pipe
 
-    # noqa: protected-access
     inputs = _get_dataset_names_mapping(inputs)
     outputs = _get_dataset_names_mapping(outputs)
     parameters = _get_param_names_mapping(parameters)

diff --git a/kedro/pipeline/node.py b/kedro/pipeline/node.py
@@ -13,7 +13,7 @@
 
 from more_itertools import spy, unzip
 
-from ._transcoding import _strip_transcoding
+from .transcoding import _strip_transcoding
 
 
 class Node:

diff --git a/kedro/pipeline/pipeline.py b/kedro/pipeline/pipeline.py
@@ -15,10 +15,23 @@
 import kedro
 from kedro.pipeline.node import Node, _to_list
 
-from ._transcoding import (
-    TRANSCODING_SEPARATOR,  # noqa: F401 for 0.19.x backward compatibility
-    _strip_transcoding,
-)
+from .transcoding import _strip_transcoding
+
+
+def __getattr__(name: str) -> Any:
+    if name == "TRANSCODING_SEPARATOR":
+        import warnings
+
+        from kedro.pipeline.transcoding import TRANSCODING_SEPARATOR
+
+        warnings.warn(
+            f"{repr(name)} has been moved to 'kedro.pipeline.transcoding', "
+            f"and the alias will be removed in Kedro 0.20.0",
+            kedro.KedroDeprecationWarning,
+            stacklevel=2,
+        )
+        return TRANSCODING_SEPARATOR
+    raise AttributeError(f"module {repr(__name__)} has no attribute {repr(name)}")
 
 
 class OutputNotUniqueError(Exception):

diff --git a/kedro/pipeline/_transcoding.py → kedro/pipeline/transcoding.py b/kedro/pipeline/_transcoding.py → kedro/pipeline/transcoding.py
diff --git a/tests/pipeline/test_pipeline.py b/tests/pipeline/test_pipeline.py
@@ -4,14 +4,22 @@
 import pytest
 
 import kedro
+from kedro import KedroDeprecationWarning
 from kedro.pipeline import node
-from kedro.pipeline._transcoding import _strip_transcoding, _transcode_split
 from kedro.pipeline.modular_pipeline import pipeline as modular_pipeline
 from kedro.pipeline.pipeline import (
     CircularDependencyError,
     ConfirmNotUniqueError,
     OutputNotUniqueError,
 )
+from kedro.pipeline.transcoding import _strip_transcoding, _transcode_split
+
+
+def test_deprecation():
+    with pytest.warns(
+        KedroDeprecationWarning, match="'TRANSCODING_SEPARATOR' has been moved"
+    ):
+        from kedro.pipeline.pipeline import TRANSCODING_SEPARATOR  # noqa: F401
 
 
 class TestTranscodeHelpers:

diff --git a/tests/pipeline/test_pipeline_with_transcoding.py b/tests/pipeline/test_pipeline_with_transcoding.py
@@ -4,12 +4,12 @@
 
 import kedro
 from kedro.pipeline import node
-from kedro.pipeline._transcoding import _strip_transcoding
 from kedro.pipeline.modular_pipeline import pipeline as modular_pipeline
 from kedro.pipeline.pipeline import (
     CircularDependencyError,
     OutputNotUniqueError,
 )
+from kedro.pipeline.transcoding import _strip_transcoding
 
 
 # Different dummy func based on the number of arguments