add a new is_readable method to SocketType (fix #760) #1137
Conversation
trio/tests/test_socket.py
Outdated
| @@ -404,6 +404,23 @@ class MySocket(stdlib_socket.socket): | |||
| assert await client.recv(1) == b"x" | |||
|
|
|||
|
|
|||
| async def test_SocketTupe_is_readable(): | |||
There was a problem hiding this comment.
Typo: "SocketTupe" should be "SocketType"
trio/tests/test_socket.py
Outdated
| assert not client.is_readable() | ||
| await server.send(b"x") | ||
| assert client.is_readable() | ||
| assert await client.recv(1) == b"x" |
There was a problem hiding this comment.
This can be simplified a lot by using socketpair, which directly returns a pair of connected sockets. Something like:
a, b = trio.socket.socketpair()
with a, b:
assert not a.is_readable()
await b.send(b"x")
await _core.wait_readable(a)
assert a.is_readable()
assert await a.recv(1) == b"x"
assert not a.is_readable()I also added a call to wait_readable, just in case the operating system needs a moment to notice that writing to b makes a readable.
newsfragments/760.feature.rst
Outdated
| @@ -0,0 +1,3 @@ | |||
| We added a new ``is_readable`` method to the ``trio.socket.SocketType`` | |||
| object that allows you to check whether a socket is ready to be read | |||
| or not. | |||
There was a problem hiding this comment.
The double-backticks are raw code; since we're referring to objects that have entries in the documentation, we can use single-backticks to link directly:
Trio sockets have a new method `~trio.socket.SocketType.is_readable`, that allows you
to check whether a socket is readable. This is useful for HTTP/1.1 clients.
(The tilde is a shorthand that means "make a link to trio.socket.SocketType.is_readable, but just render it as is_readable".)
Codecov Report
@@ Coverage Diff @@
## master #1137 +/- ##
==========================================
+ Coverage 99.51% 99.51% +<.01%
==========================================
Files 104 104
Lines 12636 12659 +23
Branches 969 970 +1
==========================================
+ Hits 12575 12598 +23
Misses 40 40
Partials 21 21
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #1137 +/- ##
==========================================
+ Coverage 99.51% 99.51% +<.01%
==========================================
Files 104 104
Lines 12636 12659 +23
Branches 969 970 +1
==========================================
+ Hits 12575 12598 +23
Misses 40 40
Partials 21 21
|
|
Thanks for the review. |
|
Thanks! |
|
How do I use the is_readable attribute? I get ("'SocketStream' object has no attribute 'is_readable'",) Any way to load it or something? |
|
This is a method of the underlying socket object, not the SocketStream. Use |
As explained in #760, this PR adds a new
is_readablemethod totrio.socket.SocketTypeobject.