_tasks.py

import re
import shutil
import subprocess
import sys
from pathlib import Path

from mobgap.utils.misc import get_env_var

HERE = Path(__file__).parent


def task_no_long_file_names():
    """Check that no files that are tracked by git are longer than 200 characters.

    We use this check, as on Windows there are pathlimits by default of 260 characters.
    To my understanding this includes the entire path.
    So it depends on where the user clones the repo too.
    Hence, we leave some room for the user path.
    """
    # Note: This only works on linux for now and we just run it in the CI.
    return subprocess.run(
        "git ls-files | awk 'length($0) > 200'",
        shell=True,
        check=True,
        stdout=subprocess.PIPE,
    )


def task_update_example_data(raise_if_changes=False):
    import pooch

    REGISTRY_PATH = HERE / "mobgap/data/_example_data_registry.txt"

    # Hash of old registry
    with open(REGISTRY_PATH) as f:
        old_registry = f.read()

    # Update the registry
    pooch.make_registry(str(HERE / "example_data"), str(REGISTRY_PATH))

    # Hash of new registry
    with open(REGISTRY_PATH) as f:
        new_registry = f.read()

    if raise_if_changes and old_registry != new_registry:
        raise ValueError("The registry has changed. Please run `poe update_example_data`.")


def task_update_validation_results():
    import pooch

    validation_data_repo = Path(get_env_var("MOBGAP_VALIDATION_DATA_PATH"))

    registry_file_path = validation_data_repo / "results_file_registry.txt"
    validation_results_folder = validation_data_repo / "results"

    pooch.make_registry(str(validation_results_folder), str(registry_file_path))


def task_docs(clean=False, builder="html"):
    """Build the html docs using Sphinx."""
    # Delete Autogenerated files from previous run
    if clean:
        shutil.rmtree(str(HERE / "docs/modules/generated"), ignore_errors=True)
        shutil.rmtree(str(HERE / "docs/_build"), ignore_errors=True)
        shutil.rmtree(str(HERE / "docs/auto_examples"), ignore_errors=True)

    subprocess.run(f"sphinx-build -b {builder} -j auto -d docs/_build docs docs/_build/html", shell=True, check=True)


def update_version_strings(file_path, new_version):
    # taken from:
    # https://stackoverflow.com/questions/57108712/replace-updated-version-strings-in-files-via-python
    version_regex = re.compile(r"(^_*?version_*?\s*=\s*\")(\d+\.\d+\.\d+-?\S*)\"", re.M)
    with open(file_path, "r+") as f:
        content = f.read()
        f.seek(0)
        f.write(
            re.sub(
                version_regex,
                lambda match: f'{match.group(1)}{new_version}"',
                content,
            )
        )
        f.truncate()


def update_version(version):
    subprocess.run(["poetry", "version", version], shell=False, check=True)
    new_version = (
        subprocess.run(["poetry", "version"], shell=False, check=True, capture_output=True)
        .stdout.decode()
        .strip()
        .split(" ", 1)[1]
    )
    update_version_strings(HERE.joinpath("mobgap/__init__.py"), new_version)


def task_update_version():
    update_version(sys.argv[1])