duties.py

"""Inspired from griffe-pydantic."""

import os
import shutil
from contextlib import contextmanager
from pathlib import Path
from typing import Iterator

from duty import context, duty

PYTHON_VERSIONS = os.getenv('PYTHON_VERSIONS', '3.9 3.10 3.11 3.12 3.13').split()

SRC = ('.',)
SEP = os.sep

DOCS_LANGS = ('az',)

if os.name == 'nt':
    import sys

    sys.stdin.reconfigure(encoding='utf-8')  # type: ignore[union-attr]
    sys.stdout.reconfigure(encoding='utf-8')  # type: ignore[union-attr]


@contextmanager
def environ(**kwargs: str) -> Iterator[None]:
    """Temporarily set environment variables."""
    original = dict(os.environ)
    os.environ.update(kwargs)
    try:
        yield
    finally:
        os.environ.clear()
        os.environ.update(original)


##################################################################################################
@duty
def setup(ctx: context.Context) -> None:
    """Setup the project."""
    if not shutil.which('uv'):
        raise ValueError('make: setup: uv must be installed, see https://github.com/astral-sh/uv')

    if not shutil.which('pre-commit'):
        raise ValueError('make: setup: pre-commit must be installed, see https://pre-commit.com/')

    ctx.run('pre-commit install')

    print('Installing dependencies (default environment)')  # noqa: T201
    default_venv = Path('.venv')
    if not default_venv.exists():
        ctx.run('uv venv')

    with environ(UV_PROJECT_ENVIRONMENT=str(default_venv.resolve())):
        ctx.run('uv sync')

    if PYTHON_VERSIONS:
        for ver in PYTHON_VERSIONS:
            print(f'\nInstalling dependencies (python{ver})')  # noqa: T201

            venv_path = Path(f'.venvs{SEP}{ver}')
            if not venv_path.exists():
                ctx.run(f'uv venv --python {ver} {venv_path}')

            with environ(UV_PROJECT_ENVIRONMENT=str(venv_path.resolve())):
                ctx.run('uv sync')


@duty
def format(ctx: context.Context, *files):  # pylint: disable=redefined-builtin
    """Format the files."""

    arg = ' '.join(files if files else SRC)

    ctx.run(f'ruff check {arg} --fix-only --exit-zero', title='Auto-fixing code')
    ctx.run(f'ruff format {arg}', title='Formatting code')


@duty
def lint(ctx: context.Context, *files):
    """Lint the files."""

    arg = ' '.join(files if files else SRC)

    ctx.run(f'ruff check {arg}', title='Linting with ruff check')
    ctx.run(f'ruff format {arg} --check', title='Linting with ruff format')
    ctx.run(f'pylint {arg}', title='Linting with pylint')


@duty
def type_check(ctx: context.Context, *files):
    """Type check the files."""
    arg = ' '.join(files if files else SRC)

    ctx.run(f'mypy {arg}', title='Type checking with mypy')


@duty
def test(ctx: context.Context, live: bool = False):
    """Run tests with local environment"""
    for ver in PYTHON_VERSIONS:
        venv_path = Path(f'.venvs{SEP}{ver}')

        with environ(VIRTUAL_ENV=str(venv_path)):
            ctx.run(
                'uv run --active --no-sync coverage run --data-file=coverage/.coverage.py'
                + ver
                + ' -m pytest -sv --durations=10 '
                + ('--live' if live else ''),
                title=f'Running tests (python {ver})',
            )


@duty
def coverage(ctx: context.Context, title: str = ''):
    """Generate coverage report"""
    ctx.run('coverage combine coverage', title='Combining coverage')
    ctx.run('coverage report', title='Generating coverage report', capture=False)
    ctx.run(
        f'coverage html --title="Coverage report for {title}"',
        title='Generating coverage HTML report',
    )


@duty
def docs(ctx: context.Context):
    """Build the documentation."""
    for lang in DOCS_LANGS:
        ctx.run(
            f'mkdocs build -f docs/{lang}/mkdocs.yml --strict',
            title=f'Building documentation ({lang})',
        )


@duty
def docs_serve(ctx: context.Context, lang='az'):
    """Serve the documentation."""
    ctx.run(
        f'mkdocs serve -f docs/{lang}/mkdocs.yml',
        title=f'Serving documentation ({lang})',
    )


@duty
def secure(ctx: context.Context):
    """Run security checks with bandit."""
    ctx.run('bandit -r src/integrify --config pyproject.toml', title='Running bandit')


@duty(pre=['format', 'lint', 'test', 'docs'])
def all():  # pylint: disable=redefined-builtin
    """Run all main tasks: format, lint, test, docs."""


@duty
def clean(ctx: context.Context):  # pylint: disable=unused-argument
    """Delete build artifacts and cache files."""
    print('Cleaning...')  # noqa: T201
    paths_to_clean = ['htmlcov', 'coverage']
    for path in paths_to_clean:
        shutil.rmtree(path, ignore_errors=True)

    cache_dirs = {'site', '.cache', '.pytest_cache', '.mypy_cache', '.ruff_cache', '__pycache__'}
    for dirpath in Path('.').rglob('*/'):
        if dirpath.parts[0] not in ('.venv', '.venvs') and dirpath.name in cache_dirs:
            shutil.rmtree(dirpath, ignore_errors=True)

    print('Done.')  # noqa: T201