|
| 1 | +# SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | +import json |
| 4 | +import sys |
| 5 | +from datetime import datetime |
| 6 | + |
| 7 | +import requests |
| 8 | +from dateutil.relativedelta import relativedelta # TODO check and remove comment pip install python-dateutil |
| 9 | + |
| 10 | +from _helper_functions import print_color |
| 11 | + |
| 12 | +try: |
| 13 | + IDF_VERSIONS_TXT = str(sys.argv[1]) |
| 14 | +except IndexError: |
| 15 | + raise SystemExit('Error: IDF versions txt not provided.') |
| 16 | + |
| 17 | +json_data = { |
| 18 | + 'supported_idf': [], |
| 19 | + 'oldest_supported_idf': '', |
| 20 | + 'supported_python': [], |
| 21 | + 'oldest_supported_python': '' |
| 22 | +} |
| 23 | + |
| 24 | + |
| 25 | +def get_supported_idf_versions(): |
| 26 | + """ |
| 27 | + Fetches the supported versions of the ESP-IDF from the official Espressif's server. |
| 28 | + Returns a list of version strings. |
| 29 | + """ |
| 30 | + url = IDF_VERSIONS_TXT |
| 31 | + try: |
| 32 | + response = requests.get(url) |
| 33 | + response.raise_for_status() |
| 34 | + supported_idf_versions = response.text.splitlines() |
| 35 | + except requests.RequestException as exc: |
| 36 | + raise SystemExit(f'Failed to fetch supported ESP-IDF versions.\nError: {exc}') |
| 37 | + |
| 38 | + supported_idf_versions = [version for version in supported_idf_versions if version.startswith('v')] |
| 39 | + supported_idf_versions = [f"{version.split('.')[0]}.{version.split('.')[1]}" for version in supported_idf_versions] |
| 40 | + |
| 41 | + return supported_idf_versions |
| 42 | + |
| 43 | + |
| 44 | +class IDFRelease(): |
| 45 | + """ |
| 46 | + ESP-IDF Release with important properties |
| 47 | + EOL is based on the documentation's statement of 30 months support length: |
| 48 | + https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html |
| 49 | + """ |
| 50 | + def __init__(self, release_tag, published) -> None: |
| 51 | + self.release_tag = release_tag |
| 52 | + self.published = datetime.strptime(published, '%Y-%m-%dT%H:%M:%SZ').date() |
| 53 | + self.eol = self.published + relativedelta(months=+30) |
| 54 | + |
| 55 | + |
| 56 | +def get_github_idf_releases(supported_idf_versions): |
| 57 | + """ |
| 58 | + Fetches the releases of the ESP-IDF from the GitHub API. |
| 59 | + Returns a list of IDFRelease classes according to supported ESP-IDF versions. |
| 60 | + """ |
| 61 | + url = 'https://api.github.com/repos/espressif/esp-idf/releases?per_page=100' |
| 62 | + try: |
| 63 | + response = requests.get(url) |
| 64 | + response.raise_for_status() |
| 65 | + releases_raw = response.json() |
| 66 | + |
| 67 | + except requests.RequestException as exc: |
| 68 | + raise SystemExit(f'Failed to fetch ESP-IDF releases from GitHub.\nError: {exc}') |
| 69 | + |
| 70 | + releases = [] |
| 71 | + for release in releases_raw: |
| 72 | + tag_name = release['tag_name'] |
| 73 | + if tag_name in supported_idf_versions: |
| 74 | + releases.append(IDFRelease(tag_name, release['published_at'])) |
| 75 | + |
| 76 | + print_color('Supported ESP-IDF Versions:') |
| 77 | + for version in supported_idf_versions: |
| 78 | + for release in releases: |
| 79 | + if release.release_tag == version: |
| 80 | + print_color(f' - {version} ... Published: {release.published} ... EOL: {release.eol}') |
| 81 | + json_data['supported_idf'].append(version) |
| 82 | + return releases |
| 83 | + |
| 84 | + |
| 85 | +class PythonRelease(): |
| 86 | + """ |
| 87 | + Python release with important properties |
| 88 | + """ |
| 89 | + def __init__(self, version, eol_date, is_eol) -> None: |
| 90 | + self.version = version |
| 91 | + self.eol_date = datetime.strptime(eol_date, '%Y-%m-%d').date() |
| 92 | + self.is_eol = is_eol |
| 93 | + |
| 94 | + |
| 95 | +def get_supported_python_versions(): |
| 96 | + url = 'https://endoflife.date/api/v1/products/python/' |
| 97 | + try: |
| 98 | + response = requests.get(url) |
| 99 | + response.raise_for_status() |
| 100 | + releases_raw = response.json() |
| 101 | + releases_raw = releases_raw['result']['releases'] |
| 102 | + |
| 103 | + releases = [] |
| 104 | + for release in releases_raw: |
| 105 | + releases.append(PythonRelease(release['name'], release['eolFrom'], release['isEol'])) |
| 106 | + releases = [release for release in releases if release.eol_date > oldest_idf.published] |
| 107 | + return releases |
| 108 | + |
| 109 | + except requests.RequestException as exc: |
| 110 | + raise SystemExit(f'Failed to fetch supported Python versions.\nError: {exc}') |
| 111 | + |
| 112 | + |
| 113 | +supported_idf_versions = get_supported_idf_versions() |
| 114 | +github_releases = get_github_idf_releases(supported_idf_versions) |
| 115 | +oldest_idf: IDFRelease = min(github_releases, key=lambda rel: rel.published) |
| 116 | +json_data['oldest_supported_idf'] = oldest_idf.release_tag |
| 117 | +print_color('Oldest supported ESP-IDF release:') |
| 118 | +print_color(f' - {oldest_idf.release_tag} (Published on: {oldest_idf.published} ... EOL: {oldest_idf.eol})') |
| 119 | + |
| 120 | +python_releases = get_supported_python_versions() |
| 121 | +oldest_python_release = min(python_releases, key=lambda rel: rel.eol_date) |
| 122 | +json_data['oldest_supported_python'] = oldest_python_release.version |
| 123 | + |
| 124 | +print_color('Supported Python Versions based on ESP-IDF:') |
| 125 | +for item in python_releases: |
| 126 | + print_color(f' - Python {item.version}\t... EOL: {item.eol_date} ... EOL Status: {item.is_eol}') |
| 127 | + json_data['supported_python'].append(item.version) # type: ignore |
| 128 | + |
| 129 | +print_color('Oldest supported Python version:') |
| 130 | +print_color(f' - {oldest_python_release.version} (EOL: {oldest_python_release.eol_date})') |
| 131 | + |
| 132 | +with open('supported_versions.json', 'w') as f: |
| 133 | + json.dump(json_data, f, indent=4) |
0 commit comments