can_skip

Support can-skip logic from Make.

Functions

can_skip

can_skip(*, prerequisites, targets)

Generic make-style task skipping logic based on file mtime.

Example use with Invoke, but can be used anywhere:

@task
def test(ctx: Context) -> None:
    if can_skip(prerequisites=[*Path('src').rglob('*.py')], targets=[Path('.coverage.xml')]):
        return  # Exit early

    ...  # Task code

Source code in calcipy/can_skip.py

@beartype
def can_skip(*, prerequisites: List[Path], targets: List[Path]) -> bool:
    """Generic make-style task skipping logic based on file `mtime`.

    Example use with Invoke, but can be used anywhere:

    ```py
    @task
    def test(ctx: Context) -> None:
        if can_skip(prerequisites=[*Path('src').rglob('*.py')], targets=[Path('.coverage.xml')]):
            return  # Exit early

        ...  # Task code
    ```

    """
    if not (ts_prerequisites := [pth.stat().st_mtime for pth in prerequisites]):
        raise ValueError('Required files do not exist', prerequisites)

    ts_targets = [pth.stat().st_mtime for pth in targets]
    if ts_targets and min(ts_targets) > max(ts_prerequisites):
        logger.warning('Skipping because targets are newer', targets=targets)
        return True
    return False

dont_skip

dont_skip(*, prerequisites, targets)

To use for testing with mock; always returns False.

Source code in calcipy/can_skip.py

@beartype
def dont_skip(*, prerequisites: List[Path], targets: List[Path]) -> bool:
    """To use for testing with mock; always returns False."""
    logger.debug('Mocking can_skip', prerequisites=prerequisites, targets=targets)
    return False