cocalc-api: coverage report, makefile help

Author: haraldschilly

.gitignore

@@ -71,6 +71,12 @@ src/conf/tinc_hosts/
 # mocha: banket coverage report
 src/coverage
 src/*/coverage
+
+# Python coverage files
+.coverage
+.coverage.*
+htmlcov/
+**/htmlcov/
 # comes up when testing in that directory
 src/rethinkdb_data/
 src/dev/project/rethinkdb_data/

src/python/cocalc-api/Makefile

@@ -1,5 +1,20 @@
 all: install build-docs
 
+help:
+	@echo "Available targets:"
+	@echo "  install          - Install project dependencies"
+	@echo "  format           - Format code using yapf"
+	@echo "  check            - Run linting and type checking"
+	@echo "  test             - Run tests"
+	@echo "  test-verbose     - Run tests with verbose output"
+	@echo "  coverage         - Run tests with coverage reporting (HTML + terminal)"
+	@echo "  coverage-report  - Show coverage report in terminal"
+	@echo "  coverage-html    - Generate HTML coverage report only"
+	@echo "  serve-docs       - Serve documentation locally"
+	@echo "  build-docs       - Build documentation"
+	@echo "  publish          - Build and publish package"
+	@echo "  clean            - Clean build artifacts and cache files"
+
 install:
 	uv --version >/dev/null 2> /dev/null || curl -LsSf https://astral.sh/uv/install.sh | sh
 	uv sync --dev
@@ -19,6 +34,15 @@ test:
 test-verbose:
 	uv run pytest -v
 
+coverage:
+	uv run pytest --cov=src --cov-report=term-missing --cov-report=html
+
+coverage-report:
+	uv run coverage report
+
+coverage-html:
+	uv run coverage html
+
 serve-docs:
 	uv run mkdocs serve
 
@@ -30,6 +54,6 @@ publish: install
 	uv publish
 
 clean:
-	rm -rf dist build *.egg-info site .pytest_cache
+	rm -rf dist build *.egg-info site .pytest_cache htmlcov .coverage
 	find . -name "__pycache__" -type d -exec rm -rf {} +
 	find . -name "*.pyc" -delete

src/python/cocalc-api/pyproject.toml

@@ -39,15 +39,46 @@ indent_width = 4
 line-length = 150
 lint.select = ["E", "F", "B"]  # Pyflakes, pycodestyle, bugbear, etc.
 
+[tool.coverage.run]
+source = ["src"]
+omit = [
+    "*/tests/*",
+    "*/test_*.py",
+    "*/__pycache__/*",
+    "*/venv/*",
+    "*/env/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+show_missing = true
+precision = 1
+
+[tool.coverage.html]
+directory = "htmlcov"
+
 [dependency-groups]
 dev = [
+    "coverage[toml]",
     "ipython",
     "mkdocs",
     "mkdocs-material",
     "mkdocstrings[python]",
     "mypy",
     "pyright",
     "pytest>=8.4.1",
+    "pytest-cov",
     "ruff>=0.12.11",
     "yapf",
 ]