Run pyright via tox

.github/workflows/ci.yml

@@ -66,6 +66,7 @@ jobs:
     # move to ubuntu-latest when we drop 3.6
     runs-on: ubuntu-20.04
     strategy:
+      fail-fast: false
       matrix:
         python-version:
           [
@@ -92,23 +93,15 @@ jobs:
           cache: "pip"
           cache-dependency-path: "setup.py"
 
-      - name: Upgrade pip and virtualenv to latest
-        run: pip install --upgrade pip virtualenv
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
 
       - uses: stripe/openapi/actions/stripe-mock@master
 
-      - name: Typecheck with pyright
-        run: make pyright
-        # Pip won't install newer versions of pyright on python 3.6 (odd, because pyright is a node module)
-        # so we skip running pyright, and do double duty on python 3.7 using the --pythonversion flag.
-        if: matrix.python-version != '3.6'
-
-      - name: Typecheck with pyright
-        run: make pyright PYRIGHT_ARGS="--pythonversion 3.6"
-        if: matrix.python-version == '3.7'
-
       - name: Test with pytest
-        run: make ci-test
+        run: TOX_ARGS="-e ${{ matrix.python-version }}" make ci-test
 
       - name: Calculate and publish coverage
         run: make coveralls

Makefile

@@ -1,6 +1,6 @@
 VENV_NAME?=venv
 PIP?=pip
-PYTHON?=python3
+PYTHON?=python3.10
 
 venv: $(VENV_NAME)/bin/activate
 
@@ -9,8 +9,8 @@ $(VENV_NAME)/bin/activate: setup.py requirements.txt
 	${VENV_NAME}/bin/python -m pip install -r requirements.txt
 	@touch $(VENV_NAME)/bin/activate
 
-test: venv
-	@${VENV_NAME}/bin/tox -p auto $(TOX_ARGS)
+test: venv pyright
+	@${VENV_NAME}/bin/tox -p auto -e $(PYTHON) $(TOX_ARGS)
 
 test-nomock: venv
 	@${VENV_NAME}/bin/tox -p auto -- --nomock $(TOX_ARGS)
@@ -22,17 +22,7 @@ coveralls: venv
 	@${VENV_NAME}/bin/tox -e coveralls
 
 pyright: venv
-	# In order for pyright to be able to follow imports, we need "editable_mode=compat" to force setuptools to do
-	# an editable install via a .pth file mechanism and not "import hooks". See
-	# the "editable installs" section of https://github.com/microsoft/pyright/blob/main/docs/import-resolution.md#editable-installs
-
-	# This command might fail if we're on python 3.6, as versions of pip that
-	# support python 3.6 don't know about "--config-settings", but in this case
-	# we don't need to pass config-settings anyway because "editable_mode=compat" just
-	# means to perform as these old versions of pip already do.
-	pip install -e . --config-settings editable_mode=compat || pip install -e .
-	@${VENV_NAME}/bin/pyright --version
-	@${VENV_NAME}/bin/pyright $(PYRIGHT_ARGS)
+	@${VENV_NAME}/bin/tox -e pyright $(PYRIGHT_ARGS)
 
 fmt: venv
 	@${VENV_NAME}/bin/tox -e fmt

pyproject.toml

@@ -1,14 +1,14 @@
 [tool.black]
-line-length=79
+line-length = 79
 target-version = [
   "py35",
   "py36",
   "py37",
   "py38",
   "py39",
   "py310",
-#   "py311",  # black 21.12b0 doesn't
-#   "py312",  # support these targets
+  #   "py311",  # black 21.12b0 doesn't
+  #   "py312",  # support these targets
 ]
 exclude = '''
 /(
@@ -23,14 +23,10 @@ exclude = '''
 )
 '''
 [tool.pyright]
-executionEnvironments=[
-  {"root" = "stripe"},
-  {"root" = "tests"}
-]
-include=["stripe", "tests/test_generated_examples.py"]
-exclude=["build", "**/__pycache__"]
-reportMissingTypeArgument=true
-reportUnnecessaryCast=true
-reportUnnecessaryComparison=true
-reportUnnecessaryContains=true
-reportUnnecessaryIsInstance=true
+include = ["stripe", "tests/test_generated_examples.py"]
+exclude = ["build", "**/__pycache__"]
+reportMissingTypeArgument = true
+reportUnnecessaryCast = true
+reportUnnecessaryComparison = true
+reportUnnecessaryContains = true
+reportUnnecessaryIsInstance = true

requirements.txt

@@ -1,14 +1,10 @@
 # cryptography 40.0.0 deprecates support for Python 3.6 and PyPy3 < 7.3.10
 cryptography<40
-tox
 twine
-pyright
-pytest-cov >= 2.8.1, < 2.11.0
-pytest-mock >= 2.0.0
-pytest-xdist >= 1.31.0
-pytest >= 6.0.0
+tox == 4.11.3
+pyright == 1.1.336
 black == 22.8.0
 flake8
-coverage >= 4.5.3, < 5
-coveralls
-tox-gh-actions
+tox-gh-actions == 3.1.3
+
+-r test-requirements.txt

test-requirements.txt

@@ -0,0 +1,6 @@
+pytest-cov >= 2.8.1, < 2.11.0
+pytest-mock >= 2.0.0
+pytest-xdist >= 1.31.0
+pytest >= 6.0.0
+coverage >= 4.5.3, < 5
+coveralls

tox.ini

@@ -7,8 +7,8 @@
 envlist =
     fmt
     lint
+    pyright
     py{312,311,310,39,38,37,36,py3}
-skip_missing_interpreters = true
 
 [gh-actions]
 python =
@@ -31,7 +31,7 @@ description = run the unit tests under {basepython}
 setenv =
     COVERAGE_FILE = {toxworkdir}/.coverage.{envname}
 deps =
-  -r requirements.txt
+  -r test-requirements.txt
 
 # ignore stripe directory as all tests are inside ./tests
 commands = pytest --cov {posargs:-n auto} --ignore stripe
@@ -42,18 +42,30 @@ commands = pytest --cov {posargs:-n auto} --ignore stripe
 # CFLAGS="-I$(brew --prefix openssl@1.1)/include"
 passenv = LDFLAGS,CFLAGS
 
+[testenv:pyright]
+basepython = python3.10
+skip_install = true
+commands =
+  pyright
+deps =
+  -r requirements.txt
+
 [testenv:fmt]
 description = run code formatting using black
 basepython = python3.10
 commands = black . {posargs}
 skip_install = true
+deps =
+  -r requirements.txt
 
 [testenv:lint]
 description = run static analysis and style check using flake8
 basepython = python3.10
 commands =
   python -m flake8  --show-source stripe tests setup.py
 skip_install = true
+deps =
+  -r requirements.txt
 
 [testenv:coveralls]
 description = upload coverage to coveralls.io