Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check python version that was used to install pre-commit venvs (#43282) #43310

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,12 @@ repos:
\.cfg$|\.conf$|\.ini$|\.ldif$|\.properties$|\.readthedocs$|\.service$|\.tf$|Dockerfile.*$
- repo: local
hooks:
- id: check-min-python-version
name: Check minimum Python version
entry: ./scripts/ci/pre_commit/check_min_python_version.py
language: python
additional_dependencies: ['rich>=12.4.4']
require_serial: true
- id: update-common-sql-api-stubs
name: Check and update common.sql API stubs
entry: ./scripts/ci/pre_commit/update_common_sql_api_stubs.py
Expand Down
2 changes: 2 additions & 0 deletions contributing-docs/08_static_code_checks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ require Breeze Docker image to be built locally.
+-----------------------------------------------------------+--------------------------------------------------------------+---------+
| check-merge-conflict | Check that merge conflicts are not being committed | |
+-----------------------------------------------------------+--------------------------------------------------------------+---------+
| check-min-python-version | Check minimum Python version | |
+-----------------------------------------------------------+--------------------------------------------------------------+---------+
| check-newsfragments-are-valid | Check newsfragments are valid | |
+-----------------------------------------------------------+--------------------------------------------------------------+---------+
| check-no-airflow-deprecation-in-providers | Do not use DeprecationWarning in providers | |
Expand Down
42 changes: 21 additions & 21 deletions dev/breeze/doc/images/output-commands.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
136 changes: 70 additions & 66 deletions dev/breeze/doc/images/output_static-checks.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dev/breeze/doc/images/output_static-checks.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
97228aa2e9cdff69f86a9c0dfee5f83e
a109ca358651bbfcf3a36d007fd0646a
1 change: 1 addition & 0 deletions dev/breeze/src/airflow_breeze/pre_commit_ids.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
"check-lazy-logging",
"check-links-to-example-dags-do-not-use-hardcoded-versions",
"check-merge-conflict",
"check-min-python-version",
"check-newsfragments-are-valid",
"check-no-airflow-deprecation-in-providers",
"check-no-providers-in-core-examples",
Expand Down
68 changes: 68 additions & 0 deletions scripts/ci/pre_commit/check_min_python_version.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
#!/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.
from __future__ import annotations

import subprocess
import sys
from pathlib import Path

sys.path.insert(0, str(Path(__file__).parent.resolve()))

from common_precommit_utils import console

# update this version when we switch to a newer version of Python
required_version = tuple(map(int, "3.8".split(".")))
required_version_str = f"{required_version[0]}.{required_version[1]}"
global_version = tuple(
map(
int,
subprocess.run(
[
"python3",
"-c",
'import sys; print(f"{sys.version_info.major}.{sys.version_info.minor}")',
],
capture_output=True,
text=True,
check=True,
)
.stdout.strip()
.split("."),
)
)


if global_version < required_version:
console.print(f"[red]Python {required_version_str} or higher is required to install pre-commit.\n")
console.print(f"[green]Current version is {global_version}\n")
console.print(
"[bright_yellow]Please follow those steps:[/]\n\n"
f" * make sure that `python3 --version` is at least {required_version_str}\n"
f" * run `pre-commit clean`\n"
f" * run `pre-commit install --install-hooks`\n\n"
)
console.print(
"There are various ways you can set `python3` to point to a newer version of Python.\n\n"
f"For example run `pyenv global {required_version_str}` if you use pyenv, or\n"
f"you can use venv with python {required_version_str} when you use pre-commit, or\n"
"you can use `update-alternatives` if you use Ubuntu, or\n"
"you can set `PATH` to point to the newer version of Python.\n\n"
)
sys.exit(1)
else:
console.print(f"Python version is sufficient: {required_version_str}")
Loading