Modernize project (#26)

* 🎨 run black and isort * 👷 add black and isort to CI * 👷 add Python 3.12 * 💚 fix requirements-dev.txt * 👷 add black and isort to CI * 👷 add black and isort to CI * 👷 add black and isort to CI * 🚨 fix warnings * 🚨 fix warnings * 🎨 fix format
nlohmann · Apr 2, 2024 · 26b4b8d · 26b4b8d
1 parent 9e21305
commit 26b4b8d
Show file tree

Hide file tree

Showing 5 changed files with 220 additions and 100 deletions.
diff --git a/.github/workflows/all.yml b/.github/workflows/all.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
@@ -23,3 +23,20 @@ jobs:
           python -m pip install -r requirements.txt
       - name: Run cmake_downloader.py
         run: python cmake_downloader.py --latest_release
+
+  style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      - name: Setup virtual environment
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install wheel
+          python -m pip install -r requirements-dev.txt
+      - name: Style checks
+        run: |
+          black --check *.py
+          isort --check *.py
diff --git a/cmake_downloader.py b/cmake_downloader.py
@@ -1,113 +1,151 @@
 #!/usr/bin/env python3
 
 import argparse
-import os.path
 import platform
 import re
 import tarfile
 import tempfile
 import zipfile
-from typing import List, Dict
+from pathlib import Path
+from typing import Dict, List
 
 import requests
 from packaging.version import parse as version_parse
 from tqdm import tqdm
 
+TIMEOUT_SECONDS = 10
+session = requests.Session()
+
 
 def get_folders() -> List[str]:
-    url = 'https://cmake.org/files/'
-    html = requests.get(url).text
-    return list(re.findall(r'>v([0-9.]+)', html))
+    html = session.get(url="https://cmake.org/files/", timeout=TIMEOUT_SECONDS).text
+    return list(re.findall(r">v([0-9.]+)", html))
 
 
 def get_tarball_urls_version(base_version: str) -> List[str]:
-    url = f'https://cmake.org/files/v{base_version}/'
-    html = requests.get(url).text
-    return sorted([url + filename for filename in re.findall(r'>(cmake-[0-9rc.]+-[^.]+(?:\.tar\.gz|\.zip))', html)])
+    url = f"https://cmake.org/files/v{base_version}/"
+    html = session.get(url=url, timeout=TIMEOUT_SECONDS).text
+    return sorted([url + filename for filename in re.findall(r">(cmake-[0-9rc.]+-[^.]+(?:\.tar\.gz|\.zip))", html)])
 
 
 def get_tarball_urls() -> List[str]:
     folders = get_folders()
     result = []  # type: List[str]
 
-    print('Retrieving URLs...')
+    print("Retrieving URLs...")
     for folder in tqdm(folders):
         urls = get_tarball_urls_version(folder)
         result += urls
 
     return result
 
 
-def download_and_extract(url: str, path: str):
+def download_and_extract(url: str, path: Path) -> None:
     # derive file directory name from URL
-    file_name_start_pos = url.rfind('/') + 1
+    file_name_start_pos = url.rfind("/") + 1
     file_name = url[file_name_start_pos:]
-    file_wo_ext = file_name.replace('.tar.gz', '').replace('.zip', '')
+    file_wo_ext = file_name.replace(".tar.gz", "").replace(".zip", "")
 
-    if not os.path.exists(os.path.join(path, file_wo_ext)):
-        response = requests.get(url, stream=True)
+    if not (path / file_wo_ext).exists():
+        response = session.get(url=url, timeout=TIMEOUT_SECONDS, stream=True)
         response.raise_for_status()
-        file_size = int(response.headers['Content-Length'])
+        file_size = int(response.headers["Content-Length"])
 
         tmpdir = tempfile.TemporaryDirectory()
-        full_file_name = os.path.join(tmpdir.name, file_name)
+        full_file_name = Path(tmpdir.name) / file_name
 
-        progress = tqdm(total=file_size, unit='B', unit_scale=True, unit_divisor=1024)
-        with open(full_file_name, 'wb+') as f:
+        progress = tqdm(total=file_size, unit="B", unit_scale=True, unit_divisor=1024)
+        with Path(full_file_name).open(mode="wb+") as f:
             for data in response:
                 progress.update(len(data))
                 f.write(data)
         progress.close()
 
-        if url.endswith('.zip'):
-            with zipfile.ZipFile(full_file_name, mode='r') as zip_ref:
+        if url.endswith(".zip"):
+            with zipfile.ZipFile(full_file_name, mode="r") as zip_ref:
                 zip_ref.extractall(path)
         else:
-            with tarfile.open(full_file_name, mode='r:gz') as tar:
+            with tarfile.open(full_file_name, mode="r:gz") as tar:
                 tar.extractall(path=path)
 
 
 def create_version_dict(os: str) -> Dict[str, str]:
     tarball_urls = get_tarball_urls()
-    result = dict()
+    result = {}
 
     for tarball_url in tarball_urls:
-        version = re.findall(r'cmake-(([0-9.]+)(-rc[0-9]+)?)', tarball_url)[0][0]
-
-        if (os == 'macos' and ('Darwin64' in tarball_url or 'Darwin-x86_64' in tarball_url or 'macos-universal' in tarball_url)) \
-                or (os == 'linux' and ('Linux-x86_64' in tarball_url or 'linux-x86_64' in tarball_url)) \
-                or (os == 'windows' and ('win32-x86' in tarball_url or 'win64-x64' in tarball_url or 'windows-x86_64' in tarball_url)):
-            if version_parse(version).public not in result or \
-                    (version_parse(version).public in result and ('win64-x64' in tarball_url or 'windows-x86_64' in tarball_url)):
-                result[version_parse(version).public] = tarball_url
+        version = re.findall(r"cmake-(([0-9.]+)(-rc[0-9]+)?)", tarball_url)[0][0]
+
+        if (
+            (
+                os == "macos"
+                and ("Darwin64" in tarball_url or "Darwin-x86_64" in tarball_url or "macos-universal" in tarball_url)
+            )
+            or (os == "linux" and ("Linux-x86_64" in tarball_url or "linux-x86_64" in tarball_url))
+            or (
+                os == "windows"
+                and ("win32-x86" in tarball_url or "win64-x64" in tarball_url or "windows-x86_64" in tarball_url)
+            )
+        ) and (
+            version_parse(version).public not in result
+            or (
+                version_parse(version).public in result
+                and ("win64-x64" in tarball_url or "windows-x86_64" in tarball_url)
+            )
+        ):
+            result[version_parse(version).public] = tarball_url
 
     return result
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # get default value for current system
-    default_os = 'macos' if platform.system() == 'Darwin' else 'linux' if platform.system() == 'Linux' else 'windows' if platform.system() == 'Windows' else None
-
-    parser = argparse.ArgumentParser(description='Download CMake binaries.')
-    parser.add_argument('--os', help=f'OS to download CMake for (default: {default_os})',
-                        choices=['macos', 'linux', 'windows'], default=default_os)
-    parser.add_argument('--latest_release', action='store_true',
-                        help='only download the latest release (default: False)')
-    parser.add_argument('--latest_patch', action='store_true',
-                        help='only download the latest patch version for each release (default: False)')
-    parser.add_argument('--first_minor', action='store_true',
-                        help='only download the first minor version for each release (default: False)')
-    parser.add_argument('--release_candidates', action='store_true',
-                        help='also consider release candidates (default: False)')
-    parser.add_argument('--min_version', help='only download versions greater or equal than MIN_VERSION')
-    parser.add_argument('--max_version', help='only download versions less or equal than MAX_VERSION')
-    parser.add_argument('--tools_directory', metavar='DIR', default='tools',
-                        help='path to the CMake binaries (default: "tools")')
+    default_os = (
+        "macos"
+        if platform.system() == "Darwin"
+        else "linux" if platform.system() == "Linux" else "windows" if platform.system() == "Windows" else None
+    )
+
+    parser = argparse.ArgumentParser(description="Download CMake binaries.")
+    parser.add_argument(
+        "--os",
+        help=f"OS to download CMake for (default: {default_os})",
+        choices=["macos", "linux", "windows"],
+        default=default_os,
+    )
+    parser.add_argument(
+        "--latest_release",
+        action="store_true",
+        help="only download the latest release (default: False)",
+    )
+    parser.add_argument(
+        "--latest_patch",
+        action="store_true",
+        help="only download the latest patch version for each release (default: False)",
+    )
+    parser.add_argument(
+        "--first_minor",
+        action="store_true",
+        help="only download the first minor version for each release (default: False)",
+    )
+    parser.add_argument(
+        "--release_candidates",
+        action="store_true",
+        help="also consider release candidates (default: False)",
+    )
+    parser.add_argument("--min_version", help="only download versions greater or equal than MIN_VERSION")
+    parser.add_argument("--max_version", help="only download versions less or equal than MAX_VERSION")
+    parser.add_argument(
+        "--tools_directory",
+        metavar="DIR",
+        default="tools",
+        help='path to the CMake binaries (default: "tools")',
+    )
     args = parser.parse_args()
 
     version_dict = create_version_dict(os=args.os)
-    versions = sorted([version_parse(version) for version in version_dict.keys()])
-    print(f'Found {len(versions)} versions from {versions[0]} to {versions[-1]}.')
+    versions = sorted([version_parse(version) for version in version_dict])
+    print(f"Found {len(versions)} versions from {versions[0]} to {versions[-1]}.")
 
     if args.min_version:
         versions = sorted([version for version in versions if version >= version_parse(args.min_version)])
@@ -120,19 +158,19 @@ def create_version_dict(os: str) -> Dict[str, str]:
 
     if args.latest_patch:
         result = []
-        for major, minor in set([(version.major, version.minor) for version in versions]):
+        for major, minor in {(version.major, version.minor) for version in versions}:
             result.append([version for version in versions if version.major == major and version.minor == minor][-1])
         versions = sorted(result)
 
     if args.first_minor:
         result = []
-        for major, minor in set([(version.major, version.minor) for version in versions]):
-            result.append([version for version in versions if version.major == major and version.minor == minor][0])
+        for major, minor in {(version.major, version.minor) for version in versions}:
+            result.append(next(version for version in versions if version.major == major and version.minor == minor))
         versions = sorted(result)
 
     if args.latest_release:
         versions = versions[-1:]
 
     for idx, version in enumerate(versions):
-        print(f'Downloading CMake {version.public} ({idx+1}/{len(versions)})...')
-        download_and_extract(url=version_dict[version.public], path=args.tools_directory)
+        print(f"Downloading CMake {version.public} ({idx+1}/{len(versions)})...")
+        download_and_extract(url=version_dict[version.public], path=Path(args.tools_directory))