libretime/tools/python.mk

.DEFAULT_GOAL := install
SHELL := bash
CPU_CORES := $(shell N=$$(nproc); echo $$(( $$N > 4 ? 4 : $$N )))

# PIP_INSTALL = --editable .
# PYLINT_ARG =
# MYPY_ARG =
# BANDIT_ARG =
# PYTEST_ARG =

SHARED_DEV_REQUIREMENTS = \
	bandit \
	black \
	flake8 \
	isort \
	mypy \
	pylint \
	pytest \
	pytest-cov \
	pytest-xdist

VENV = .venv
$(VENV):
	python3 -m venv $(VENV)
	$(MAKE) install

# SETUPTOOLS_ENABLE_FEATURES=legacy-editable is required to work
# around https://github.com/PyCQA/pylint/issues/7306
install: $(VENV)
	$(VENV)/bin/pip install --upgrade pip setuptools wheel
	$(VENV)/bin/pip install $(SHARED_DEV_REQUIREMENTS)
	[[ -z "$(PIP_INSTALL)" ]] || SETUPTOOLS_ENABLE_FEATURES=legacy-editable $(VENV)/bin/pip install $(PIP_INSTALL)

.PHONY: .format
.format: $(VENV)
	$(VENV)/bin/black .
	$(VENV)/bin/isort .

.PHONY: .format-check
.format-check: $(VENV)
	$(VENV)/bin/black . --check
	$(VENV)/bin/isort . --check

.PHONY: .pylint
.pylint: $(VENV)
	$(VENV)/bin/pylint --jobs=$(CPU_CORES) --output-format=colorized --recursive=true $(PYLINT_ARG)

.PHONY: .mypy
.mypy: $(VENV)
	$(VENV)/bin/mypy $(MYPY_ARG)

.PHONY: .bandit
.bandit: $(VENV)
	$(VENV)/bin/bandit -r $(BANDIT_ARG)

.PHONY: .pytest
.pytest: $(VENV)
	$(VENV)/bin/pytest \
		--numprocesses=$(CPU_CORES) \
		--color=yes

.PHONY: .coverage
.coverage: $(VENV)
	$(VENV)/bin/pytest \
		--numprocesses=$(CPU_CORES) \
		--cov \
		--cov-config=pyproject.toml \
		--cov-report=term \
		--cov-report=xml

.PHONY: .clean
.clean:
	rm -Rf $(VENV)

DISTRO ?= bullseye
DOCKER_RUN = docker run -it --rm \
			--user $$(id -u):$$(id -g) \
			--env HOME=/src/.docker/$(DISTRO) \
			--volume $$(pwd)/..:/src \
			--workdir /src/$(APP) \
			ghcr.io/libretime/libretime-dev:$(DISTRO)

docker-dev:
	$(MAKE) clean
	$(DOCKER_RUN) bash

docker-test:
	$(MAKE) clean
	$(DOCKER_RUN) make test