61 Commits

Author SHA1 Message Date
Shantanu
c3e04054cf README.md: update for the times (#4757)
Fixes #4754

Co-authored-by: hauntsaninja <>
2020-11-10 20:52:57 +01:00
Sebastian Rittau
d2a7889fe0 Drop support for Python 3.5 (#4675)
Python 3.5 EOL was on 2020-09-30.
2020-11-02 16:18:20 +01:00
Sebastian Rittau
0583738a41 Add a mypy self test (#4337)
Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
Co-authored-by: hauntsaninja <>
2020-10-24 17:58:04 -07:00
Sebastian Rittau
473044cf1f Add information about removing third-party packages (#4637)
Closes: #4608
2020-10-09 16:27:56 +02:00
Oleg Höfling
308b25f8dc replace travis status badge with gh actions one (#4628) 2020-10-06 18:10:45 +02:00
Jürgen Gmach
ee44a5c323 Update test setup description (#4307)
The description, as it was, did not work with an older version of pip,
as the installation errored. An updated version of pip fixes the installation problem.
2020-07-03 14:31:22 +02:00
wouter bolsterlee
3efb675dba Use ‘exclude list’ instead of ‘blacklist’ (#4297)
This replaces all uses of ‘blacklist’ with ‘exclude list’. Benefits:

- It is racially neutral terminology; see e.g. [1]

- It makes the meaning more clear. In fact, with the popular Python
  autoformatter called ‘black’, also used by this project, files can be
  ‘blackened’ which is something completely different from them being on
  a blacklist.

[1] https://chromium.googlesource.com/chromium/src/+/master/styleguide/inclusive_code.md#racially-neutral
2020-07-01 09:10:37 +02:00
Shantanu
aa6e3efcca README.md: better document test_stubtest pitfall (#3793)
Document that the test will likely fail locally, to help cases like #3782
2020-02-29 13:58:47 +01:00
Shantanu
5324bd02f2 typeshed: run stubtest in CI (#3727)
* README.md: refactor "Running the tests"

This organises the section a little better. Previously some tests were
unmentioned; it read as if mypy_test and pytype_test were the only
tests. The section is now organised by test, making it easy to keep
track of the requirements and details of each. This also makes it
easier to add documentation for stubtest.

Also mention turning on Travis CI on your fork, since that is very
useful.

* README.md: document stubtest_test.py

* stubtest_test: add it

* travis: add stubtest_test to CI

* stubtest_test: add whitelists
2020-02-20 22:16:52 -08:00
Sebastian Rittau
0e3286bc43 Remove consent requirement for third-party stubs (#3643)
This was discussed a while ago on typing-sig. Consequently the
requirement of asking third-party maintainers for permission was
removed from PEP 484.
2020-01-23 15:01:30 +01:00
Brett Cannon
5e051d8848 Clarify contributions are from people external to the project (#3421)
Closes #3420
2019-10-29 17:17:04 -07:00
Guido van Rossum
8ec25708d9 Update 'format' README section -- don't imply it is executable (#3350) 2019-10-12 19:18:34 +02:00
Sebastian Rittau
9ccf9356bf Remove Python 3.4 support (#3147)
Closes #3123
2019-07-27 10:58:21 +02:00
Sebastian Rittau
0e5b3770f8 Add a "pull requests welcome" batch (#3033)
We get quite a few bug reports where after a maintainer writes
"Pull Requests Welcome" we get a PR by the submitter. Maybe this
badge will help a bit to encourage people directly submit PRs,
reducing maintainer workload.
2019-06-05 07:51:01 -07:00
Sean McLemon
0efb2469d4 README.md suggests running tests with PYTHONPATH instead of MYPYPATH (#2813)
* The 'Running the tests' section suggests setting PYTHONPATH instead of MYPYPATH when testing typeshed as a submodule of mypy

* actually PYTHONPATH was the right var to set ... but it was set slightly wrong after a directory reshuffle
2019-02-25 09:34:08 -08:00
Rebecca Chen
eb09e2898b Update pytype_test to be easier to run manually. (#2469)
* Moves the pytype installation to requirements-tests-py3.txt, now
  that pytype can run under Python 3.5+.
* Changes tests/pytype_test.py to not require a --python{version}-exe
  argument when it can automatically find the Python interpreter, and
  cleans up a few typos and out-of-date things.
* Updates the appropriate documentation.
* Updates .travis.yml.
2018-09-21 09:38:33 -07:00
Sebastian Rittau
fa74160e1f Drop support for Python 3.3 (#2258)
Closes #2257.
2018-06-19 15:37:13 -07:00
Martin DeMello
754789b031 modify pytype_test to run from within pytype too, and support python3 (#1817) 2018-01-22 12:18:58 -08:00
Sebastian Rittau
9656febaee Merge style guide from README.md into CONTRIBUTING.md (#1696) 2017-11-08 09:02:59 -08:00
Sebastian Rittau
cbea45f19a Fix style example (#1689)
* Replace `self` with `cls` in classmethod
* Group classmethods together, as in the actual stub
* Use float instead of Union[int, float] in coding style example
2017-10-26 10:54:18 -04:00
Sebastian Rittau
0b0a9588f3 Document default argument syntax (#1687) 2017-10-26 00:57:46 -04:00
Matthias Kramm
a5d044361b Add "conventions" section to README.md (#1470)
This documents, among others, the unicode -> Union[bytes, unicode] promotion that python/peps#302 removes from PEP 484.
2017-07-18 13:58:24 -07:00
Svyatoslav Ilinskiy
45f2d9d625 Add travis badge (#1474) 2017-07-10 14:23:05 -07:00
Ethan Smith
ac36193550 Add Gitter chat badge (#1399)
And update other gitter links.
2017-06-12 15:55:05 -07:00
amstree
e006fafe2a fix typo (#1367) 2017-05-28 19:09:29 -07:00
Emily Morehouse
a5bd84c766 Fixing small typo in README - should explicitly call python3 when running tests (#1290) 2017-05-22 14:07:39 -07:00
Guido van Rossum
2216616195 Add explanation on how to use typeshed with mypy etc. (#1284) 2017-05-22 10:47:51 -07:00
Jelle Zijlstra
c05570cf00 fix example in README.md (#1217)
"int or float" isn't valid.
2017-04-26 08:15:38 -07:00
Jelle Zijlstra
3101768f12 drop 3.2 (#1213)
Closes #1145.
2017-04-25 17:15:49 -07:00
Jelle Zijlstra
e50fcaf658 add mypy_selftest.py (#1102)
* add mypy_selftest.py
* add selftest to Travis
2017-04-17 11:17:27 -07:00
Guido van Rossum
761ee6afb3 Update configs and instructions for running tests manually. (#1137)
- Switch requirements-tests-py3.txt to use mypy GitHub master.
- Exclude .venv{2,3} (suggested in README.md) in .flake8 and .gitignore.
- Update instructions in README.md to be working.
- Remove runtests.sh script and mentions of it -- I can't get it to work
  and the three steps are easily run by hand.
2017-04-08 19:06:54 -07:00
David Fisher
2861674784 Remove unnecessary --fast-parser flag to mypy (#977)
It's now on by default, and the flag will eventually be removed.
2017-03-07 15:01:17 -08:00
Lukasz Langa
5d1a162db9 Mention CONTRIBUTING.md updates on stub versioning in the README
This makes the README less wordy and makes the information more consistent by
just storing it in a single place.
2017-01-20 11:49:55 -08:00
Łukasz Langa
08432484d5 CONTRIBUTING.md (#790)
Fixes #772.
2016-12-24 08:46:08 -08:00
Lukasz Langa
8c5c788a4d Enable flake8-pyi plugin to automatically include *.pyi files
This simplifies running flake8 tests and reduces the amount of F821 errors
reported (flake8-pyi enables support for forward references in *.pyi files).
The error code is left disabled until I clean up the remaining issues.
2016-12-21 00:56:01 -08:00
Lukasz Langa
79d8757f1f Enable flake8 tests
Ran both by Travis and locally. There's some setup required, README updated.
A few important Flake8 checks are still disabled, we're going to enable them as
soon as the stubs are fixed and we can reliably run Flake8 locally with Python
3.6.
2016-12-20 04:07:44 -08:00
George King
4d59c04c16 Fix README.md to name mypy_test.py correctly. (#737) 2016-12-05 11:18:33 -08:00
Lukasz Langa
16c3af3068 Update README.md to mention 3.6 and --fast-parser 2016-11-26 20:27:50 -08:00
Hugo
b9733f5717 Formatting and typos (#707) 2016-11-24 09:31:10 +00:00
TrueBrain
15ec66cdd6 Consider __doc__ always Optional. (#641)
python/mypy#2380 showed a discrepancy between object and FunctionType in stdlib2. The first defined __doc__ to be str, the second Optional[str]. As FunctionType depends on object, this is no longer valid.

As suggested by @gvanrossum in python/mypy#2380, all __doc__ should be considered Optional.

(Final verdict was just to remove most __doc__ attributes since it's inherited from object.)
2016-10-30 11:48:23 -07:00
Guido van Rossum
fed966cf7f Explain how to run the tests 2016-10-28 08:47:31 -07:00
Guido van Rossum
bf319675c4 Clarify how to get consent from third party package owners. 2016-10-17 13:19:33 -07:00
Matthias Kramm
828f42e350 Fix syntax in README.md. 2016-08-26 13:35:47 -07:00
Guido van Rossum
56abd1e54b Add note about obtaining consent of package owner for third-party stubs. 2016-04-06 12:47:26 -07:00
Guido van Rossum
71d15d6943 Remove outdated things from README. 2016-01-14 09:11:38 -08:00
Matthias Kramm
4fe8915d44 Add missing '-> None' to all __init__ methods. 2015-11-09 10:25:11 -08:00
Matthias Kramm
617e93fb11 add link to o11c/stubtool 2015-10-28 13:27:11 -07:00
Matthias Kramm
0ef9e34af2 Add paragraph about version checks to README.md 2015-10-01 08:40:00 -07:00
Matthias Kramm
25a41fa052 update README.md 2015-10-01 08:26:15 -07:00
Matthias Kramm
6f667fc1d5 README: move syntax example upwards 2015-09-17 09:21:18 -07:00