Skip to content

Commit

Permalink
Redirect old location module imports to standard provider (apache#43610)
Browse files Browse the repository at this point in the history

---------

Co-authored-by: Amogh Desai <[email protected]>
  • Loading branch information
2 people authored and sunank200 committed Nov 12, 2024
1 parent d42ecc7 commit e5260fc
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 0 deletions.
38 changes: 38 additions & 0 deletions airflow/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import os
import sys
import warnings
from importlib.abc import MetaPathFinder
from typing import TYPE_CHECKING

if os.environ.get("_AIRFLOW_PATCH_GEVENT"):
Expand Down Expand Up @@ -133,3 +134,40 @@ def __getattr__(name: str):
from airflow import plugins_manager

plugins_manager.ensure_plugins_loaded()


class ModuleRedirectFinder(MetaPathFinder):
def __init__(self, redirects: dict[str, str]):
self.redirects: dict[str, str] = redirects

def find_spec(self, old_module: str, path, target=None):
import importlib

if old_module in self.redirects:
new_module_name = self.redirects[old_module]
warnings.warn(
f"Module '{old_module}' is deprecated, Please import it from '{new_module_name}'.",
DeprecationWarning,
stacklevel=2,
)
return importlib.util.find_spec(new_module_name)
return None


module_redirects_references: dict[str, str] = {
"airflow.operators.python": "airflow.providers.standard.operators.python",
"airflow.operators.bash": "airflow.providers.standard.operators.bash",
"airflow.operators.datetime": "airflow.providers.standard.operators.datetime",
"airflow.operators.weekday": "airflow.providers.standard.operators.weekday",
"airflow.sensors.bash": "airflow.providers.standard.sensors.bash",
"airflow.sensors.date_time": "airflow.providers.standard.sensors.date_time",
"airflow.sensors.python": "airflow.providers.standard.sensors.python",
"airflow.sensors.time": "airflow.providers.standard.sensors.time",
"airflow.sensors.time_delta": "airflow.providers.standard.sensors.time_delta",
"airflow.sensors.weekday": "airflow.providers.standard.sensors.weekday",
"airflow.hooks.filesystem": "airflow.providers.standard.hooks.filesystem",
"airflow.hooks.package_index": "airflow.providers.standard.hooks.package_index",
"airflow.hooks.subprocess": "airflow.providers.standard.hooks.subprocess",
"airflow.utils.python_virtualenv": "airflow.providers.standard.utils.python_virtualenv",
}
sys.meta_path.append(ModuleRedirectFinder(module_redirects_references))
51 changes: 51 additions & 0 deletions providers/tests/standard/test_module_redirect_finder.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 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

import importlib

import pytest

from tests_common.test_utils.compat import AIRFLOW_V_3_0_PLUS


@pytest.mark.skipif(not AIRFLOW_V_3_0_PLUS, reason="Valid for Airflow 3.0+ only")
class TestModuleRedirectFinder:
@pytest.mark.parametrize(
"old_module, new_module",
[
("airflow.operators.python", "airflow.providers.standard.operators.python"),
("airflow.operators.bash", "airflow.providers.standard.operators.bash"),
("airflow.operators.datetime", "airflow.providers.standard.operators.datetime"),
("airflow.operators.weekday", "airflow.providers.standard.operators.weekday"),
("airflow.sensors.bash", "airflow.providers.standard.sensors.bash"),
("airflow.sensors.date_time", "airflow.providers.standard.sensors.date_time"),
("airflow.sensors.python", "airflow.providers.standard.sensors.python"),
("airflow.sensors.time", "airflow.providers.standard.sensors.time"),
("airflow.sensors.time_delta", "airflow.providers.standard.sensors.time_delta"),
("airflow.sensors.weekday", "airflow.providers.standard.sensors.weekday"),
("airflow.hooks.filesystem", "airflow.providers.standard.hooks.filesystem"),
("airflow.hooks.package_index", "airflow.providers.standard.hooks.package_index"),
("airflow.hooks.subprocess", "airflow.providers.standard.hooks.subprocess"),
("airflow.utils.python_virtualenv", "airflow.providers.standard.utils.python_virtualenv"),
],
)
def test_module_redirect_finder_for_old_location(self, old_module, new_module):
try:
assert importlib.import_module(old_module).__name__ == new_module
except ImportError:
pytest.fail(f"Failed to import module, incorrect reference: {old_module} -> {new_module}")

0 comments on commit e5260fc

Please sign in to comment.