python-sdk/.github/workflows/quality.yml at main · hyperbrowserai/python-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
name: Quality

on:
  pull_request:
    branches: [main]
  push:
    branches: [main]
  merge_group:
    types: [checks_requested]
  workflow_dispatch:

concurrency:
  group: python-quality-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  lint:
    name: lint
    runs-on: ubuntu-24.04

    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"
          cache: pip

      - name: Install Ruff
        run: python -m pip install --upgrade pip ruff==0.3.7

      - name: Run Ruff
        run: ruff check .

  test:
    name: test (Python ${{ matrix.python-version }})
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        python-version:
          - "3.8"
          - "3.9"
          - "3.10"
          - "3.11"
          - "3.12"
          - "3.13"
          - "3.14"

    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip

      - name: Install package and test dependencies
        shell: bash
        run: |
          python -m pip install --upgrade pip
          if [[ "${{ matrix.python-version }}" == "3.8" ]]; then
            pytest_version="8.3.5"
          else
            pytest_version="8.4.2"
          fi
          python -m pip install --editable . "pytest==$pytest_version"

      - name: Run non-E2E tests
        run: |
          python -m pytest tests \
            --ignore=tests/sandbox/e2e \
            --ignore=tests/test_typing_contract.py

  typing:
    name: typing
    runs-on: ubuntu-24.04

    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"
          cache: pip

      - name: Install package and typing dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install \
            --editable . \
            mypy==1.14.1 \
            pyright==1.1.411 \
            pytest==8.3.5

      - name: Verify public request types with mypy and Pyright
        run: |
          python -m pytest \
            tests/test_typed_request_surface.py \
            tests/test_typing_contract.py

  package:
    name: package
    runs-on: ubuntu-24.04

    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"
          cache: pip

      - name: Install build tooling
        run: python -m pip install --upgrade build poetry==2.4.1 twine

      - name: Check Poetry lock file
        run: poetry check --lock

      - name: Build distributions
        run: python -m build

      - name: Check distribution metadata
        run: python -m twine check dist/*

      - name: Install wheel in an isolated environment
        shell: bash
        run: |
          python -m venv "$RUNNER_TEMP/wheel-smoke"
          "$RUNNER_TEMP/wheel-smoke/bin/python" -m pip install \
            dist/*.whl \
            mypy==1.14.1 \
            pyright==1.1.411

      - name: Verify installed-wheel typing
        shell: bash
        run: |
          mkdir -p "$RUNNER_TEMP/typecheck"
          cp tests/typecheck/valid_requests.py "$RUNNER_TEMP/typecheck/"
          cp tests/typecheck/invalid_requests.py "$RUNNER_TEMP/typecheck/"
          cd "$RUNNER_TEMP/typecheck"

          "$RUNNER_TEMP/wheel-smoke/bin/python" - <<'PY'
          from importlib.resources import files

          assert files("hyperbrowser").joinpath("py.typed").is_file()
          PY

          "$RUNNER_TEMP/wheel-smoke/bin/python" -m mypy \
            --follow-imports=silent \
            --ignore-missing-imports \
            --check-untyped-defs \
            --no-error-summary \
            --no-pretty \
            --no-incremental \
            valid_requests.py

          if "$RUNNER_TEMP/wheel-smoke/bin/python" -m mypy \
            --follow-imports=silent \
            --ignore-missing-imports \
            --check-untyped-defs \
            --no-error-summary \
            --no-pretty \
            --no-incremental \
            invalid_requests.py; then
            echo "mypy unexpectedly accepted invalid installed-wheel requests"
            exit 1
          fi

          "$RUNNER_TEMP/wheel-smoke/bin/python" -m pyright \
            --pythonpath "$RUNNER_TEMP/wheel-smoke/bin/python" \
            valid_requests.py

          if "$RUNNER_TEMP/wheel-smoke/bin/python" -m pyright \
            --pythonpath "$RUNNER_TEMP/wheel-smoke/bin/python" \
            invalid_requests.py; then
            echo "Pyright unexpectedly accepted invalid installed-wheel requests"
            exit 1
          fi