docs(prompt): add docstrings #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "**" | |
| pull_request: {} | |
| env: | |
| CI: true | |
| COLUMNS: 120 | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - name: Install dependencies | |
| run: uv sync --python 3.12 --frozen --all-extras --all-packages --group lint | |
| - uses: pre-commit/[email protected] | |
| with: | |
| extra_args: --all-files --verbose | |
| env: | |
| SKIP: no-commit-to-branch | |
| - run: uv build --all-packages | |
| - run: ls -lh dist/ | |
| # mypy and lint are a bit slower than other jobs, so we run them separately | |
| mypy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - name: Install dependencies | |
| run: uv sync --python 3.12 --frozen --no-dev --group lint | |
| - run: make typecheck-mypy | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - run: uv sync --python 3.12 --frozen --group docs | |
| # always build docs to check it works without insiders packages | |
| - run: make docs | |
| - run: make docs-insiders | |
| if: github.event.pull_request.head.repo.full_name == github.repository | |
| env: | |
| PPPR_TOKEN: ${{ secrets.PPPR_TOKEN }} | |
| - run: tree site | |
| test-live: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| if: "github.event.pull_request.head.repo.full_name == github.repository || github.event_name == 'push'" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - uses: pydantic/ollama-action@v3 | |
| with: | |
| model: qwen2:0.5b | |
| - run: > | |
| uv run | |
| --python 3.12 | |
| --frozen | |
| --package pydantic-ai-slim | |
| --extra openai | |
| --extra vertexai | |
| --extra groq | |
| --extra anthropic | |
| --extra mistral | |
| pytest tests/test_live.py -v | |
| --durations=100 | |
| env: | |
| PYDANTIC_AI_LIVE_TEST_DANGEROUS: "CHARGE-ME!" | |
| OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} | |
| GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }} | |
| GOOGLE_SERVICE_ACCOUNT_CONTENT: ${{ secrets.GOOGLE_SERVICE_ACCOUNT_CONTENT }} | |
| GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }} | |
| ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }} | |
| MISTRAL_API_KEY: ${{ secrets.MISTRAL_API_KEY }} | |
| test: | |
| name: test on ${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
| env: | |
| UV_PYTHON: ${{ matrix.python-version }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - run: mkdir coverage | |
| # run tests with just `pydantic-ai-slim` dependencies | |
| - run: uv run --frozen --package pydantic-ai-slim coverage run -m pytest | |
| env: | |
| COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-slim | |
| - run: uv run --frozen coverage run -m pytest | |
| env: | |
| COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-standard | |
| - run: uv run --frozen --all-extras coverage run -m pytest | |
| env: | |
| COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-all-extras | |
| - run: uv run --frozen --all-extras python tests/import_examples.py | |
| - name: store coverage files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-${{ matrix.python-version }} | |
| path: coverage | |
| include-hidden-files: true | |
| coverage: | |
| runs-on: ubuntu-latest | |
| needs: [test] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: get coverage files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| merge-multiple: true | |
| path: coverage | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - run: uv sync --frozen --package pydantic-ai-slim | |
| - run: uv run --frozen coverage combine coverage | |
| - run: uv run --frozen coverage html --show-contexts --title "PydanticAI coverage for ${{ github.sha }}" | |
| - name: Store coverage html | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-html | |
| path: htmlcov | |
| include-hidden-files: true | |
| - run: uv run --frozen coverage report --fail-under 95 | |
| # https://github.com/marketplace/actions/alls-green#why used for branch protection checks | |
| check: | |
| if: always() | |
| needs: [lint, mypy, docs, test-live, test, coverage] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} | |
| allowed-skips: test-live | |
| release: | |
| needs: [check] | |
| if: "success() && startsWith(github.ref, 'refs/tags/')" | |
| runs-on: ubuntu-latest | |
| environment: release | |
| permissions: | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: astral-sh/setup-uv@v3 | |
| with: | |
| enable-cache: true | |
| - name: check GITHUB_REF matches package version | |
| uses: samuelcolvin/[email protected] | |
| with: | |
| version_file_path: pyproject.toml | |
| - run: uv build --all-packages | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| skip-existing: true |