Makefile

MAKEFLAGS += --no-builtin-rules
MAKEFLAGS += --no-builtin-variables

# allow overriding the name of the venv directory
VENV_DIR ?= venv

# use a default prefix for coverage data files
COVERAGE_FILE ?= .coverage

# use different coverage data file per coverage run, otherwise combine complains
TESTS_COVERAGE_FILE = ${COVERAGE_FILE}.tests

# make tasks run all commands in a single shell
.ONESHELL:

# these targets don't produce files:
.PHONY: clean filecheck pytest pytest-nb tests-toy tests rerun-notebooks precommit-install precommit black pyright
.PHONY: coverage coverage-tests coverage-filecheck-tests coverage-report-html coverage-report-md

# remove all caches and the venv
clean:
	rm -rf ${VENV_DIR} .pytest_cache *.egg-info .coverage.*

# run filecheck tests
filecheck:
	lit -vv tests/filecheck --order=smart

# run pytest tests
pytest:
	pytest tests -W error -vv

# run pytest on notebooks
pytest-nb:
	pytest -W error --nbval -vv docs --ignore=docs/mlir_interoperation.ipynb --nbval-current-env

# run tests for Toy tutorial
filecheck-toy:
	lit -v docs/Toy/examples --order=smart

pytest-toy:
	pytest docs/Toy/toy/tests

tests-toy: filecheck-toy pytest-toy

# run all tests
tests: pytest tests-toy filecheck pytest-nb pyright
	@echo test

# re-generate the output from all jupyter notebooks in the docs directory
rerun-notebooks:
	jupyter nbconvert --ClearMetadataPreprocessor.enabled=True --inplace --to notebook --execute docs/*.ipynb

# set up all precommit hooks
precommit-install:
	pre-commit install

# run all precommit hooks and apply them
precommit:
	pre-commit run --all

# run pyright on all files in the current git commit
pyright:
	pyright $(shell git diff --staged --name-only  -- '*.py')

# run black on all files currently staged
black:
	staged_files="$(shell git diff --staged --name-only)"
	# run black on all of xdsl if no staged files exist
	black $${staged_files:-xdsl}

# run coverage over all tests and combine data files
coverage: coverage-tests coverage-filecheck-tests
	coverage combine --append

# run coverage over tests
coverage-tests:
	COVERAGE_FILE=${TESTS_COVERAGE_FILE} pytest -W error --cov --cov-config=.coveragerc

# run coverage over filecheck tests
coverage-filecheck-tests:
	lit -v tests/filecheck/ -DCOVERAGE

# generate html coverage report
coverage-report-html:
	coverage html

# generate markdown coverage report
coverage-report-md:
	coverage report --format=markdown

# set up the venv with all dependencies for development
venv: requirements-optional.txt requirements.txt
	python3 -m venv ${VENV_DIR}
	source ${VENV_DIR}/bin/activate
	python3 -m pip --require-virtualenv install -r requirements-optional.txt -r requirements.txt
	python3 -m pip --require-virtualenv install -e ".[extras]"