fix: add pre-commit to ban urlparse (apache#27841)

review by @potiuk @uranusjr @eladkal
sekikn · Feb 20, 2023 · a99254f · a99254f
1 parent cd01650
commit a99254f
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 8 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -420,6 +420,13 @@ repos:
         pass_filenames: true
         files: \.py$
         exclude: ^airflow/_vendor/|^docs/|^tests/
+      - id: check-urlparse-usage-in-code
+        language: pygrep
+        name: Don't use urlparse in code
+        description: urlparse is not recommended, use urlsplit() in code instead
+        entry: "^\\s*from urllib\\.parse import ((\\|, )(urlparse\\|urlunparse))+$"
+        pass_filenames: true
+        files: \.py$
       - id: check-only-new-session-with-provide-session
         name: Check NEW_SESSION is only used with @provide_session
         language: python

diff --git a/STATIC_CODE_CHECKS.rst b/STATIC_CODE_CHECKS.rst
@@ -227,6 +227,8 @@ require Breeze Docker image to be build locally.
 +-----------------------------------------------------------+------------------------------------------------------------------+---------+
 | check-system-tests-tocs                                   | Check that system tests is properly added                        |         |
 +-----------------------------------------------------------+------------------------------------------------------------------+---------+
+| check-urlparse-usage-in-code                              | Don't use urlparse in code                                       |         |
++-----------------------------------------------------------+------------------------------------------------------------------+---------+
 | check-xml                                                 | Check XML files with xmllint                                     |         |
 +-----------------------------------------------------------+------------------------------------------------------------------+---------+
 | codespell                                                 | Run codespell to check for common misspellings in files          |         |

diff --git a/dev/breeze/src/airflow_breeze/pre_commit_ids.py b/dev/breeze/src/airflow_breeze/pre_commit_ids.py
@@ -67,6 +67,7 @@
     "check-start-date-not-used-in-defaults",
     "check-system-tests-present",
     "check-system-tests-tocs",
+    "check-urlparse-usage-in-code",
     "check-xml",
     "codespell",
     "compile-www-assets",

diff --git a/images/breeze/output-commands-hash.txt b/images/breeze/output-commands-hash.txt
@@ -55,7 +55,7 @@ setup:version:123b462a421884dc2320ffc5e54b2478
 setup:56a2ef337c354362760d247df5d05365
 shell:ab07ac2d57253e25367a7200ce686703
 start-airflow:5e8460ac38f8e9ea2a0ac7e248fd7bc9
-static-checks:12e8fed2acbed0d823efc5121fd0eb58
+static-checks:af6504875660e76e870967ffb43f1724
 stop:e5aa686b4e53707ced4039d8414d5cd6
 testing:docker-compose-tests:b86c044b24138af0659a05ed6331576c
 testing:helm-tests:94a442e7f3f63b34c4831a84d165690a

diff --git a/images/breeze/output_static-checks.svg b/images/breeze/output_static-checks.svg