kaxil commented on code in PR #67367:
URL: https://github.com/apache/airflow/pull/67367#discussion_r3294389426
##########
airflow-core/.pre-commit-config.yaml:
##########
@@ -148,6 +148,15 @@ repos:
language: python
pass_filenames: true
files: ^src/airflow/.*\.py$
+ - id: check-http-exception-import-from-fastapi
+ name: Check HTTPException is imported from fastapi
+ entry: ../scripts/ci/prek/check_http_exception_import_from_fastapi.py
+ language: python
+ pass_filenames: true
+ files: >
+ (?x)
+ ^src/airflow/api_fastapi/.*\.py$|
Review Comment:
Coverage gap worth widening:
`airflow-core/src/airflow/utils/serve_logs/log_server.py` wires a FastAPI app
and raises `HTTPException` in ~10 places, but it lives outside
`src/airflow/api_fastapi/`, so this regex skips it. If someone there swaps
`from fastapi import HTTPException` for `from starlette.exceptions import
HTTPException` (or `http.client`), the hook will not catch it -- the exact bug
class this PR is meant to prevent.
Options: add `^src/airflow/utils/serve_logs/.*\.py$` to the union, or
rescope the regex to FastAPI usage rather than path.
##########
scripts/ci/prek/check_http_exception_import_from_fastapi.py:
##########
@@ -0,0 +1,131 @@
+#!/usr/bin/env python
+#
+# 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.
+"""Check that ``HTTPException`` is imported from ``fastapi`` in fastapi-using
trees.
+
+The hook is wired into per-distribution ``.pre-commit-config.yaml`` files
+(``airflow-core``, ``providers/amazon``, ``providers/common/ai``,
+``providers/edge3``, ``providers/fab``, ``providers/keycloak``), each
+scoped to the subtree that actually wires a FastAPI app. Provider trees
+that mix client and server code (e.g. edge3's ``cli/`` is a client) are
+scoped to the server-side subfolders only to avoid false positives on
+stdlib HTTP usage in the client. Within those scopes, every
+``HTTPException`` must come from ``fastapi`` (which re-exports the
+Starlette class). Two common mistakes this hook catches:
+
+* ``from starlette.exceptions import HTTPException`` — a different class at
+ runtime; ``isinstance(exc, fastapi.HTTPException)`` and
+ ``pytest.raises(fastapi.HTTPException)`` will not match it.
+* ``from http.client import HTTPException`` — an unrelated stdlib exception
+ whose constructor signature differs, so the route returns 500 instead of
+ the intended HTTP status.
+"""
+
+# /// script
+# requires-python = ">=3.10,<3.11"
+# dependencies = [
+# "rich>=13.6.0",
+# ]
+# ///
+from __future__ import annotations
+
+import argparse
+import ast
+import sys
+from pathlib import Path
+
+from common_prek_utils import console
+
+
+def _is_fastapi_module(module: str) -> bool:
+ """Return True if *module* is ``fastapi`` or a submodule of it."""
+ return module == "fastapi" or module.startswith("fastapi.")
+
+
+def check_file(file_path: Path) -> list[tuple[int, str]]:
+ """Return list of ``(line_number, import_statement)`` violations."""
Review Comment:
Could you add a test for this under
`scripts/tests/ci/prek/test_check_http_exception_import_from_fastapi.py`? The
sibling hook `check_conf_import_in_providers` has one, and CLAUDE.md asks for
tests with every new feature. A small parametrized test over a handful of
good/bad import strings (plain, aliased, dotted-from `fastapi.exceptions`,
`starlette.exceptions`, `http.client`) would lock in the AST logic and guard
against regressions when the alias-rendering / module-prefix logic is touched.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
