Add type hints to our public API (PEPs 484 & 561) #1270
Conversation
Zac-HD
force-pushed
the
public-hints
branch
3 times, most recently
from
cb3d6c2
to
20c5eba
Compare
|
🎉, I finally got the build working! The solution is to set the CC @DRMacIver for review; it's mostly a matter of documentation and what counts as public API I think 😄 |
|
python/mypy#5218 is my report of (the first part I isolated of) the problem with |
hypothesis-python/docs/details.rst
Outdated
|
|
||
| We may also find more precise ways to describe the type of various | ||
| interfaces, or change their type and runtime behaviour togther in a way | ||
| which is otherwise backwards-compatible. We often ommit type hints for |
whole-repo-tests/test_type_hints.py
Outdated
| env=dict(os.environ, MYPYPATH=tools.PYTHON_SRC), | ||
| ).stdout.read() | ||
| assert len(out.splitlines()) == 1 | ||
| typ = out.split('error: Revealed type is ')[1].strip().strip("'") |
There was a problem hiding this comment.
I have no idea what Mypy successful or unsuccessful output looks like – a brief comment here with examples of both would help satisfy me that this string parsing code is working correctly.
There was a problem hiding this comment.
I'll add a link to the docs and an example of the output we're parsing. (done)
Zac-HD
force-pushed
the
public-hints
branch
5 times, most recently
from
6d58963
to
16c0026
Compare
whole-repo-tests/test_type_hints.py
Outdated
| ('booleans().filter(bool)', 'bool'), | ||
| ('lists(none())', 'list[None]'), | ||
| ('dictionaries(integers(), datetimes())', 'dict[int, datetime.datetime]'), | ||
| ('recursive(integers(), lists)', 'Union[list[Ex`-1], int]'), |
There was a problem hiding this comment.
Ex is the type of the example which SearchStrategy is generic and covariant in; and Ex`-1 appears to denote recursion in this type - that is, Ex`-1 == Union[list[Ex`-2], int] and so on.
I'll add a comment to this effect...
hypothesis-python/setup.py
Outdated
| @@ -86,7 +86,7 @@ def local_file(name): | |||
| author_email='david@drmaciver.com', | |||
| packages=setuptools.find_packages(SOURCE), | |||
| package_dir={'': SOURCE}, | |||
| # package_data={'': ['py.typed']}, # un-comment to release type hints | |||
| package_data={'': ['py.typed']}, | |||
There was a problem hiding this comment.
I believe it is better to explicitly mark the package name this file is from.
Note: need more validation to enforce this
As suggested by Ethan Smith
The test could only pass if no padding was generated, so adding pattern boundaries makes matching faster and exact generation less flaky.
|
✨ Finally! 🎉 |
|
FWIW, support for editable installs just landed and will be in the next mypy release. |
This PR finally closes #200 🎉
For anyone manually exploring this PR, note that Mypy does not find hints installed in editable mode (
pip install -e .); you have to do a straightpip install .- see python/mypy#5007 for work on a fix. This does not affect our CI setup as we don't use editable mode there, but is annoying in local development.