77import platform
88import sys
99from asyncio import transports as aio_transports
10+ from asyncio .streams import FlowControlMixin
1011from collections .abc import AsyncIterator , Callable , Mapping
1112from contextlib import asynccontextmanager
1213from pathlib import Path
2829]
2930
3031
31- class _WritePipeProtocol (asyncio . BaseProtocol ):
32+ class _WritePipeProtocol (FlowControlMixin ):
3233 def __init__ (self ) -> None :
33- self ._loop = asyncio .get_running_loop ()
34- self ._paused = False
35- self ._drain_waiter : asyncio .Future [None ] | None = None
34+ loop = asyncio .get_running_loop ()
35+ super ().__init__ (loop = loop )
36+ self ._closed : asyncio .Future [None ] = loop .create_future ()
37+ # Callers may handle a failed drain without also awaiting wait_closed.
38+ self ._closed .add_done_callback (lambda future : None if future .cancelled () else future .exception ())
3639
37- def pause_writing (self ) -> None : # type: ignore[override]
38- self ._paused = True
39- if self ._drain_waiter is None :
40- self ._drain_waiter = self ._loop .create_future ()
40+ def connection_lost (self , exc : Exception | None ) -> None :
41+ super ().connection_lost (exc )
42+ if not self ._closed .done ():
43+ if exc is None :
44+ self ._closed .set_result (None )
45+ else :
46+ self ._closed .set_exception (exc )
4147
42- def resume_writing (self ) -> None : # type: ignore[override]
43- self ._paused = False
44- if self ._drain_waiter is not None and not self ._drain_waiter .done ():
45- self ._drain_waiter .set_result (None )
46- self ._drain_waiter = None
47-
48- async def _drain_helper (self ) -> None :
49- if self ._paused and self ._drain_waiter is not None :
50- await self ._drain_waiter
48+ def _get_close_waiter (self , stream : asyncio .StreamWriter ) -> asyncio .Future [None ]:
49+ return self ._closed
5150
5251
5352def _start_stdin_feeder (loop : asyncio .AbstractEventLoop , reader : asyncio .StreamReader ) -> None :
@@ -68,17 +67,20 @@ def blocking_read() -> None:
6867
6968
7069class _StdoutTransport (asyncio .BaseTransport ):
71- def __init__ (self ) -> None :
70+ def __init__ (self , protocol : _WritePipeProtocol ) -> None :
7271 self ._is_closing = False
72+ self ._protocol = protocol
7373
7474 def write (self , data : bytes ) -> None : # type: ignore[override]
7575 if self ._is_closing :
7676 return
7777 try :
7878 sys .stdout .buffer .write (data )
7979 sys .stdout .buffer .flush ()
80- except Exception :
80+ except Exception as exc :
8181 _logger .exception ("Error writing to stdout" )
82+ self ._is_closing = True
83+ self ._protocol .connection_lost (exc )
8284
8385 def can_write_eof (self ) -> bool : # type: ignore[override]
8486 return False
@@ -87,9 +89,12 @@ def is_closing(self) -> bool: # type: ignore[override]
8789 return self ._is_closing
8890
8991 def close (self ) -> None : # type: ignore[override]
92+ if self ._is_closing :
93+ return
9094 self ._is_closing = True
9195 with contextlib .suppress (Exception ):
9296 sys .stdout .flush ()
97+ self ._protocol .connection_lost (None )
9398
9499 def abort (self ) -> None : # type: ignore[override]
95100 self .close ()
@@ -108,7 +113,7 @@ async def _windows_stdio_streams(
108113 _start_stdin_feeder (loop , reader )
109114
110115 write_protocol = _WritePipeProtocol ()
111- transport = _StdoutTransport ()
116+ transport = _StdoutTransport (write_protocol )
112117 writer = asyncio .StreamWriter (cast (aio_transports .WriteTransport , transport ), write_protocol , None , loop )
113118 return reader , writer
114119
@@ -132,6 +137,10 @@ async def _posix_stdio_streams(
132137async def stdio_streams (limit : int | None = None ) -> tuple [asyncio .StreamReader , asyncio .StreamWriter ]:
133138 """Create stdio asyncio streams; on Windows use a thread feeder + custom stdout transport.
134139
140+ The writer supports ``close()`` followed by ``await wait_closed()``.
141+ ``drain()`` reports a disconnected output pipe, including while waiting for
142+ buffered output to be consumed.
143+
135144 Args:
136145 limit: Optional buffer limit for the stdin reader.
137146 """
0 commit comments