Makefile

.DEFAULT_GOAL := help

PYTHONPATH=
SHELL=/bin/bash
VENV=../.venv

ifeq ($(OS),Windows_NT)
	VENV_BIN=$(VENV)/Scripts
else
	VENV_BIN=$(VENV)/bin
endif

.PHONY: .venv
.venv:  ## Set up virtual environment and install requirements
	@$(MAKE) -s -C .. $@

.PHONY: requirements
requirements: .venv  ## Install/refresh all project requirements
	@$(MAKE) -s -C .. $@

.PHONY: build
build: .venv  ## Compile and install Polars for development
	@$(MAKE) -s -C .. $@

.PHONY: build-debug-opt
build-debug-opt: .venv  ## Compile and install Polars with minimal optimizations turned on
	@$(MAKE) -s -C .. $@

.PHONY: build-debug-opt-subset
build-debug-opt-subset: .venv  ## Compile and install Polars with minimal optimizations turned on and no default features
	@$(MAKE) -s -C .. $@

.PHONY: build-opt
build-opt: .venv  ## Compile and install Polars with nearly full optimization on and debug assertions turned off, but with debug symbols on
	@$(MAKE) -s -C .. $@

.PHONY: build-release
build-release: .venv  ## Compile and install a faster Polars binary with full optimizations
	@$(MAKE) -s -C .. $@

.PHONY: build-native
build-native: .venv  ## Same as build, except with native CPU optimizations turned on
	@$(MAKE) -s -C .. $@

.PHONY: build-debug-opt-native
build-debug-opt-native: .venv  ## Same as build-debug-opt, except with native CPU optimizations turned on
	@$(MAKE) -s -C .. $@

.PHONY: build-opt-native
build-opt-native: .venv  ## Same as build-opt, except with native CPU optimizations turned on
	@$(MAKE) -s -C .. $@

.PHONY: build-release-native
build-release-native: .venv  ## Same as build-release, except with native CPU optimizations turned on
	@$(MAKE) -s -C .. $@

.PHONY: fmt
fmt: .venv  ## Run autoformatting and linting
	$(VENV_BIN)/ruff check .
	$(VENV_BIN)/ruff format .
	$(VENV_BIN)/typos
	cargo fmt --all
	-dprint fmt
	-$(VENV_BIN)/mypy

.PHONY: clippy
clippy:  ## Run clippy
	cargo clippy --locked -- -D warnings

.PHONY: pre-commit
pre-commit: fmt clippy  ## Run all code quality checks

.PHONY: test
test: .venv build  ## Run fast unittests
	$(VENV_BIN)/pytest -n auto --dist loadgroup

.PHONY: doctest
doctest: .venv build  ## Run doctests
	$(VENV_BIN)/python tests/docs/run_doctest.py
	$(VENV_BIN)/pytest tests/docs/test_user_guide.py -m docs

.PHONY: test-all
test-all: .venv build  ## Run all tests
	$(VENV_BIN)/pytest -n auto --dist loadgroup -m "slow or not slow"
	$(VENV_BIN)/python tests/docs/run_doctest.py

.PHONY: coverage
coverage: .venv build  ## Run tests and report coverage
	$(VENV_BIN)/pytest --cov -n auto --dist loadgroup -m "not benchmark"

.PHONY: clean
clean:  ## Clean up caches and build artifacts
	@rm -rf target/
	@rm -rf docs/build/
	@rm -rf docs/source/reference/api/
	@rm -rf .hypothesis/
	@rm -rf .mypy_cache/
	@rm -rf .pytest_cache/
	@rm -rf .ruff_cache/
	@rm -f .coverage
	@rm -f coverage.xml
	@rm -f polars/polars.abi3.so
	@find . -type f -name '*.py[co]' -delete -or -type d -name __pycache__ -delete
	@cargo clean

.PHONY: help
help:  ## Display this help screen
	@echo -e "\033[1mAvailable commands:\033[0m"
	@grep -E '^[a-z.A-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-22s\033[0m %s\n", $$1, $$2}' | sort