tasks.py

from pathlib import Path

from invoke import Context, UnexpectedExit, task

TOP_DIR = Path(__file__).parent
SRC_DIR = TOP_DIR / "src"
OUT_DIR = TOP_DIR / "build"
TEST_DIR = TOP_DIR / "tests" / "unit"


@task
def sphinx(c: Context, builder: str = "html") -> None:
    """Build documentation using Sphinx."""
    dest = OUT_DIR / "docs"
    cmd = ["sphinx-build", "-j auto", f"-d {OUT_DIR}/sphinx-cache", f"-b {builder}"]
    cmd.append(str(TOP_DIR / "docs"))
    cmd.append(str(dest))
    with c.cd(str(TOP_DIR)):
        c.run(" ".join(cmd), pty=True)


@task(post=[sphinx])
def docs(c: Context) -> None:
    """Build documentation."""
    print("Rendering README...")
    OUT_DIR.mkdir(parents=True, exist_ok=True)
    cmd = ["rst2html.py", "README.rst", f"-d {OUT_DIR}/README.html"]
    with c.cd(str(TOP_DIR)):
        c.run(" ".join(cmd), pty=True)
    print()


@task
def test(c: Context) -> None:
    """Run tests."""
    with c.cd(str(TOP_DIR)):
        c.run("pytest", pty=True)


@task
def cov(c: Context) -> None:
    """Run tests and report coverage."""
    with c.cd(str(TOP_DIR)):
        c.run(f"pytest --cov={SRC_DIR}", pty=True)
        c.run(f"coverage html -d {OUT_DIR}/coverage --skip-empty", pty=True)


@task
def types(c: Context, report: bool = False) -> None:
    """Type-check sources with mypy."""
    cmd = ["mypy"]
    if report:
        cmd.append(f"--html-report {OUT_DIR}/mypy-report.html")
    cmd.append(str(SRC_DIR))
    cmd.append(str(TEST_DIR))
    print("Type-checking...")
    with c.cd(str(TOP_DIR)):
        try:
            c.run(" ".join(cmd), pty=True)
        except UnexpectedExit as ex:
            if ex.result.exited < 0:
                print(ex)


@task
def lint(c: Context, src: str | None = None) -> None:
    """Check sources with PyLint."""
    print("Linting...")
    sources = (
        (SRC_DIR / "retroasm").glob("**/*.py") if src is None else Path.cwd().glob(src)
    )
    with c.cd(str(TOP_DIR)):
        c.run("pylint %s" % " ".join(str(path) for path in sources), pty=True)


@task
def upgrade(c: Context) -> None:
    """Upgrade sources to take advantage of new Python features."""
    print("Upgrading sources...")
    sources = (SRC_DIR / "retroasm").glob("**/*.py")
    c.run(f"pyupgrade --py311-plus {' '.join(str(path) for path in sources)}")


@task
def unused(c: Context) -> None:
    """Find unused code."""
    print("Scanning sources for unused code...")
    c.run(f"vulture --ignore-names '*_' {SRC_DIR} {TEST_DIR}")