OPT: improve docstrings for BaseResponse 📝
#653
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: Check | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| env: | |
| ANSICON: 1 | |
| FORCE_COLOR: 1 | |
| jobs: | |
| check: | |
| name: Check | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: | |
| - '3.9' | |
| - '3.10' | |
| - '3.11' | |
| - '3.12' | |
| - '3.13' | |
| steps: | |
| - name: "🗃 Cache" | |
| if: success() || failure() | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| .cache | |
| .mypy_cache | |
| .pytest_cache | |
| .ruff_cache | |
| key: ${{ runner.os }}-${{ matrix.python-version }}-check | |
| - name: 📥 Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: "✨ Install Poetry" | |
| run: | | |
| pipx install poetry | |
| pipx inject poetry poetry-dynamic-versioning | |
| - name: 🐍 Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: poetry | |
| - name: 📥 Install the package | |
| run: make install | |
| - name: "🪄 Linter: Ruff" | |
| if: success() || failure() | |
| run: make lint/ruff | |
| env: | |
| RUFF_OUTPUT_FORMAT: "github" | |
| RUFF_FORMAT: "github" # ignored in 0.1+ | |
| - name: "🪄 Linter: mypy" | |
| if: success() || failure() | |
| run: make lint/mypy | |
| - name: 🧪 Tests | |
| if: success() || failure() | |
| run: make test | |
| - name: "📦 Build and publish package: dry run" | |
| if: success() || failure() | |
| run: poetry publish --build --dry-run --ansi | |
| - name: 📤 Codecov | |
| if: success() || failure() | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| env_vars: PYTHON | |
| files: coverage.xml | |
| fail_ci_if_error: false |