.PHONY: all clean docs_build docs_clean docs_linkcheck api_docs_build api_docs_clean api_docs_linkcheck format lint test tests test_watch integration_tests docker_tests help extended_tests # Default target executed when no arguments are given to make. all: help ###################### # TESTING AND COVERAGE ###################### # Define a variable for the test file path. TEST_FILE ?= tests/unit_tests/ # Run unit tests and generate a coverage report. coverage: poetry run pytest --cov \ --cov-config=.coveragerc \ --cov-report xml \ --cov-report term-missing:skip-covered \ $(TEST_FILE) test tests: poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE) extended_tests: poetry run pytest --disable-socket --allow-unix-socket --only-extended tests/unit_tests test_watch: poetry run ptw --snapshot-update --now . -- -x --disable-socket --allow-unix-socket --disable-warnings tests/unit_tests test_watch_extended: poetry run ptw --snapshot-update --now . -- -x --disable-socket --allow-unix-socket --only-extended tests/unit_tests integration_tests: poetry run pytest tests/integration_tests docker_tests: docker build -t my-langchain-image:test . docker run --rm my-langchain-image:test check_imports: $(shell find langchain -name '*.py') poetry run python ./scripts/check_imports.py $^ ###################### # LINTING AND FORMATTING ###################### # Define a variable for Python and notebook files. PYTHON_FILES=. MYPY_CACHE=.mypy_cache lint format: PYTHON_FILES=. lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/langchain --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$') lint_package: PYTHON_FILES=langchain lint_tests: PYTHON_FILES=tests lint_tests: MYPY_CACHE=.mypy_cache_test lint lint_diff lint_package lint_tests: ./scripts/check_pydantic.sh . ./scripts/lint_imports.sh poetry run ruff . [ "$(PYTHON_FILES)" = "" ] || poetry run ruff format $(PYTHON_FILES) --diff [ "$(PYTHON_FILES)" = "" ] || poetry run ruff --select I $(PYTHON_FILES) [ "$(PYTHON_FILES)" = "" ] || mkdir -p $(MYPY_CACHE) && poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE) format format_diff: [ "$(PYTHON_FILES)" = "" ] || poetry run ruff format $(PYTHON_FILES) [ "$(PYTHON_FILES)" = "" ] || poetry run ruff --select I --fix $(PYTHON_FILES) spell_check: poetry run codespell --toml pyproject.toml spell_fix: poetry run codespell --toml pyproject.toml -w ###################### # HELP ###################### help: @echo '====================' @echo 'clean - run docs_clean and api_docs_clean' @echo 'docs_build - build the documentation' @echo 'docs_clean - clean the documentation build artifacts' @echo 'docs_linkcheck - run linkchecker on the documentation' @echo 'api_docs_build - build the API Reference documentation' @echo 'api_docs_clean - clean the API Reference documentation build artifacts' @echo 'api_docs_linkcheck - run linkchecker on the API Reference documentation' @echo '-- LINTING --' @echo 'format - run code formatters' @echo 'lint - run linters' @echo 'spell_check - run codespell on the project' @echo 'spell_fix - run codespell on the project and fix the errors' @echo '-- TESTS --' @echo 'coverage - run unit tests and generate coverage report' @echo 'test - run unit tests' @echo 'tests - run unit tests (alias for "make test")' @echo 'test TEST_FILE= - run all tests in file' @echo 'extended_tests - run only extended unit tests' @echo 'test_watch - run unit tests in watch mode' @echo 'integration_tests - run integration tests' @echo 'docker_tests - run unit tests in docker' @echo '-- DOCUMENTATION tasks are from the top-level Makefile --'