From b37467f901dcbb95fd3a1b1f19b3c5f7f9a0c87b Mon Sep 17 00:00:00 2001 From: Kaxil Naik Date: Tue, 15 Oct 2024 22:18:18 +0100 Subject: [PATCH] Rename views to routes for FastAPI apps This is part of the change I want to do for https://github.com/apache/airflow/pull/43015 but going to break it down to keep it manageable. --- airflow/api_fastapi/app.py | 4 ++-- airflow/api_fastapi/{views => routes}/__init__.py | 0 .../api_fastapi/{views => routes}/public/__init__.py | 12 ++++++------ .../{views => routes}/public/connections.py | 2 +- .../api_fastapi/{views => routes}/public/dag_run.py | 2 +- airflow/api_fastapi/{views => routes}/public/dags.py | 2 +- .../api_fastapi/{views => routes}/public/monitor.py | 2 +- .../{views => routes}/public/variables.py | 2 +- airflow/api_fastapi/{views => routes}/router.py | 0 airflow/api_fastapi/{views => routes}/ui/__init__.py | 6 +++--- airflow/api_fastapi/{views => routes}/ui/assets.py | 2 +- .../api_fastapi/{views => routes}/ui/dashboard.py | 2 +- tests/api_fastapi/{views => routes}/__init__.py | 0 .../api_fastapi/{views => routes}/public/__init__.py | 0 .../{views => routes}/public/test_connections.py | 0 .../{views => routes}/public/test_dag_run.py | 0 .../{views => routes}/public/test_dags.py | 4 ++-- .../{views => routes}/public/test_monitor.py | 0 .../{views => routes}/public/test_variables.py | 0 tests/api_fastapi/{views => routes}/ui/__init__.py | 0 .../api_fastapi/{views => routes}/ui/test_assets.py | 0 .../{views => routes}/ui/test_dashboard.py | 0 22 files changed, 20 insertions(+), 20 deletions(-) rename airflow/api_fastapi/{views => routes}/__init__.py (100%) rename airflow/api_fastapi/{views => routes}/public/__init__.py (72%) rename airflow/api_fastapi/{views => routes}/public/connections.py (98%) rename airflow/api_fastapi/{views => routes}/public/dag_run.py (97%) rename airflow/api_fastapi/{views => routes}/public/dags.py (99%) rename airflow/api_fastapi/{views => routes}/public/monitor.py (95%) rename airflow/api_fastapi/{views => routes}/public/variables.py (98%) rename airflow/api_fastapi/{views => routes}/router.py (100%) rename airflow/api_fastapi/{views => routes}/ui/__init__.py (83%) rename airflow/api_fastapi/{views => routes}/ui/assets.py (98%) rename airflow/api_fastapi/{views => routes}/ui/dashboard.py (98%) rename tests/api_fastapi/{views => routes}/__init__.py (100%) rename tests/api_fastapi/{views => routes}/public/__init__.py (100%) rename tests/api_fastapi/{views => routes}/public/test_connections.py (100%) rename tests/api_fastapi/{views => routes}/public/test_dag_run.py (100%) rename tests/api_fastapi/{views => routes}/public/test_dags.py (98%) rename tests/api_fastapi/{views => routes}/public/test_monitor.py (100%) rename tests/api_fastapi/{views => routes}/public/test_variables.py (100%) rename tests/api_fastapi/{views => routes}/ui/__init__.py (100%) rename tests/api_fastapi/{views => routes}/ui/test_assets.py (100%) rename tests/api_fastapi/{views => routes}/ui/test_dashboard.py (100%) diff --git a/airflow/api_fastapi/app.py b/airflow/api_fastapi/app.py index 42720847638a3..912b8496dd6e8 100644 --- a/airflow/api_fastapi/app.py +++ b/airflow/api_fastapi/app.py @@ -77,8 +77,8 @@ def create_app() -> FastAPI: def init_views(app: FastAPI) -> None: """Init views by registering the different routers.""" - from airflow.api_fastapi.views.public import public_router - from airflow.api_fastapi.views.ui import ui_router + from airflow.api_fastapi.routes.public import public_router + from airflow.api_fastapi.routes.ui import ui_router app.include_router(ui_router) app.include_router(public_router) diff --git a/airflow/api_fastapi/views/__init__.py b/airflow/api_fastapi/routes/__init__.py similarity index 100% rename from airflow/api_fastapi/views/__init__.py rename to airflow/api_fastapi/routes/__init__.py diff --git a/airflow/api_fastapi/views/public/__init__.py b/airflow/api_fastapi/routes/public/__init__.py similarity index 72% rename from airflow/api_fastapi/views/public/__init__.py rename to airflow/api_fastapi/routes/public/__init__.py index de0a0d0bb4a55..01a9b7f239621 100644 --- a/airflow/api_fastapi/views/public/__init__.py +++ b/airflow/api_fastapi/routes/public/__init__.py @@ -17,12 +17,12 @@ from __future__ import annotations -from airflow.api_fastapi.views.public.connections import connections_router -from airflow.api_fastapi.views.public.dag_run import dag_run_router -from airflow.api_fastapi.views.public.dags import dags_router -from airflow.api_fastapi.views.public.monitor import monitor_router -from airflow.api_fastapi.views.public.variables import variables_router -from airflow.api_fastapi.views.router import AirflowRouter +from airflow.api_fastapi.routes.public.connections import connections_router +from airflow.api_fastapi.routes.public.dag_run import dag_run_router +from airflow.api_fastapi.routes.public.dags import dags_router +from airflow.api_fastapi.routes.public.monitor import monitor_router +from airflow.api_fastapi.routes.public.variables import variables_router +from airflow.api_fastapi.routes.router import AirflowRouter public_router = AirflowRouter(prefix="/public") diff --git a/airflow/api_fastapi/views/public/connections.py b/airflow/api_fastapi/routes/public/connections.py similarity index 98% rename from airflow/api_fastapi/views/public/connections.py rename to airflow/api_fastapi/routes/public/connections.py index 6fca43aca26c7..76684835cf481 100644 --- a/airflow/api_fastapi/views/public/connections.py +++ b/airflow/api_fastapi/routes/public/connections.py @@ -24,8 +24,8 @@ from airflow.api_fastapi.db.common import get_session, paginated_select from airflow.api_fastapi.openapi.exceptions import create_openapi_http_exception_doc from airflow.api_fastapi.parameters import QueryLimit, QueryOffset, SortParam +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.api_fastapi.serializers.connections import ConnectionCollectionResponse, ConnectionResponse -from airflow.api_fastapi.views.router import AirflowRouter from airflow.models import Connection connections_router = AirflowRouter(tags=["Connection"], prefix="/connections") diff --git a/airflow/api_fastapi/views/public/dag_run.py b/airflow/api_fastapi/routes/public/dag_run.py similarity index 97% rename from airflow/api_fastapi/views/public/dag_run.py rename to airflow/api_fastapi/routes/public/dag_run.py index 2f44f03ea6103..62e4d97a829bf 100644 --- a/airflow/api_fastapi/views/public/dag_run.py +++ b/airflow/api_fastapi/routes/public/dag_run.py @@ -24,8 +24,8 @@ from airflow.api_fastapi.db.common import get_session from airflow.api_fastapi.openapi.exceptions import create_openapi_http_exception_doc +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.api_fastapi.serializers.dag_run import DAGRunResponse -from airflow.api_fastapi.views.router import AirflowRouter from airflow.models import DagRun dag_run_router = AirflowRouter(tags=["DagRun"], prefix="/dags/{dag_id}/dagRuns") diff --git a/airflow/api_fastapi/views/public/dags.py b/airflow/api_fastapi/routes/public/dags.py similarity index 99% rename from airflow/api_fastapi/views/public/dags.py rename to airflow/api_fastapi/routes/public/dags.py index 46d4d8b3540c0..d2b608e05176f 100644 --- a/airflow/api_fastapi/views/public/dags.py +++ b/airflow/api_fastapi/routes/public/dags.py @@ -42,13 +42,13 @@ QueryTagsFilter, SortParam, ) +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.api_fastapi.serializers.dags import ( DAGCollectionResponse, DAGDetailsResponse, DAGPatchBody, DAGResponse, ) -from airflow.api_fastapi.views.router import AirflowRouter from airflow.exceptions import AirflowException, DagNotFound from airflow.models import DAG, DagModel diff --git a/airflow/api_fastapi/views/public/monitor.py b/airflow/api_fastapi/routes/public/monitor.py similarity index 95% rename from airflow/api_fastapi/views/public/monitor.py rename to airflow/api_fastapi/routes/public/monitor.py index 07916f6e06d53..30e8f1330a58b 100644 --- a/airflow/api_fastapi/views/public/monitor.py +++ b/airflow/api_fastapi/routes/public/monitor.py @@ -18,8 +18,8 @@ from __future__ import annotations from airflow.api.common.airflow_health import get_airflow_health +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.api_fastapi.serializers.monitor import HealthInfoSchema -from airflow.api_fastapi.views.router import AirflowRouter monitor_router = AirflowRouter(tags=["Monitor"], prefix="/monitor") diff --git a/airflow/api_fastapi/views/public/variables.py b/airflow/api_fastapi/routes/public/variables.py similarity index 98% rename from airflow/api_fastapi/views/public/variables.py rename to airflow/api_fastapi/routes/public/variables.py index a61b9bb930023..61cd84c700453 100644 --- a/airflow/api_fastapi/views/public/variables.py +++ b/airflow/api_fastapi/routes/public/variables.py @@ -23,8 +23,8 @@ from airflow.api_fastapi.db.common import get_session from airflow.api_fastapi.openapi.exceptions import create_openapi_http_exception_doc +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.api_fastapi.serializers.variables import VariableBody, VariableResponse -from airflow.api_fastapi.views.router import AirflowRouter from airflow.models.variable import Variable variables_router = AirflowRouter(tags=["Variable"], prefix="/variables") diff --git a/airflow/api_fastapi/views/router.py b/airflow/api_fastapi/routes/router.py similarity index 100% rename from airflow/api_fastapi/views/router.py rename to airflow/api_fastapi/routes/router.py diff --git a/airflow/api_fastapi/views/ui/__init__.py b/airflow/api_fastapi/routes/ui/__init__.py similarity index 83% rename from airflow/api_fastapi/views/ui/__init__.py rename to airflow/api_fastapi/routes/ui/__init__.py index f01686cc99ee2..2087549c98ea0 100644 --- a/airflow/api_fastapi/views/ui/__init__.py +++ b/airflow/api_fastapi/routes/ui/__init__.py @@ -16,9 +16,9 @@ # under the License. from __future__ import annotations -from airflow.api_fastapi.views.router import AirflowRouter -from airflow.api_fastapi.views.ui.assets import assets_router -from airflow.api_fastapi.views.ui.dashboard import dashboard_router +from airflow.api_fastapi.routes.router import AirflowRouter +from airflow.api_fastapi.routes.ui.assets import assets_router +from airflow.api_fastapi.routes.ui.dashboard import dashboard_router ui_router = AirflowRouter(prefix="/ui") diff --git a/airflow/api_fastapi/views/ui/assets.py b/airflow/api_fastapi/routes/ui/assets.py similarity index 98% rename from airflow/api_fastapi/views/ui/assets.py rename to airflow/api_fastapi/routes/ui/assets.py index 1a198745f11f3..31406b1b94db1 100644 --- a/airflow/api_fastapi/views/ui/assets.py +++ b/airflow/api_fastapi/routes/ui/assets.py @@ -23,7 +23,7 @@ from typing_extensions import Annotated from airflow.api_fastapi.db.common import get_session -from airflow.api_fastapi.views.router import AirflowRouter +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.models import DagModel from airflow.models.asset import AssetDagRunQueue, AssetEvent, AssetModel, DagScheduleAssetReference diff --git a/airflow/api_fastapi/views/ui/dashboard.py b/airflow/api_fastapi/routes/ui/dashboard.py similarity index 98% rename from airflow/api_fastapi/views/ui/dashboard.py rename to airflow/api_fastapi/routes/ui/dashboard.py index 0d6b69a1ced5b..e7cec5fbf0ee1 100644 --- a/airflow/api_fastapi/views/ui/dashboard.py +++ b/airflow/api_fastapi/routes/ui/dashboard.py @@ -33,7 +33,7 @@ if TYPE_CHECKING: from sqlalchemy.orm import Session from airflow.api_fastapi.db.common import get_session -from airflow.api_fastapi.views.router import AirflowRouter +from airflow.api_fastapi.routes.router import AirflowRouter from airflow.utils import timezone dashboard_router = AirflowRouter(tags=["Dashboard"]) diff --git a/tests/api_fastapi/views/__init__.py b/tests/api_fastapi/routes/__init__.py similarity index 100% rename from tests/api_fastapi/views/__init__.py rename to tests/api_fastapi/routes/__init__.py diff --git a/tests/api_fastapi/views/public/__init__.py b/tests/api_fastapi/routes/public/__init__.py similarity index 100% rename from tests/api_fastapi/views/public/__init__.py rename to tests/api_fastapi/routes/public/__init__.py diff --git a/tests/api_fastapi/views/public/test_connections.py b/tests/api_fastapi/routes/public/test_connections.py similarity index 100% rename from tests/api_fastapi/views/public/test_connections.py rename to tests/api_fastapi/routes/public/test_connections.py diff --git a/tests/api_fastapi/views/public/test_dag_run.py b/tests/api_fastapi/routes/public/test_dag_run.py similarity index 100% rename from tests/api_fastapi/views/public/test_dag_run.py rename to tests/api_fastapi/routes/public/test_dag_run.py diff --git a/tests/api_fastapi/views/public/test_dags.py b/tests/api_fastapi/routes/public/test_dags.py similarity index 98% rename from tests/api_fastapi/views/public/test_dags.py rename to tests/api_fastapi/routes/public/test_dags.py index ab0c54f51764f..99ac939406f78 100644 --- a/tests/api_fastapi/views/public/test_dags.py +++ b/tests/api_fastapi/routes/public/test_dags.py @@ -293,7 +293,7 @@ def test_dag_details( "description": None, "doc_md": "details", "end_date": None, - "fileloc": "/opt/airflow/tests/api_fastapi/views/public/test_dags.py", + "fileloc": "/opt/airflow/tests/api_fastapi/routes/public/test_dags.py", "file_token": file_token, "has_import_errors": False, "has_task_concurrency_limits": True, @@ -358,7 +358,7 @@ def test_get_dag(self, test_client, query_params, dag_id, expected_status_code, "dag_id": dag_id, "dag_display_name": dag_display_name, "description": None, - "fileloc": "/opt/airflow/tests/api_fastapi/views/public/test_dags.py", + "fileloc": "/opt/airflow/tests/api_fastapi/routes/public/test_dags.py", "file_token": file_token, "is_paused": False, "is_active": True, diff --git a/tests/api_fastapi/views/public/test_monitor.py b/tests/api_fastapi/routes/public/test_monitor.py similarity index 100% rename from tests/api_fastapi/views/public/test_monitor.py rename to tests/api_fastapi/routes/public/test_monitor.py diff --git a/tests/api_fastapi/views/public/test_variables.py b/tests/api_fastapi/routes/public/test_variables.py similarity index 100% rename from tests/api_fastapi/views/public/test_variables.py rename to tests/api_fastapi/routes/public/test_variables.py diff --git a/tests/api_fastapi/views/ui/__init__.py b/tests/api_fastapi/routes/ui/__init__.py similarity index 100% rename from tests/api_fastapi/views/ui/__init__.py rename to tests/api_fastapi/routes/ui/__init__.py diff --git a/tests/api_fastapi/views/ui/test_assets.py b/tests/api_fastapi/routes/ui/test_assets.py similarity index 100% rename from tests/api_fastapi/views/ui/test_assets.py rename to tests/api_fastapi/routes/ui/test_assets.py diff --git a/tests/api_fastapi/views/ui/test_dashboard.py b/tests/api_fastapi/routes/ui/test_dashboard.py similarity index 100% rename from tests/api_fastapi/views/ui/test_dashboard.py rename to tests/api_fastapi/routes/ui/test_dashboard.py