Skip to content

Commit 2307823

Browse files
docs: Complete the transition from pyre to pyright
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
1 parent d335446 commit 2307823

2 files changed

Lines changed: 5 additions & 7 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,12 @@ This project uses `tox` to run the tests for different python versions. Intro:
5050
> A comprehensive beginner's introduction to `tox`":_
5151
> https://www.seanh.cc/2018/09/01/tox-tutorial/
5252
53-
`tox` runs `pytest`, `pylint` and static analysis using `mypy`, `pyre`, `pytype`, and `pyright`.
53+
`tox` runs `pytest`, `pylint` and static analysis using `mypy`, `pytype`, and `pyright`.
5454
Links:
5555

5656
- https://mypy.readthedocs.io/en/stable/
5757
- https://microsoft.github.io/pyright/
5858
- https://google.github.io/pytype/
59-
- https://pyre-check.org/
6059

6160
With `tox`, developers can run the full test suite for Python 2.7 and 3.x.
6261
The same test suite is used in GitHub CI:
@@ -78,7 +77,7 @@ Using pip-tools, you can extract the requirements and extras from `pyptoject.tom
7877

7978
```bash
8079
PYTHON=python3.10
81-
EXTRAS=.,test,mypy,pyre,pytype,tox
80+
EXTRAS=.,test,mypy,pytype,tox
8281
PFLAGS="--no-warn-conflicts"
8382
$PYTHON -m pip install pip-tools==7.3.0
8483
$PYTHON -m piptools compile --extra=$EXTRAS -o - pyproject.toml |

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Continuous Integration Tests feature:
2828
- Checking of the combined coverage against the diff to master: Fails if changes are not covered!
2929
- Pylint report in the GitHub Action Summary page, with Warning and Error annotatios, even in the code review.
3030
- Check that changes don't generate pylint warnings (if warning classes which are enabled in .pylintrc)
31-
- Static analysis using `mypy`, `pyre` and `pytype`
31+
- Static analysis using `mypy`, `pylint`, `pyright` and `pytype`
3232

3333
This enforces that any change (besides whitespace):
3434

@@ -72,7 +72,6 @@ For the installation of the general development dependencies, visit [INSTALL.md]
7272
- Test with `python2.7 -m pytest`
7373
- Run `mypy` (without any arguments - The configuration is in `pyproject.toml`)
7474
- Run `./pytype_runner.py`
75-
- Run `./pyre_runner.py`
7675
- Run `tox -e py36-lint` and fix any `Pylint` warnings
7776
- Run `tox -e py310-covcombine-check` and fix any missing diff-coverage.
7877
- Run `tox` for the full CI test suite
@@ -86,7 +85,7 @@ The list of `virtualenvs` configured in tox can be shown using this command: `to
8685
$ tox -av
8786
default environments:
8887
py36-lint -> Run in a py36 virtualenv: Run pylint and fail on warnings remaining on lines in the diff to master
89-
py311-pyre -> Run in a py311 virtualenv: Run pyre for static analyis, only passes using: tox -e py311-pyre
88+
py311-pyright -> Run in a py311 virtualenv: Run pyright for static analyis
9089
py38-pytype -> Run in a py38 virtualenv: Run pytype for static analyis, intro: https://youtu.be/abvW0mOrDiY
9190
py310-covcombine-check -> Run in a py310 virtualenv: Generate combined coverage reports with py27-test coverage merged Run mypy for static analyis
9291

@@ -100,7 +99,7 @@ test -> Run in a python virtualenv: Run pytest in this environ
10099
101100
If you have only one version of Python3, that works too. Use: `tox -e py<ver>-test`
102101

103-
## Static analysis using mypy, pyre, pyright and pytype
102+
## Static analysis using mypy, pylint, pyright and pytype
104103

105104
The preconditions for using static analysis with `mypy` (which passes now but has
106105
only a few type comments) and `pyright` are present now and `mypy` is enabled in `tox`

0 commit comments

Comments
 (0)