Skip to content

Commit

Permalink
chore: pin tox to work around 3.21 bug
Browse files Browse the repository at this point in the history
  • Loading branch information
kgriffs committed Jan 9, 2021
1 parent 4dc65ec commit 25670ff
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 12 deletions.
12 changes: 8 additions & 4 deletions .github/workflows/create-wheels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ jobs:
FALCON_ASGI_WRAP_NON_COROUTINES: Y
FALCON_TESTING_SESSION: Y
run: |
pip install 'tox>=3.20'
# TODO(kgriffs): Revisit second half of 2021 to see if we still need to pin tox
#
# See also: https://github.com/tox-dev/tox/issues/1777
#
pip install 'tox==3.20'
tox -e wheel_check -- ${{ matrix.pytest-extra }}
- name: Get wheel name
Expand Down Expand Up @@ -177,7 +181,7 @@ jobs:
FALCON_ASGI_WRAP_NON_COROUTINES: Y
FALCON_TESTING_SESSION: Y
run: |
pip install 'tox>=3.20'
pip install 'tox==3.20'
tox -e wheel_check -- ${{ matrix.pytest-extra }}
- name: Get wheel names
Expand Down Expand Up @@ -353,7 +357,7 @@ jobs:
args: |
bash -c "
export PATH=/opt/python/${{ matrix.python-version }}/bin:$PATH &&
pip install 'tox>=3.20' 'pip>=20' &&
pip install 'tox==3.20' 'pip>=20' &&
tox -e wheel_check -- ${{ matrix.pytest-extra }}
"
Expand All @@ -377,7 +381,7 @@ jobs:
args: |
bash -c "
export PATH=/opt/python/${{ matrix.python-version }}/bin:$PATH &&
pip install 'tox>=3.20' 'pip>=20' &&
pip install 'tox==3.20' 'pip>=20' &&
tox -e wheel_check -- ${{ matrix.pytest-extra }}
"
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,14 @@ jobs:
sudo apt-get update
sudo apt-get install -y libunwind-dev
# TODO(kgriffs): Revisit second half of 2021 to see if we still need to pin tox
#
# See also: https://github.com/tox-dev/tox/issues/1777
#
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install coverage tox
pip install coverage tox==3.20
python --version
pip --version
tox --version
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ You can check all this by running the following from within the Falcon project d
$ tools/mintest.sh
```

You may also use Python 3.6 or 3.7 if you don't have 3.8 installed on your system. Substitute "py36" or "py37" as appropriate. For example:
You may also use Python 3.6 or 3.7 if you don't have 3.8 installed on your system. Substitute "py36" or "py37" as appropriate. Note also that due to a bug introduced in tox version 3.21, you will need to pin to 3.20 in order to run Falcon's test suite. For example:


```bash
$ pip install -U tox coverage
$ pip install -U tox==3.20 coverage
$ rm -f .coverage.*
$ tox -e pep8 && tox -e py35,py37 && tools/testing/combine_coverage.sh
```
Expand Down Expand Up @@ -141,11 +141,11 @@ $ xdg-open docs/_build/html/index.html
following guidelines for docstrings:
* Docstrings should utilize the [napolean style][docstrings] in order to make them read well, regardless of whether they are viewed through `help()` or on [Read the Docs][rtd].
* Docstrings should begin with a short (~70 characters or less) summary line that ends in a period.
* The summary line should begin immediately after the opening quotes (do not add
* The summary line should begin immediately after the opening quotes (do not add
a line break before the summary line)
* The summary line should describe what it is if it is a class (e.g., "An
* The summary line should describe what it is if it is a class (e.g., "An
asynchronous, file-like object for reading ASGI streams.")
* The summary line should describe what it does when called, if it is a
* The summary line should describe what it does when called, if it is a
function, structured as an imperative (e.g., "Delete a header that was previously set for this response.")
* Please try to be consistent with the way existing docstrings are formatted. In particular, note the use of single vs. double backticks as follows:
* Double backticks
Expand Down
6 changes: 5 additions & 1 deletion tools/mintest.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
#!/usr/bin/env bash

pip install -U tox coverage
# TODO(kgriffs): Revisit second half of 2021 to see if we still need to pin tox
#
# See also: https://github.com/tox-dev/tox/issues/1777
#
pip install -U tox==3.20 coverage

rm -f .coverage.*

Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#
# Which is equivalent to:
#
# $ pip install -U tox coverage
# $ pip install -U tox==3.20 coverage
# $ rm -f .coverage.*
# $ tox -e pep8 && tox -e py38 && tools/testing/combine_coverage.sh
#
Expand Down

0 comments on commit 25670ff

Please sign in to comment.