tasks.py

import sys

import invoke

#-------------------------------------------------------------------------------

@invoke.task
def clean(context):
    """Clean doc and build artifacts
    """
    context.run("rm -rf coverage.xml")
    context.run("rm -rf htmlcov")
    context.run("rm -rf doc/build")
    context.run("rm -rf build")
    context.run("rm -rf dist")
    context.run("rm -rf *.egg-info")
    context.run("rm -rf .coverage")
    context.run("rm -rf .mypy_cache")
    context.run("rm -rf .pytest_cache")
    context.run("rm -rf .hypothesis")
    context.run("rm -rf .ipynb_checkpoints")



@invoke.task()
def doc(context):
    """Build docs
    """
    context.run(f"{sys.executable} doc/doc_build.py")


@invoke.task
def test(context, cov=False):
    """Run tests.
    """
    cmd = f"pytest -s function_pipe/test"

    if cov:
        cmd += " --cov=function_pipe --cov-report=xml"

    context.run(cmd, echo=True)


@invoke.task
def coverage(context):
    """
    Perform code coverage, and open report HTML.
    """
    cmd = "pytest -s --color no --cov=function_pipe/core --cov-report html"
    context.run(cmd, echo=True)
    import webbrowser
    webbrowser.open("htmlcov/index.html")


@invoke.task
def mypy(context):
    """Run mypy static analysis.
    """
    context.run("mypy function_pipe/core --strict")


@invoke.task
def lint(context):
    """Run pylint static analysis.
    """
    context.run("pylint -f colorized function_pipe")

@invoke.task(pre=(mypy, lint))
def quality(context):
    """Perform all quality checks.
    """


@invoke.task
def isort(context, check=False):
    """Sort imports."""
    cmd = "isort function_pipe/core function_pipe/test doc/"
    if check:
        cmd += " --check"
    context.run(cmd, echo=True, pty=True)


@invoke.task
def black(context, check=False):
    """Format code."""
    args = ["black"]
    if check:
        args.append("--check")

    cmd = "black function_pipe/core function_pipe/test doc/"
    if check:
        cmd += " --check"
    context.run(cmd, echo=True, pty=True)


@invoke.task  # Don't put the jobs here, since we need to forward args to them!
def formatting(context, check=False):
    """Run all formatting checks."""
    black(context, check=check)
    isort(context, check=check)


#-------------------------------------------------------------------------------

@invoke.task(pre=(clean,))
def build(context):
    """Build packages
    """
    context.run(f"{sys.executable} setup.py sdist")

@invoke.task(pre=(build,), post=(clean,))
def release(context):
    context.run("twine upload dist/* --repository function-pipe")