Add types to most of trio.testing#2747
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #2747 +/- ##
==========================================
- Coverage 98.93% 98.92% -0.02%
==========================================
Files 113 113
Lines 16752 16770 +18
Branches 3027 3027
==========================================
+ Hits 16574 16590 +16
Misses 123 123
- Partials 55 57 +2
|
jakkdl
left a comment
jakkdl
left a comment
There was a problem hiding this comment.
Mostly just a bunch of nits, looks great overall! And imo the types increase readability of a lot of this code
trio/_tests/verify_types.json
Outdated
| "trio.testing.memory_stream_pump", | ||
| "trio.testing.open_stream_to_socket_listener", | ||
| "trio.testing.trio_test", | ||
| "trio.testing.wait_all_tasks_blocked", |
There was a problem hiding this comment.
If anybody else is confused: wait_all_tasks_blocked is defined in _core/[_generated]_run.py but exported in testing/__init__.py and is removed from this file in #2733
CoolCat467
left a comment
CoolCat467
left a comment
There was a problem hiding this comment.
Looks good except noted, most of noted is that I think a lot of places might accept memoryview objects as well
trio/testing/_check_streams.py
Outdated
| async def do_send_all(data): | ||
| with assert_checkpoints(): | ||
| assert await s.send_all(data) is None | ||
| async def do_send_all(data: bytes) -> None: |
There was a problem hiding this comment.
If s is a Stream object here, it actually accepts bytes | bytearray | memoryview apparently.
There was a problem hiding this comment.
It might, but it doesn't really matter - these are internal nested functions, they're only being called with bytes objects.
|
Merged in master, and while doing so found out that |
A5rocks
left a comment
A5rocks
left a comment
There was a problem hiding this comment.
Looks good, though I'm not really able to review this too well without spending way more time than I'd like :(
(as a sidenote we should probably go through a couple of the tests and type them to make sure the user-side types are sane...)
|
|
||
| def run( | ||
| async_fn: Callable[..., RetT], | ||
| async_fn: Callable[..., Awaitable[RetT]], |
There was a problem hiding this comment.
Geh. I assume there's no other things like this?
|
yeah, once we're done with the public API we should
I think there's diminishing returns in reviewing PRs extremely thoroughly and it's more or less guaranteed that some problems will slip through, but it's more efficient to just catch those later imho - esp as type errors don't affect functionality. |
# Conflicts: # docs/source/conf.py # trio/_tests/verify_types.json
jakkdl
left a comment
jakkdl
left a comment
There was a problem hiding this comment.
Remove the ignores from pyproject.toml:
# 2747
"trio/testing/_network",
"trio/testing/_trio_test",
"trio/testing/_checkpoints",
"trio/testing/_check_streams",
"trio/testing/_memory_streams",
remove testing/* files from the ignorelist in pyproject.toml for mypy
jakkdl
left a comment
jakkdl
left a comment
There was a problem hiding this comment.
or I can just do it myself when there's no other problem :p
5 participants
This adds types to
trio.testing, except for_fake_net(which is considerably more complex and should probably go in its own PR). It's fairly straightforward, though in a few cases I made functions forward on both*args/**kwargsso they can useParamSpec, instead of just one or the other. For_check_streams, to correctly type things the functions now expect/return tuples instead of other iterables that just happen to be 2-long - in practice I don't think people would do anything else anyway. It'll just fail type checking if so.