mirror of
https://github.com/davidhalter/typeshed.git
synced 2026-01-10 13:32:26 +08:00
README.md: update for the times (#4757)
Fixes #4754 Co-authored-by: hauntsaninja <>
This commit is contained in:
19
README.md
19
README.md
@@ -92,18 +92,17 @@ requests. If you have questions related to contributing, drop by the [typing Git
|
||||
|
||||
## Running the tests
|
||||
|
||||
The tests are automatically run by Travis CI on every PR and push to
|
||||
the repo. Note that it can be useful to enable Travis CI on your own fork of
|
||||
typeshed.
|
||||
The tests are automatically run on every PR and push to
|
||||
the repo.
|
||||
|
||||
There are several tests:
|
||||
- `tests/mypy_test.py`
|
||||
runs tests against [mypy](https://github.com/python/mypy/)
|
||||
- `tests/pytype_test.py` runs tests against
|
||||
tests typeshed with [mypy](https://github.com/python/mypy/)
|
||||
- `tests/pytype_test.py` tests typeshed with
|
||||
[pytype](https://github.com/google/pytype/).
|
||||
- `tests/mypy_selftest.py` checks mypy's code base using this version of
|
||||
- `tests/mypy_self_check.py` checks mypy's code base using this version of
|
||||
typeshed.
|
||||
- `tests/mypy_test_suite.py` runs mypy's test suite using this version of
|
||||
- `tests/mypy_test_suite.py` runs a subset of mypy's test suite using this version of
|
||||
typeshed.
|
||||
- `tests/check_consistent.py` checks certain files in typeshed remain
|
||||
consistent with each other.
|
||||
@@ -153,10 +152,10 @@ Run using: `(.venv3)$ python3 tests/pytype_test.py`
|
||||
|
||||
This test works similarly to `mypy_test.py`, except it uses `pytype`.
|
||||
|
||||
### mypy_selftest.py
|
||||
### mypy_self_check.py
|
||||
|
||||
This test requires Python 3.6 or higher; Python 3.6.1 or higher is recommended.
|
||||
Run using: `(.venv3)$ python3 tests/mypy_selftest.py`
|
||||
Run using: `(.venv3)$ python3 tests/mypy_self_check.py`
|
||||
|
||||
This test checks mypy's code base using mypy and typeshed code in this repo.
|
||||
|
||||
@@ -181,7 +180,7 @@ Run using `(.venv3)$ python3 tests/stubtest_test.py`
|
||||
This test compares the stdlib stubs against the objects at runtime. Because of
|
||||
this, the output depends on which version of Python and on what kind of system
|
||||
it is run.
|
||||
Thus the easiest way to run this test is by enabling Travis CI on your fork;
|
||||
Thus the easiest way to run this test is via Github Actions on your fork;
|
||||
if you run it locally, it'll likely complain about system-specific
|
||||
differences (in e.g, `socket`) that the type system cannot capture.
|
||||
If you need a specific version of Python to repro a CI failure,
|
||||
|
||||
Reference in New Issue
Block a user