Clearly differentiate between venv and tox setups in CONTRIBUTING.md #16067
Conversation
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
The blurb on how to use `tox` existed in the middle of the [**Running tests** section](/mypy/blob/master/CONTRIBUTING.md#running-tests), and was bookended without headings by non-`tox` workflow material. This more clearly delineates between `tox` and non-`tox` workflows for the newcomer. This also non-invasively allows running arbitrary commands using `testenv:dev`. ``` sh % tox -e dev # ... works as before % tox -e dev -- mypy runtests.py # ... runs dev commands and then runs mypy on runtests.py dev: commands[2]> mypy runtests.py Success: no issues found in 1 source file # ... % tox -e dev --override testenv:dev.allowlist_externals+=env -- env # ... runs dev commands and then runs env in dev environment test_case.py dev: commands[2]> env HOME=/home/posita LANG=en_US.UTF-8 LANGUAGE=en_US.UTF8 TERM=xterm-256color PATH=/home/posita/dev/3p/mypy/.tox/dev/bin:/home/posita/dev/3p/mypy/venv/bin:... PYTHONHASHSEED=... PIP_DISABLE_PIP_VERSION_CHECK=1 PYTHONIOENCODING=utf-8 TOX_ENV_NAME=dev TOX_WORK_DIR=/home/posita/dev/3p/mypy/.tox TOX_ENV_DIR=/home/posita/dev/3p/mypy/.tox/dev VIRTUAL_ENV=/home/posita/dev/3p/mypy/.tox/dev TOX_PACKAGE=/home/posita/dev/3p/mypy/.tox/.tmp/package/28/mypy-1.7.0+dev.6d19f9ddf110d4ad3af63d472e8d7aaf69e6260c.dirty-0.editable-py3-none-any.whl # ... ```
|
The failing check in this PR also seems present on the parent commit in |
yeah: |
This comment has been minimized.
This comment has been minimized.
hauntsaninja
reviewed
Sep 7, 2023
CONTRIBUTING.md
Outdated
| tox -e dev --override testenv:dev.allowlist_externals+=env -- env # inspect the environment | ||
| ``` | ||
|
|
||
| If you don't already have `tox` installed, you can use a virtual environment. |
There was a problem hiding this comment.
I think we don't need this last bit, since it's covered above
posita
commented
Sep 7, 2023
| ``` | ||
|
|
||
| If you don't already have `tox` installed, you can use a virtual environment as | ||
| described above to install `tox` via `pip` (e.g., ``python3 -m pip install tox``). |
There was a problem hiding this comment.
@hauntsaninja, please let me know if this addresses your #16067 (comment), or you think this should be even shorter or eliminated altogether.
|
Diff from mypy_primer, showing the effect of this PR on open source code: vision (https://github.com/pytorch/vision): typechecking got 1.23x slower (43.3s -> 53.3s)
(Performance measurements are based on a single noisy sample)
|
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation changes are visible here. Commit message below.
The blurb on how to use
toxexisted in the middle of the Running tests section, and was bookended without headings by non-toxworkflow material. This more clearly delineates betweentoxand non-toxworkflows for the newcomer.This also non-invasively allows running arbitrary commands using
testenv:dev.