_trio.py 40 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346
  1. from __future__ import annotations
  2. import array
  3. import math
  4. import os
  5. import socket
  6. import sys
  7. import types
  8. import weakref
  9. from collections.abc import (
  10. AsyncGenerator,
  11. AsyncIterator,
  12. Awaitable,
  13. Callable,
  14. Collection,
  15. Coroutine,
  16. Iterable,
  17. Sequence,
  18. )
  19. from contextlib import AbstractContextManager
  20. from dataclasses import dataclass
  21. from io import IOBase
  22. from os import PathLike
  23. from signal import Signals
  24. from socket import AddressFamily, SocketKind
  25. from types import TracebackType
  26. from typing import (
  27. IO,
  28. TYPE_CHECKING,
  29. Any,
  30. Generic,
  31. NoReturn,
  32. TypeVar,
  33. cast,
  34. overload,
  35. )
  36. import trio.from_thread
  37. import trio.lowlevel
  38. from outcome import Error, Outcome, Value
  39. from trio.lowlevel import (
  40. current_root_task,
  41. current_task,
  42. notify_closing,
  43. wait_readable,
  44. wait_writable,
  45. )
  46. from trio.socket import SocketType as TrioSocketType
  47. from trio.to_thread import run_sync
  48. from .. import (
  49. CapacityLimiterStatistics,
  50. EventStatistics,
  51. LockStatistics,
  52. RunFinishedError,
  53. TaskInfo,
  54. WouldBlock,
  55. abc,
  56. )
  57. from .._core._eventloop import claim_worker_thread
  58. from .._core._exceptions import (
  59. BrokenResourceError,
  60. BusyResourceError,
  61. ClosedResourceError,
  62. EndOfStream,
  63. )
  64. from .._core._sockets import convert_ipv6_sockaddr
  65. from .._core._streams import create_memory_object_stream
  66. from .._core._synchronization import (
  67. CapacityLimiter as BaseCapacityLimiter,
  68. )
  69. from .._core._synchronization import Event as BaseEvent
  70. from .._core._synchronization import Lock as BaseLock
  71. from .._core._synchronization import (
  72. ResourceGuard,
  73. SemaphoreStatistics,
  74. )
  75. from .._core._synchronization import Semaphore as BaseSemaphore
  76. from .._core._tasks import CancelScope as BaseCancelScope
  77. from ..abc import IPSockAddrType, UDPPacketType, UNIXDatagramPacketType
  78. from ..abc._eventloop import AsyncBackend, StrOrBytesPath
  79. from ..streams.memory import MemoryObjectSendStream
  80. if TYPE_CHECKING:
  81. from _typeshed import FileDescriptorLike
  82. if sys.version_info >= (3, 10):
  83. from typing import ParamSpec
  84. else:
  85. from typing_extensions import ParamSpec
  86. if sys.version_info >= (3, 11):
  87. from typing import TypeVarTuple, Unpack
  88. else:
  89. from exceptiongroup import BaseExceptionGroup
  90. from typing_extensions import TypeVarTuple, Unpack
  91. T = TypeVar("T")
  92. T_Retval = TypeVar("T_Retval")
  93. T_SockAddr = TypeVar("T_SockAddr", str, IPSockAddrType)
  94. PosArgsT = TypeVarTuple("PosArgsT")
  95. P = ParamSpec("P")
  96. #
  97. # Event loop
  98. #
  99. RunVar = trio.lowlevel.RunVar
  100. #
  101. # Timeouts and cancellation
  102. #
  103. class CancelScope(BaseCancelScope):
  104. def __new__(
  105. cls, original: trio.CancelScope | None = None, **kwargs: object
  106. ) -> CancelScope:
  107. return object.__new__(cls)
  108. def __init__(self, original: trio.CancelScope | None = None, **kwargs: Any) -> None:
  109. self.__original = original or trio.CancelScope(**kwargs)
  110. def __enter__(self) -> CancelScope:
  111. self.__original.__enter__()
  112. return self
  113. def __exit__(
  114. self,
  115. exc_type: type[BaseException] | None,
  116. exc_val: BaseException | None,
  117. exc_tb: TracebackType | None,
  118. ) -> bool:
  119. return self.__original.__exit__(exc_type, exc_val, exc_tb)
  120. def cancel(self, reason: str | None = None) -> None:
  121. self.__original.cancel(reason)
  122. @property
  123. def deadline(self) -> float:
  124. return self.__original.deadline
  125. @deadline.setter
  126. def deadline(self, value: float) -> None:
  127. self.__original.deadline = value
  128. @property
  129. def cancel_called(self) -> bool:
  130. return self.__original.cancel_called
  131. @property
  132. def cancelled_caught(self) -> bool:
  133. return self.__original.cancelled_caught
  134. @property
  135. def shield(self) -> bool:
  136. return self.__original.shield
  137. @shield.setter
  138. def shield(self, value: bool) -> None:
  139. self.__original.shield = value
  140. #
  141. # Task groups
  142. #
  143. class TaskGroup(abc.TaskGroup):
  144. def __init__(self) -> None:
  145. self._active = False
  146. self._nursery_manager = trio.open_nursery(strict_exception_groups=True)
  147. self.cancel_scope = None # type: ignore[assignment]
  148. async def __aenter__(self) -> TaskGroup:
  149. self._active = True
  150. self._nursery = await self._nursery_manager.__aenter__()
  151. self.cancel_scope = CancelScope(self._nursery.cancel_scope)
  152. return self
  153. async def __aexit__(
  154. self,
  155. exc_type: type[BaseException] | None,
  156. exc_val: BaseException | None,
  157. exc_tb: TracebackType | None,
  158. ) -> bool:
  159. try:
  160. # trio.Nursery.__exit__ returns bool; .open_nursery has wrong type
  161. return await self._nursery_manager.__aexit__(exc_type, exc_val, exc_tb) # type: ignore[return-value]
  162. except BaseExceptionGroup as exc:
  163. if not exc.split(trio.Cancelled)[1]:
  164. raise trio.Cancelled._create() from exc
  165. raise
  166. finally:
  167. del exc_val, exc_tb
  168. self._active = False
  169. def start_soon(
  170. self,
  171. func: Callable[[Unpack[PosArgsT]], Awaitable[Any]],
  172. *args: Unpack[PosArgsT],
  173. name: object = None,
  174. ) -> None:
  175. if not self._active:
  176. raise RuntimeError(
  177. "This task group is not active; no new tasks can be started."
  178. )
  179. self._nursery.start_soon(func, *args, name=name)
  180. async def start(
  181. self, func: Callable[..., Awaitable[Any]], *args: object, name: object = None
  182. ) -> Any:
  183. if not self._active:
  184. raise RuntimeError(
  185. "This task group is not active; no new tasks can be started."
  186. )
  187. return await self._nursery.start(func, *args, name=name)
  188. #
  189. # Subprocesses
  190. #
  191. @dataclass(eq=False)
  192. class ReceiveStreamWrapper(abc.ByteReceiveStream):
  193. _stream: trio.abc.ReceiveStream
  194. async def receive(self, max_bytes: int | None = None) -> bytes:
  195. try:
  196. data = await self._stream.receive_some(max_bytes)
  197. except trio.ClosedResourceError as exc:
  198. raise ClosedResourceError from exc.__cause__
  199. except trio.BrokenResourceError as exc:
  200. raise BrokenResourceError from exc.__cause__
  201. if data:
  202. return bytes(data)
  203. else:
  204. raise EndOfStream
  205. async def aclose(self) -> None:
  206. await self._stream.aclose()
  207. @dataclass(eq=False)
  208. class SendStreamWrapper(abc.ByteSendStream):
  209. _stream: trio.abc.SendStream
  210. async def send(self, item: bytes) -> None:
  211. try:
  212. await self._stream.send_all(item)
  213. except trio.ClosedResourceError as exc:
  214. raise ClosedResourceError from exc.__cause__
  215. except trio.BrokenResourceError as exc:
  216. raise BrokenResourceError from exc.__cause__
  217. async def aclose(self) -> None:
  218. await self._stream.aclose()
  219. @dataclass(eq=False)
  220. class Process(abc.Process):
  221. _process: trio.Process
  222. _stdin: abc.ByteSendStream | None
  223. _stdout: abc.ByteReceiveStream | None
  224. _stderr: abc.ByteReceiveStream | None
  225. async def aclose(self) -> None:
  226. with CancelScope(shield=True):
  227. if self._stdin:
  228. await self._stdin.aclose()
  229. if self._stdout:
  230. await self._stdout.aclose()
  231. if self._stderr:
  232. await self._stderr.aclose()
  233. try:
  234. await self.wait()
  235. except BaseException:
  236. self.kill()
  237. with CancelScope(shield=True):
  238. await self.wait()
  239. raise
  240. async def wait(self) -> int:
  241. return await self._process.wait()
  242. def terminate(self) -> None:
  243. self._process.terminate()
  244. def kill(self) -> None:
  245. self._process.kill()
  246. def send_signal(self, signal: Signals) -> None:
  247. self._process.send_signal(signal)
  248. @property
  249. def pid(self) -> int:
  250. return self._process.pid
  251. @property
  252. def returncode(self) -> int | None:
  253. return self._process.returncode
  254. @property
  255. def stdin(self) -> abc.ByteSendStream | None:
  256. return self._stdin
  257. @property
  258. def stdout(self) -> abc.ByteReceiveStream | None:
  259. return self._stdout
  260. @property
  261. def stderr(self) -> abc.ByteReceiveStream | None:
  262. return self._stderr
  263. class _ProcessPoolShutdownInstrument(trio.abc.Instrument):
  264. def after_run(self) -> None:
  265. super().after_run()
  266. current_default_worker_process_limiter: trio.lowlevel.RunVar = RunVar(
  267. "current_default_worker_process_limiter"
  268. )
  269. async def _shutdown_process_pool(workers: set[abc.Process]) -> None:
  270. try:
  271. await trio.sleep(math.inf)
  272. except trio.Cancelled:
  273. for process in workers:
  274. if process.returncode is None:
  275. process.kill()
  276. with CancelScope(shield=True):
  277. for process in workers:
  278. await process.aclose()
  279. #
  280. # Sockets and networking
  281. #
  282. class _TrioSocketMixin(Generic[T_SockAddr]):
  283. def __init__(self, trio_socket: TrioSocketType) -> None:
  284. self._trio_socket = trio_socket
  285. self._closed = False
  286. def _check_closed(self) -> None:
  287. if self._closed:
  288. raise ClosedResourceError
  289. if self._trio_socket.fileno() < 0:
  290. raise BrokenResourceError
  291. @property
  292. def _raw_socket(self) -> socket.socket:
  293. return self._trio_socket._sock # type: ignore[attr-defined]
  294. async def aclose(self) -> None:
  295. if self._trio_socket.fileno() >= 0:
  296. self._closed = True
  297. self._trio_socket.close()
  298. def _convert_socket_error(self, exc: BaseException) -> NoReturn:
  299. if isinstance(exc, trio.ClosedResourceError):
  300. raise ClosedResourceError from exc
  301. elif self._trio_socket.fileno() < 0 and self._closed:
  302. raise ClosedResourceError from None
  303. elif isinstance(exc, OSError):
  304. raise BrokenResourceError from exc
  305. else:
  306. raise exc
  307. class SocketStream(_TrioSocketMixin, abc.SocketStream):
  308. def __init__(self, trio_socket: TrioSocketType) -> None:
  309. super().__init__(trio_socket)
  310. self._receive_guard = ResourceGuard("reading from")
  311. self._send_guard = ResourceGuard("writing to")
  312. async def receive(self, max_bytes: int = 65536) -> bytes:
  313. with self._receive_guard:
  314. try:
  315. data = await self._trio_socket.recv(max_bytes)
  316. except BaseException as exc:
  317. self._convert_socket_error(exc)
  318. if data:
  319. return data
  320. else:
  321. raise EndOfStream
  322. async def send(self, item: bytes) -> None:
  323. with self._send_guard:
  324. view = memoryview(item)
  325. while view:
  326. try:
  327. bytes_sent = await self._trio_socket.send(view)
  328. except BaseException as exc:
  329. self._convert_socket_error(exc)
  330. view = view[bytes_sent:]
  331. async def send_eof(self) -> None:
  332. self._trio_socket.shutdown(socket.SHUT_WR)
  333. class UNIXSocketStream(SocketStream, abc.UNIXSocketStream):
  334. async def receive_fds(self, msglen: int, maxfds: int) -> tuple[bytes, list[int]]:
  335. if not isinstance(msglen, int) or msglen < 0:
  336. raise ValueError("msglen must be a non-negative integer")
  337. if not isinstance(maxfds, int) or maxfds < 1:
  338. raise ValueError("maxfds must be a positive integer")
  339. fds = array.array("i")
  340. await trio.lowlevel.checkpoint()
  341. with self._receive_guard:
  342. while True:
  343. try:
  344. message, ancdata, flags, addr = await self._trio_socket.recvmsg(
  345. msglen, socket.CMSG_LEN(maxfds * fds.itemsize)
  346. )
  347. except BaseException as exc:
  348. self._convert_socket_error(exc)
  349. else:
  350. if not message and not ancdata:
  351. raise EndOfStream
  352. break
  353. for cmsg_level, cmsg_type, cmsg_data in ancdata:
  354. if cmsg_level != socket.SOL_SOCKET or cmsg_type != socket.SCM_RIGHTS:
  355. raise RuntimeError(
  356. f"Received unexpected ancillary data; message = {message!r}, "
  357. f"cmsg_level = {cmsg_level}, cmsg_type = {cmsg_type}"
  358. )
  359. fds.frombytes(cmsg_data[: len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
  360. return message, list(fds)
  361. async def send_fds(self, message: bytes, fds: Collection[int | IOBase]) -> None:
  362. if not message:
  363. raise ValueError("message must not be empty")
  364. if not fds:
  365. raise ValueError("fds must not be empty")
  366. filenos: list[int] = []
  367. for fd in fds:
  368. if isinstance(fd, int):
  369. filenos.append(fd)
  370. elif isinstance(fd, IOBase):
  371. filenos.append(fd.fileno())
  372. fdarray = array.array("i", filenos)
  373. await trio.lowlevel.checkpoint()
  374. with self._send_guard:
  375. while True:
  376. try:
  377. await self._trio_socket.sendmsg(
  378. [message],
  379. [
  380. (
  381. socket.SOL_SOCKET,
  382. socket.SCM_RIGHTS,
  383. fdarray,
  384. )
  385. ],
  386. )
  387. break
  388. except BaseException as exc:
  389. self._convert_socket_error(exc)
  390. class TCPSocketListener(_TrioSocketMixin, abc.SocketListener):
  391. def __init__(self, raw_socket: socket.socket):
  392. super().__init__(trio.socket.from_stdlib_socket(raw_socket))
  393. self._accept_guard = ResourceGuard("accepting connections from")
  394. async def accept(self) -> SocketStream:
  395. with self._accept_guard:
  396. try:
  397. trio_socket, _addr = await self._trio_socket.accept()
  398. except BaseException as exc:
  399. self._convert_socket_error(exc)
  400. trio_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
  401. return SocketStream(trio_socket)
  402. class UNIXSocketListener(_TrioSocketMixin, abc.SocketListener):
  403. def __init__(self, raw_socket: socket.socket):
  404. super().__init__(trio.socket.from_stdlib_socket(raw_socket))
  405. self._accept_guard = ResourceGuard("accepting connections from")
  406. async def accept(self) -> UNIXSocketStream:
  407. with self._accept_guard:
  408. try:
  409. trio_socket, _addr = await self._trio_socket.accept()
  410. except BaseException as exc:
  411. self._convert_socket_error(exc)
  412. return UNIXSocketStream(trio_socket)
  413. class UDPSocket(_TrioSocketMixin[IPSockAddrType], abc.UDPSocket):
  414. def __init__(self, trio_socket: TrioSocketType) -> None:
  415. super().__init__(trio_socket)
  416. self._receive_guard = ResourceGuard("reading from")
  417. self._send_guard = ResourceGuard("writing to")
  418. async def receive(self) -> tuple[bytes, IPSockAddrType]:
  419. with self._receive_guard:
  420. try:
  421. data, addr = await self._trio_socket.recvfrom(65536)
  422. return data, convert_ipv6_sockaddr(addr)
  423. except BaseException as exc:
  424. self._convert_socket_error(exc)
  425. async def send(self, item: UDPPacketType) -> None:
  426. with self._send_guard:
  427. try:
  428. await self._trio_socket.sendto(*item)
  429. except BaseException as exc:
  430. self._convert_socket_error(exc)
  431. class ConnectedUDPSocket(_TrioSocketMixin[IPSockAddrType], abc.ConnectedUDPSocket):
  432. def __init__(self, trio_socket: TrioSocketType) -> None:
  433. super().__init__(trio_socket)
  434. self._receive_guard = ResourceGuard("reading from")
  435. self._send_guard = ResourceGuard("writing to")
  436. async def receive(self) -> bytes:
  437. with self._receive_guard:
  438. try:
  439. return await self._trio_socket.recv(65536)
  440. except BaseException as exc:
  441. self._convert_socket_error(exc)
  442. async def send(self, item: bytes) -> None:
  443. with self._send_guard:
  444. try:
  445. await self._trio_socket.send(item)
  446. except BaseException as exc:
  447. self._convert_socket_error(exc)
  448. class UNIXDatagramSocket(_TrioSocketMixin[str], abc.UNIXDatagramSocket):
  449. def __init__(self, trio_socket: TrioSocketType) -> None:
  450. super().__init__(trio_socket)
  451. self._receive_guard = ResourceGuard("reading from")
  452. self._send_guard = ResourceGuard("writing to")
  453. async def receive(self) -> UNIXDatagramPacketType:
  454. with self._receive_guard:
  455. try:
  456. data, addr = await self._trio_socket.recvfrom(65536)
  457. return data, addr
  458. except BaseException as exc:
  459. self._convert_socket_error(exc)
  460. async def send(self, item: UNIXDatagramPacketType) -> None:
  461. with self._send_guard:
  462. try:
  463. await self._trio_socket.sendto(*item)
  464. except BaseException as exc:
  465. self._convert_socket_error(exc)
  466. class ConnectedUNIXDatagramSocket(
  467. _TrioSocketMixin[str], abc.ConnectedUNIXDatagramSocket
  468. ):
  469. def __init__(self, trio_socket: TrioSocketType) -> None:
  470. super().__init__(trio_socket)
  471. self._receive_guard = ResourceGuard("reading from")
  472. self._send_guard = ResourceGuard("writing to")
  473. async def receive(self) -> bytes:
  474. with self._receive_guard:
  475. try:
  476. return await self._trio_socket.recv(65536)
  477. except BaseException as exc:
  478. self._convert_socket_error(exc)
  479. async def send(self, item: bytes) -> None:
  480. with self._send_guard:
  481. try:
  482. await self._trio_socket.send(item)
  483. except BaseException as exc:
  484. self._convert_socket_error(exc)
  485. #
  486. # Synchronization
  487. #
  488. class Event(BaseEvent):
  489. def __new__(cls) -> Event:
  490. return object.__new__(cls)
  491. def __init__(self) -> None:
  492. self.__original = trio.Event()
  493. def is_set(self) -> bool:
  494. return self.__original.is_set()
  495. async def wait(self) -> None:
  496. return await self.__original.wait()
  497. def statistics(self) -> EventStatistics:
  498. orig_statistics = self.__original.statistics()
  499. return EventStatistics(tasks_waiting=orig_statistics.tasks_waiting)
  500. def set(self) -> None:
  501. self.__original.set()
  502. class Lock(BaseLock):
  503. def __new__(cls, *, fast_acquire: bool = False) -> Lock:
  504. return object.__new__(cls)
  505. def __init__(self, *, fast_acquire: bool = False) -> None:
  506. self._fast_acquire = fast_acquire
  507. self.__original = trio.Lock()
  508. @staticmethod
  509. def _convert_runtime_error_msg(exc: RuntimeError) -> None:
  510. if exc.args == ("attempt to re-acquire an already held Lock",):
  511. exc.args = ("Attempted to acquire an already held Lock",)
  512. async def acquire(self) -> None:
  513. if not self._fast_acquire:
  514. try:
  515. await self.__original.acquire()
  516. except RuntimeError as exc:
  517. self._convert_runtime_error_msg(exc)
  518. raise
  519. return
  520. # This is the "fast path" where we don't let other tasks run
  521. await trio.lowlevel.checkpoint_if_cancelled()
  522. try:
  523. self.__original.acquire_nowait()
  524. except trio.WouldBlock:
  525. await self.__original._lot.park()
  526. except RuntimeError as exc:
  527. self._convert_runtime_error_msg(exc)
  528. raise
  529. def acquire_nowait(self) -> None:
  530. try:
  531. self.__original.acquire_nowait()
  532. except trio.WouldBlock:
  533. raise WouldBlock from None
  534. except RuntimeError as exc:
  535. self._convert_runtime_error_msg(exc)
  536. raise
  537. def locked(self) -> bool:
  538. return self.__original.locked()
  539. def release(self) -> None:
  540. self.__original.release()
  541. def statistics(self) -> LockStatistics:
  542. orig_statistics = self.__original.statistics()
  543. owner = TrioTaskInfo(orig_statistics.owner) if orig_statistics.owner else None
  544. return LockStatistics(
  545. orig_statistics.locked, owner, orig_statistics.tasks_waiting
  546. )
  547. class Semaphore(BaseSemaphore):
  548. def __new__(
  549. cls,
  550. initial_value: int,
  551. *,
  552. max_value: int | None = None,
  553. fast_acquire: bool = False,
  554. ) -> Semaphore:
  555. return object.__new__(cls)
  556. def __init__(
  557. self,
  558. initial_value: int,
  559. *,
  560. max_value: int | None = None,
  561. fast_acquire: bool = False,
  562. ) -> None:
  563. super().__init__(initial_value, max_value=max_value, fast_acquire=fast_acquire)
  564. self.__original = trio.Semaphore(initial_value, max_value=max_value)
  565. async def acquire(self) -> None:
  566. if not self._fast_acquire:
  567. await self.__original.acquire()
  568. return
  569. # This is the "fast path" where we don't let other tasks run
  570. await trio.lowlevel.checkpoint_if_cancelled()
  571. try:
  572. self.__original.acquire_nowait()
  573. except trio.WouldBlock:
  574. await self.__original._lot.park()
  575. def acquire_nowait(self) -> None:
  576. try:
  577. self.__original.acquire_nowait()
  578. except trio.WouldBlock:
  579. raise WouldBlock from None
  580. @property
  581. def max_value(self) -> int | None:
  582. return self.__original.max_value
  583. @property
  584. def value(self) -> int:
  585. return self.__original.value
  586. def release(self) -> None:
  587. self.__original.release()
  588. def statistics(self) -> SemaphoreStatistics:
  589. orig_statistics = self.__original.statistics()
  590. return SemaphoreStatistics(orig_statistics.tasks_waiting)
  591. class CapacityLimiter(BaseCapacityLimiter):
  592. def __new__(
  593. cls,
  594. total_tokens: float | None = None,
  595. *,
  596. original: trio.CapacityLimiter | None = None,
  597. ) -> CapacityLimiter:
  598. return object.__new__(cls)
  599. def __init__(
  600. self,
  601. total_tokens: float | None = None,
  602. *,
  603. original: trio.CapacityLimiter | None = None,
  604. ) -> None:
  605. if original is not None:
  606. self.__original = original
  607. else:
  608. assert total_tokens is not None
  609. self.__original = trio.CapacityLimiter(total_tokens)
  610. async def __aenter__(self) -> None:
  611. return await self.__original.__aenter__()
  612. async def __aexit__(
  613. self,
  614. exc_type: type[BaseException] | None,
  615. exc_val: BaseException | None,
  616. exc_tb: TracebackType | None,
  617. ) -> None:
  618. await self.__original.__aexit__(exc_type, exc_val, exc_tb)
  619. @property
  620. def total_tokens(self) -> float:
  621. return self.__original.total_tokens
  622. @total_tokens.setter
  623. def total_tokens(self, value: float) -> None:
  624. self.__original.total_tokens = value
  625. @property
  626. def borrowed_tokens(self) -> int:
  627. return self.__original.borrowed_tokens
  628. @property
  629. def available_tokens(self) -> float:
  630. return self.__original.available_tokens
  631. def acquire_nowait(self) -> None:
  632. self.__original.acquire_nowait()
  633. def acquire_on_behalf_of_nowait(self, borrower: object) -> None:
  634. self.__original.acquire_on_behalf_of_nowait(borrower)
  635. async def acquire(self) -> None:
  636. await self.__original.acquire()
  637. async def acquire_on_behalf_of(self, borrower: object) -> None:
  638. await self.__original.acquire_on_behalf_of(borrower)
  639. def release(self) -> None:
  640. return self.__original.release()
  641. def release_on_behalf_of(self, borrower: object) -> None:
  642. return self.__original.release_on_behalf_of(borrower)
  643. def statistics(self) -> CapacityLimiterStatistics:
  644. orig = self.__original.statistics()
  645. return CapacityLimiterStatistics(
  646. borrowed_tokens=orig.borrowed_tokens,
  647. total_tokens=orig.total_tokens,
  648. borrowers=tuple(orig.borrowers),
  649. tasks_waiting=orig.tasks_waiting,
  650. )
  651. _capacity_limiter_wrapper: trio.lowlevel.RunVar = RunVar("_capacity_limiter_wrapper")
  652. #
  653. # Signal handling
  654. #
  655. class _SignalReceiver:
  656. _iterator: AsyncIterator[int]
  657. def __init__(self, signals: tuple[Signals, ...]):
  658. self._signals = signals
  659. def __enter__(self) -> _SignalReceiver:
  660. self._cm = trio.open_signal_receiver(*self._signals)
  661. self._iterator = self._cm.__enter__()
  662. return self
  663. def __exit__(
  664. self,
  665. exc_type: type[BaseException] | None,
  666. exc_val: BaseException | None,
  667. exc_tb: TracebackType | None,
  668. ) -> bool | None:
  669. return self._cm.__exit__(exc_type, exc_val, exc_tb)
  670. def __aiter__(self) -> _SignalReceiver:
  671. return self
  672. async def __anext__(self) -> Signals:
  673. signum = await self._iterator.__anext__()
  674. return Signals(signum)
  675. #
  676. # Testing and debugging
  677. #
  678. class TestRunner(abc.TestRunner):
  679. def __init__(self, **options: Any) -> None:
  680. from queue import Queue
  681. self._call_queue: Queue[Callable[[], object]] = Queue()
  682. self._send_stream: MemoryObjectSendStream | None = None
  683. self._options = options
  684. def __exit__(
  685. self,
  686. exc_type: type[BaseException] | None,
  687. exc_val: BaseException | None,
  688. exc_tb: types.TracebackType | None,
  689. ) -> None:
  690. if self._send_stream:
  691. self._send_stream.close()
  692. while self._send_stream is not None:
  693. self._call_queue.get()()
  694. async def _run_tests_and_fixtures(self) -> None:
  695. self._send_stream, receive_stream = create_memory_object_stream(1)
  696. with receive_stream:
  697. async for coro, outcome_holder in receive_stream:
  698. try:
  699. retval = await coro
  700. except BaseException as exc:
  701. outcome_holder.append(Error(exc))
  702. else:
  703. outcome_holder.append(Value(retval))
  704. def _main_task_finished(self, outcome: object) -> None:
  705. self._send_stream = None
  706. def _call_in_runner_task(
  707. self,
  708. func: Callable[P, Awaitable[T_Retval]],
  709. *args: P.args,
  710. **kwargs: P.kwargs,
  711. ) -> T_Retval:
  712. if self._send_stream is None:
  713. trio.lowlevel.start_guest_run(
  714. self._run_tests_and_fixtures,
  715. run_sync_soon_threadsafe=self._call_queue.put,
  716. done_callback=self._main_task_finished,
  717. **self._options,
  718. )
  719. while self._send_stream is None:
  720. self._call_queue.get()()
  721. outcome_holder: list[Outcome] = []
  722. self._send_stream.send_nowait((func(*args, **kwargs), outcome_holder))
  723. while not outcome_holder:
  724. self._call_queue.get()()
  725. return outcome_holder[0].unwrap()
  726. def run_asyncgen_fixture(
  727. self,
  728. fixture_func: Callable[..., AsyncGenerator[T_Retval, Any]],
  729. kwargs: dict[str, Any],
  730. ) -> Iterable[T_Retval]:
  731. asyncgen = fixture_func(**kwargs)
  732. fixturevalue: T_Retval = self._call_in_runner_task(asyncgen.asend, None)
  733. yield fixturevalue
  734. try:
  735. self._call_in_runner_task(asyncgen.asend, None)
  736. except StopAsyncIteration:
  737. pass
  738. else:
  739. self._call_in_runner_task(asyncgen.aclose)
  740. raise RuntimeError("Async generator fixture did not stop")
  741. def run_fixture(
  742. self,
  743. fixture_func: Callable[..., Coroutine[Any, Any, T_Retval]],
  744. kwargs: dict[str, Any],
  745. ) -> T_Retval:
  746. return self._call_in_runner_task(fixture_func, **kwargs)
  747. def run_test(
  748. self, test_func: Callable[..., Coroutine[Any, Any, Any]], kwargs: dict[str, Any]
  749. ) -> None:
  750. self._call_in_runner_task(test_func, **kwargs)
  751. class TrioTaskInfo(TaskInfo):
  752. def __init__(self, task: trio.lowlevel.Task):
  753. parent_id = None
  754. if task.parent_nursery and task.parent_nursery.parent_task:
  755. parent_id = id(task.parent_nursery.parent_task)
  756. super().__init__(id(task), parent_id, task.name, task.coro)
  757. self._task = weakref.proxy(task)
  758. def has_pending_cancellation(self) -> bool:
  759. try:
  760. return self._task._cancel_status.effectively_cancelled
  761. except ReferenceError:
  762. # If the task is no longer around, it surely doesn't have a cancellation
  763. # pending
  764. return False
  765. class TrioBackend(AsyncBackend):
  766. @classmethod
  767. def run(
  768. cls,
  769. func: Callable[[Unpack[PosArgsT]], Awaitable[T_Retval]],
  770. args: tuple[Unpack[PosArgsT]],
  771. kwargs: dict[str, Any],
  772. options: dict[str, Any],
  773. ) -> T_Retval:
  774. return trio.run(func, *args)
  775. @classmethod
  776. def current_token(cls) -> object:
  777. return trio.lowlevel.current_trio_token()
  778. @classmethod
  779. def current_time(cls) -> float:
  780. return trio.current_time()
  781. @classmethod
  782. def cancelled_exception_class(cls) -> type[BaseException]:
  783. return trio.Cancelled
  784. @classmethod
  785. async def checkpoint(cls) -> None:
  786. await trio.lowlevel.checkpoint()
  787. @classmethod
  788. async def checkpoint_if_cancelled(cls) -> None:
  789. await trio.lowlevel.checkpoint_if_cancelled()
  790. @classmethod
  791. async def cancel_shielded_checkpoint(cls) -> None:
  792. await trio.lowlevel.cancel_shielded_checkpoint()
  793. @classmethod
  794. async def sleep(cls, delay: float) -> None:
  795. await trio.sleep(delay)
  796. @classmethod
  797. def create_cancel_scope(
  798. cls, *, deadline: float = math.inf, shield: bool = False
  799. ) -> abc.CancelScope:
  800. return CancelScope(deadline=deadline, shield=shield)
  801. @classmethod
  802. def current_effective_deadline(cls) -> float:
  803. return trio.current_effective_deadline()
  804. @classmethod
  805. def create_task_group(cls) -> abc.TaskGroup:
  806. return TaskGroup()
  807. @classmethod
  808. def create_event(cls) -> abc.Event:
  809. return Event()
  810. @classmethod
  811. def create_lock(cls, *, fast_acquire: bool) -> Lock:
  812. return Lock(fast_acquire=fast_acquire)
  813. @classmethod
  814. def create_semaphore(
  815. cls,
  816. initial_value: int,
  817. *,
  818. max_value: int | None = None,
  819. fast_acquire: bool = False,
  820. ) -> abc.Semaphore:
  821. return Semaphore(initial_value, max_value=max_value, fast_acquire=fast_acquire)
  822. @classmethod
  823. def create_capacity_limiter(cls, total_tokens: float) -> CapacityLimiter:
  824. return CapacityLimiter(total_tokens)
  825. @classmethod
  826. async def run_sync_in_worker_thread(
  827. cls,
  828. func: Callable[[Unpack[PosArgsT]], T_Retval],
  829. args: tuple[Unpack[PosArgsT]],
  830. abandon_on_cancel: bool = False,
  831. limiter: abc.CapacityLimiter | None = None,
  832. ) -> T_Retval:
  833. def wrapper() -> T_Retval:
  834. with claim_worker_thread(TrioBackend, token):
  835. return func(*args)
  836. token = TrioBackend.current_token()
  837. return await run_sync(
  838. wrapper,
  839. abandon_on_cancel=abandon_on_cancel,
  840. limiter=cast(trio.CapacityLimiter, limiter),
  841. )
  842. @classmethod
  843. def check_cancelled(cls) -> None:
  844. trio.from_thread.check_cancelled()
  845. @classmethod
  846. def run_async_from_thread(
  847. cls,
  848. func: Callable[[Unpack[PosArgsT]], Awaitable[T_Retval]],
  849. args: tuple[Unpack[PosArgsT]],
  850. token: object,
  851. ) -> T_Retval:
  852. trio_token = cast("trio.lowlevel.TrioToken | None", token)
  853. try:
  854. return trio.from_thread.run(func, *args, trio_token=trio_token)
  855. except trio.RunFinishedError:
  856. raise RunFinishedError from None
  857. @classmethod
  858. def run_sync_from_thread(
  859. cls,
  860. func: Callable[[Unpack[PosArgsT]], T_Retval],
  861. args: tuple[Unpack[PosArgsT]],
  862. token: object,
  863. ) -> T_Retval:
  864. trio_token = cast("trio.lowlevel.TrioToken | None", token)
  865. try:
  866. return trio.from_thread.run_sync(func, *args, trio_token=trio_token)
  867. except trio.RunFinishedError:
  868. raise RunFinishedError from None
  869. @classmethod
  870. async def open_process(
  871. cls,
  872. command: StrOrBytesPath | Sequence[StrOrBytesPath],
  873. *,
  874. stdin: int | IO[Any] | None,
  875. stdout: int | IO[Any] | None,
  876. stderr: int | IO[Any] | None,
  877. **kwargs: Any,
  878. ) -> Process:
  879. def convert_item(item: StrOrBytesPath) -> str:
  880. str_or_bytes = os.fspath(item)
  881. if isinstance(str_or_bytes, str):
  882. return str_or_bytes
  883. else:
  884. return os.fsdecode(str_or_bytes)
  885. if isinstance(command, (str, bytes, PathLike)):
  886. process = await trio.lowlevel.open_process(
  887. convert_item(command),
  888. stdin=stdin,
  889. stdout=stdout,
  890. stderr=stderr,
  891. shell=True,
  892. **kwargs,
  893. )
  894. else:
  895. process = await trio.lowlevel.open_process(
  896. [convert_item(item) for item in command],
  897. stdin=stdin,
  898. stdout=stdout,
  899. stderr=stderr,
  900. shell=False,
  901. **kwargs,
  902. )
  903. stdin_stream = SendStreamWrapper(process.stdin) if process.stdin else None
  904. stdout_stream = ReceiveStreamWrapper(process.stdout) if process.stdout else None
  905. stderr_stream = ReceiveStreamWrapper(process.stderr) if process.stderr else None
  906. return Process(process, stdin_stream, stdout_stream, stderr_stream)
  907. @classmethod
  908. def setup_process_pool_exit_at_shutdown(cls, workers: set[abc.Process]) -> None:
  909. trio.lowlevel.spawn_system_task(_shutdown_process_pool, workers)
  910. @classmethod
  911. async def connect_tcp(
  912. cls, host: str, port: int, local_address: IPSockAddrType | None = None
  913. ) -> SocketStream:
  914. family = socket.AF_INET6 if ":" in host else socket.AF_INET
  915. trio_socket = trio.socket.socket(family)
  916. trio_socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
  917. if local_address:
  918. await trio_socket.bind(local_address)
  919. try:
  920. await trio_socket.connect((host, port))
  921. except BaseException:
  922. trio_socket.close()
  923. raise
  924. return SocketStream(trio_socket)
  925. @classmethod
  926. async def connect_unix(cls, path: str | bytes) -> abc.UNIXSocketStream:
  927. trio_socket = trio.socket.socket(socket.AF_UNIX)
  928. try:
  929. await trio_socket.connect(path)
  930. except BaseException:
  931. trio_socket.close()
  932. raise
  933. return UNIXSocketStream(trio_socket)
  934. @classmethod
  935. def create_tcp_listener(cls, sock: socket.socket) -> abc.SocketListener:
  936. return TCPSocketListener(sock)
  937. @classmethod
  938. def create_unix_listener(cls, sock: socket.socket) -> abc.SocketListener:
  939. return UNIXSocketListener(sock)
  940. @classmethod
  941. async def create_udp_socket(
  942. cls,
  943. family: socket.AddressFamily,
  944. local_address: IPSockAddrType | None,
  945. remote_address: IPSockAddrType | None,
  946. reuse_port: bool,
  947. ) -> UDPSocket | ConnectedUDPSocket:
  948. trio_socket = trio.socket.socket(family=family, type=socket.SOCK_DGRAM)
  949. if reuse_port:
  950. trio_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
  951. if local_address:
  952. await trio_socket.bind(local_address)
  953. if remote_address:
  954. await trio_socket.connect(remote_address)
  955. return ConnectedUDPSocket(trio_socket)
  956. else:
  957. return UDPSocket(trio_socket)
  958. @classmethod
  959. @overload
  960. async def create_unix_datagram_socket(
  961. cls, raw_socket: socket.socket, remote_path: None
  962. ) -> abc.UNIXDatagramSocket: ...
  963. @classmethod
  964. @overload
  965. async def create_unix_datagram_socket(
  966. cls, raw_socket: socket.socket, remote_path: str | bytes
  967. ) -> abc.ConnectedUNIXDatagramSocket: ...
  968. @classmethod
  969. async def create_unix_datagram_socket(
  970. cls, raw_socket: socket.socket, remote_path: str | bytes | None
  971. ) -> abc.UNIXDatagramSocket | abc.ConnectedUNIXDatagramSocket:
  972. trio_socket = trio.socket.from_stdlib_socket(raw_socket)
  973. if remote_path:
  974. await trio_socket.connect(remote_path)
  975. return ConnectedUNIXDatagramSocket(trio_socket)
  976. else:
  977. return UNIXDatagramSocket(trio_socket)
  978. @classmethod
  979. async def getaddrinfo(
  980. cls,
  981. host: bytes | str | None,
  982. port: str | int | None,
  983. *,
  984. family: int | AddressFamily = 0,
  985. type: int | SocketKind = 0,
  986. proto: int = 0,
  987. flags: int = 0,
  988. ) -> Sequence[
  989. tuple[
  990. AddressFamily,
  991. SocketKind,
  992. int,
  993. str,
  994. tuple[str, int] | tuple[str, int, int, int] | tuple[int, bytes],
  995. ]
  996. ]:
  997. return await trio.socket.getaddrinfo(host, port, family, type, proto, flags)
  998. @classmethod
  999. async def getnameinfo(
  1000. cls, sockaddr: IPSockAddrType, flags: int = 0
  1001. ) -> tuple[str, str]:
  1002. return await trio.socket.getnameinfo(sockaddr, flags)
  1003. @classmethod
  1004. async def wait_readable(cls, obj: FileDescriptorLike) -> None:
  1005. try:
  1006. await wait_readable(obj)
  1007. except trio.ClosedResourceError as exc:
  1008. raise ClosedResourceError().with_traceback(exc.__traceback__) from None
  1009. except trio.BusyResourceError:
  1010. raise BusyResourceError("reading from") from None
  1011. @classmethod
  1012. async def wait_writable(cls, obj: FileDescriptorLike) -> None:
  1013. try:
  1014. await wait_writable(obj)
  1015. except trio.ClosedResourceError as exc:
  1016. raise ClosedResourceError().with_traceback(exc.__traceback__) from None
  1017. except trio.BusyResourceError:
  1018. raise BusyResourceError("writing to") from None
  1019. @classmethod
  1020. def notify_closing(cls, obj: FileDescriptorLike) -> None:
  1021. notify_closing(obj)
  1022. @classmethod
  1023. async def wrap_listener_socket(cls, sock: socket.socket) -> abc.SocketListener:
  1024. return TCPSocketListener(sock)
  1025. @classmethod
  1026. async def wrap_stream_socket(cls, sock: socket.socket) -> SocketStream:
  1027. trio_sock = trio.socket.from_stdlib_socket(sock)
  1028. return SocketStream(trio_sock)
  1029. @classmethod
  1030. async def wrap_unix_stream_socket(cls, sock: socket.socket) -> UNIXSocketStream:
  1031. trio_sock = trio.socket.from_stdlib_socket(sock)
  1032. return UNIXSocketStream(trio_sock)
  1033. @classmethod
  1034. async def wrap_udp_socket(cls, sock: socket.socket) -> UDPSocket:
  1035. trio_sock = trio.socket.from_stdlib_socket(sock)
  1036. return UDPSocket(trio_sock)
  1037. @classmethod
  1038. async def wrap_connected_udp_socket(cls, sock: socket.socket) -> ConnectedUDPSocket:
  1039. trio_sock = trio.socket.from_stdlib_socket(sock)
  1040. return ConnectedUDPSocket(trio_sock)
  1041. @classmethod
  1042. async def wrap_unix_datagram_socket(cls, sock: socket.socket) -> UNIXDatagramSocket:
  1043. trio_sock = trio.socket.from_stdlib_socket(sock)
  1044. return UNIXDatagramSocket(trio_sock)
  1045. @classmethod
  1046. async def wrap_connected_unix_datagram_socket(
  1047. cls, sock: socket.socket
  1048. ) -> ConnectedUNIXDatagramSocket:
  1049. trio_sock = trio.socket.from_stdlib_socket(sock)
  1050. return ConnectedUNIXDatagramSocket(trio_sock)
  1051. @classmethod
  1052. def current_default_thread_limiter(cls) -> CapacityLimiter:
  1053. try:
  1054. return _capacity_limiter_wrapper.get()
  1055. except LookupError:
  1056. limiter = CapacityLimiter(
  1057. original=trio.to_thread.current_default_thread_limiter()
  1058. )
  1059. _capacity_limiter_wrapper.set(limiter)
  1060. return limiter
  1061. @classmethod
  1062. def open_signal_receiver(
  1063. cls, *signals: Signals
  1064. ) -> AbstractContextManager[AsyncIterator[Signals]]:
  1065. return _SignalReceiver(signals)
  1066. @classmethod
  1067. def get_current_task(cls) -> TaskInfo:
  1068. task = current_task()
  1069. return TrioTaskInfo(task)
  1070. @classmethod
  1071. def get_running_tasks(cls) -> Sequence[TaskInfo]:
  1072. root_task = current_root_task()
  1073. assert root_task
  1074. task_infos = [TrioTaskInfo(root_task)]
  1075. nurseries = root_task.child_nurseries
  1076. while nurseries:
  1077. new_nurseries: list[trio.Nursery] = []
  1078. for nursery in nurseries:
  1079. for task in nursery.child_tasks:
  1080. task_infos.append(TrioTaskInfo(task))
  1081. new_nurseries.extend(task.child_nurseries)
  1082. nurseries = new_nurseries
  1083. return task_infos
  1084. @classmethod
  1085. async def wait_all_tasks_blocked(cls) -> None:
  1086. from trio.testing import wait_all_tasks_blocked
  1087. await wait_all_tasks_blocked()
  1088. @classmethod
  1089. def create_test_runner(cls, options: dict[str, Any]) -> TestRunner:
  1090. return TestRunner(**options)
  1091. backend_class = TrioBackend