noxfile.py (96 lines of code) (raw):

# Licensed to Elasticsearch B.V. under one or more contributor # license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright # ownership. Elasticsearch B.V. licenses this file to you under # the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. import os import nox SOURCE_DIR = os.path.dirname(os.path.abspath(__file__)) SOURCE_FILES = ( "docs/sphinx/conf.py", "noxfile.py", "elasticsearch/", "test_elasticsearch/", "utils/", ) # Allow building aiohttp when no wheels are available (eg. for recent Python versions) INSTALL_ENV = {"AIOHTTP_NO_EXTENSIONS": "1"} def pytest_argv(): junit_xml = os.path.join(SOURCE_DIR, "junit", "elasticsearch-py-junit.xml") return [ "pytest", "--cov-report=term-missing", "--cov=elasticsearch", f"--junitxml={junit_xml}", "--log-level=DEBUG", "--cache-clear", "-vv", ] @nox.session(python=["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]) def test(session): session.install("-e", ".[dev]", env=INSTALL_ENV, silent=False) session.run(*pytest_argv(), *session.posargs) @nox.session(python=["3.8", "3.13"]) def test_otel(session): session.install( ".[dev]", "opentelemetry-api", "opentelemetry-sdk", silent=False, ) argv = pytest_argv() + ["-m", "otel"] session.run(*argv, env={"TEST_WITH_OTEL": "1"}) @nox.session() def format(session): session.install( ".", "black~=25.0", "isort~=6.0", "flynt", "unasync>=0.6.0", "jinja2" ) session.run("python", "utils/run-unasync.py") session.run("python", "utils/run-unasync-dsl.py") session.run("python", "utils/dsl-generator.py", env={"PYTHONPATH": "./"}) session.run("isort", "--profile=black", *SOURCE_FILES) session.run("flynt", *SOURCE_FILES) session.run("black", *SOURCE_FILES) session.run("python", "utils/license-headers.py", "fix", *SOURCE_FILES) @nox.session() def lint(session): # Check that importing the client still works without optional dependencies session.install(".", env=INSTALL_ENV) session.run("python", "-c", "from elasticsearch import Elasticsearch") session.run("python", "-c", "from elasticsearch._otel import OpenTelemetry") session.install( "flake8", "black~=25.0", "mypy", "isort~=6.0", "types-requests", "types-python-dateutil", "unasync>=0.6.0", ) session.run("isort", "--check", "--profile=black", *SOURCE_FILES) session.run("black", "--check", *SOURCE_FILES) session.run("python", "utils/run-unasync.py", "--check") session.run("python", "utils/run-unasync-dsl.py", "--check") session.run("flake8", *SOURCE_FILES) session.run("python", "utils/license-headers.py", "check", *SOURCE_FILES) session.install(".[async,requests,orjson,pyarrow,vectorstore_mmr]", env=INSTALL_ENV) # Run mypy on the package, the type examples and the DSL examples session.run( "mypy", "--strict", "--implicit-reexport", "--explicit-package-bases", "--show-error-codes", "--enable-error-code=ignore-without-code", "elasticsearch/", "test_elasticsearch/test_types/", "examples/dsl/", ) # Make sure we don't require aiohttp to be installed for users to # receive type hint information from mypy. session.run("python", "-m", "pip", "uninstall", "--yes", "aiohttp") session.run( "mypy", "--strict", "--implicit-reexport", "--explicit-package-bases", "--show-error-codes", "elasticsearch/", "test_elasticsearch/test_types/sync_types.py", ) @nox.session() def docs(session): session.install(".[docs]") session.run( "sphinx-build", "-W", "docs/sphinx/", "docs/sphinx/_build", "-b", "html" )