-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into add_copyright_check
- Loading branch information
Showing
36 changed files
with
334 additions
and
220 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
""" | ||
This helper script checks if the Python versions defined in a `pyproject.toml` coincide with the given `min_version` | ||
and `max_version` and returns an error if they don't. | ||
""" | ||
import re | ||
import argparse | ||
import sys | ||
from packaging.version import Version, InvalidVersion | ||
|
||
def main(pyproject_toml_path: str, min_version: str, max_version: str) -> None: | ||
# Load and check `requires-python` version from `pyproject.toml` | ||
try: | ||
with open(pyproject_toml_path, "r") as f: | ||
pyproject_content = f.read() | ||
|
||
match = re.search(r'requires-python\s*=\s*">=([\d.]+)"', pyproject_content) | ||
if not match: | ||
print(f"Error: `requires-python` field not found or invalid format in `{pyproject_toml_path}`") | ||
sys.exit(1) | ||
|
||
pyproject_version = match.group(1) | ||
if Version(pyproject_version) < Version(min_version): | ||
print(f"Error: Python version in `{pyproject_toml_path}` `requires-python` ({pyproject_version}) " | ||
f"is smaller than `min_version` ({min_version}).") | ||
sys.exit(1) | ||
|
||
except FileNotFoundError: | ||
print(f"Error: File not found: `{pyproject_toml_path}`.") | ||
sys.exit(1) | ||
|
||
print(f"Success: Version in pyproject.toml `requires-python` (>={pyproject_version}) " | ||
f"matches expected versions ([{min_version} to {max_version}]).") | ||
|
||
|
||
if __name__ == "__main__": | ||
parser = argparse.ArgumentParser(description="Check Python version support and alignment with pyproject.toml.") | ||
parser.add_argument("pyproject_toml_path", help="Path to the `pyproject.toml` file to check.") | ||
parser.add_argument("min_version", help="The minimum Python version.") | ||
parser.add_argument("max_version", help="The maximum Python version.") | ||
args = parser.parse_args() | ||
|
||
try: | ||
main(args.pyproject_toml_path, args.min_version, args.max_version) | ||
except InvalidVersion: | ||
print("Error: Invalid version format provided.") | ||
sys.exit(1) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
requests>=2.23 | ||
packaging>=24.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
""" | ||
This helper script checks that the provided `min_version` and `max_version` are supported and released, respectively, | ||
using the API from the great https://github.com/endoflife-date/endoflife.date project. | ||
""" | ||
import argparse | ||
import sys | ||
import requests | ||
from packaging.version import InvalidVersion | ||
from datetime import datetime | ||
|
||
def main(min_version: str, max_version: str) -> None: | ||
# Fetch supported Python versions and check min/max versions | ||
try: | ||
response = requests.get("https://endoflife.date/api/python.json") | ||
response.raise_for_status() | ||
eol_data = response.json() | ||
eol_versions = {entry["cycle"]: {"eol": entry["eol"], "releaseDate": entry["releaseDate"]} for entry in eol_data} | ||
|
||
# Get current date to compare with EoL and release dates | ||
current_date = datetime.now().date() | ||
|
||
# Check min_version EoL status | ||
min_eol_date = eol_versions.get(min_version, {}).get("eol") | ||
if min_eol_date and datetime.strptime(min_eol_date, "%Y-%m-%d").date() <= current_date: | ||
print(f"Error: min_version {min_version} has reached End-of-Life.") | ||
sys.exit(1) | ||
|
||
# Check max_version EoL and release status | ||
max_info = eol_versions.get(max_version) | ||
if max_info: | ||
max_eol_date = max_info["eol"] | ||
max_release_date = max_info["releaseDate"] | ||
|
||
# Check if max_version has a release date in the future | ||
if max_release_date and datetime.strptime(max_release_date, "%Y-%m-%d").date() > current_date: | ||
print(f"Error: max_version {max_version} has not been officially released yet.") | ||
sys.exit(1) | ||
|
||
# Check if max_version has reached EoL | ||
if max_eol_date and datetime.strptime(max_eol_date, "%Y-%m-%d").date() <= current_date: | ||
print(f"Error: max_version {max_version} has reached End-of-Life.") | ||
sys.exit(1) | ||
|
||
except requests.RequestException: | ||
print("Error: Failed to fetch Python version support data.") | ||
sys.exit(1) | ||
|
||
print(f"Version check passed: min_version [{min_version}] is supported " | ||
f"and max_version [{max_version}] is released.") | ||
|
||
if __name__ == "__main__": | ||
parser = argparse.ArgumentParser(description="Check Python version support and alignment with pyproject.toml.") | ||
parser.add_argument("min_version", help="The minimum Python version.") | ||
parser.add_argument("max_version", help="The maximum Python version.") | ||
args = parser.parse_args() | ||
|
||
try: | ||
main(args.min_version, args.max_version) | ||
except InvalidVersion: | ||
print("Error: Invalid version format provided.") | ||
sys.exit(1) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.