tasks.py

import contextlib
import shutil
import subprocess
import webbrowser
from itertools import chain
from pathlib import Path
from platform import uname

from invoke import task

"""'Makefile' equivalent for invoke tool (invoke or inv).
# Installation
`pip install invoke`
# Usage
> inv test
> inv lint
> inv coverage
etc...
# Autocompletion
For auto completion, just run:
`source <(inv --print-completion-script bash)`
or
`source <(inv --print-completion-script zsh)`
(or add it to ~/.zshrc or ~/.bashrc)
"""


# UTILS -----------------------------------------------------------------------

def get_platform():
    """Check the platform (Windos, Linux, or WSL)."""
    u = uname()
    if u.system == 'Windows':
        return 'windows'
    elif u.system == 'Linux' and 'microsoft' in u.release:
        return 'wsl'
    # else
    return 'linux'


def get_index_path():
    """Get full path for ./htmlcov/index.html file."""
    platform = get_platform()
    if platform != "wsl":
        return Path().resolve() / 'htmlcov' / 'index.html'
    # TODO: this part with .strip().replace() is ugly...
    process = subprocess.run(['wslpath', '-w', '.'],
                             capture_output=True, text=True)
    pathstr = process.stdout.strip().replace('\\', '/')
    return Path(pathstr) / 'htmlcov/index.html'


# TASKS------------------------------------------------------------------------

@task
def lint(c):
    """flake8 - static check for python files"""
    c.run("flake8")


@task
def cleantest(c):
    """Clean artifacts like *.pyc, __pycache__, .pytest_cache, etc..."""
    # Find .pyc or .pyo files and delete them
    exclude = ('venv', '.venv')
    p = Path()
    artifacts = (i for i in p.glob('**/*.py[co]')
                 if not str(i.parent).startswith(exclude))
    for art in artifacts:
        art.unlink()

    # Delete caches folders
    cache1 = (i for i in p.glob('**/__pycache__')
              if not str(i.parent).startswith(exclude))
    cache2 = (i for i in p.glob('**/.pytest_cache')
              if not str(i.parent).startswith(exclude))
    cache3 = (i for i in p.glob('**/.mypy_cache')
              if not str(i.parent).startswith(exclude))
    caches = chain(cache1, cache2, cache3)
    for cache in caches:
        shutil.rmtree(cache)

    # Delete coverage artifacts
    Path('.coverage').unlink(missing_ok=True)
    with contextlib.suppress(FileNotFoundError):
        shutil.rmtree('htmlcov')


@task
def cleanbuild(c):
    """Clean dist/, build/ and egg-info/."""
    exclude = ('venv', '.venv')
    p = Path()
    gen1 = (i for i in p.glob('**/dist')
            if not str(i.parent).startswith(exclude))
    gen2 = (i for i in p.glob('**/build')
            if not str(i.parent).startswith(exclude))
    gen3 = (i for i in p.glob('**/*.egg-info')
            if not str(i.parent).startswith(exclude))
    builds = chain(gen1, gen2, gen3)
    for b in builds:
        shutil.rmtree(b)


@task
def cleancomics(c):
    """Clean comics like *.cbz or *.cbr"""
    # Find .pyc or .pyo files and delete them
    p = Path()
    comics = p.glob('**/*.cb[rz]')
    for c in comics:
        c.unlink()


@task(cleantest, cleanbuild, cleancomics)
def clean(c):
    """Equivalent to both cleanbuild and cleantest..."""
    print("Cleaning !")


@task
def test(c):
    """Run tests with pytest."""
    c.run("pytest tests/")


@task
def coverage(c):
    """Run unit-tests using pytest, with coverage reporting."""
    # use the browser defined in varenv $BROWSER
    # in WSL, if not set, example : export BROWSER='/mnt/c/Program Files/Google/Chrome/Application/chrome.exe'  # noqa: E501
    path = get_index_path()
    c.run('coverage run -m pytest')  # noqa: E501
    c.run('coverage report -m')
    c.run('coverage html')
    webbrowser.open(path.as_uri())