Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0baa72f

Browse files
asvetlovasvetlov
authored
bpo-34622: Extract asyncio exceptions into a separate module (GH-9141)
1 parent 7c7605f commit 0baa72f

18 files changed

Lines changed: 148 additions & 110 deletions

‎Lib/asyncio/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
from .base_events import *
99
from .coroutines import *
1010
from .events import *
11+
from .exceptions import *
1112
from .futures import *
1213
from .locks import *
1314
from .protocols import *
@@ -25,6 +26,7 @@
2526
__all__ = (base_events.__all__ +
2627
coroutines.__all__ +
2728
events.__all__ +
29+
exceptions.__all__ +
2830
futures.__all__ +
2931
locks.__all__ +
3032
protocols.__all__ +

‎Lib/asyncio/base_events.py‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
from . import constants
3838
from . import coroutines
3939
from . import events
40+
from . import exceptions
4041
from . import futures
4142
from . import protocols
4243
from . import sslproto
@@ -327,7 +328,7 @@ async def serve_forever(self):
327328

328329
try:
329330
await self._serving_forever_fut
330-
except futures.CancelledError:
331+
except exceptions.CancelledError:
331332
try:
332333
self.close()
333334
await self.wait_closed()
@@ -800,7 +801,7 @@ async def sock_sendfile(self, sock, file, offset=0, count=None,
800801
try:
801802
return await self._sock_sendfile_native(sock, file,
802803
offset, count)
803-
except events.SendfileNotAvailableError as exc:
804+
except exceptions.SendfileNotAvailableError as exc:
804805
if not fallback:
805806
raise
806807
return await self._sock_sendfile_fallback(sock, file,
@@ -809,7 +810,7 @@ async def sock_sendfile(self, sock, file, offset=0, count=None,
809810
async def _sock_sendfile_native(self, sock, file, offset, count):
810811
# NB: sendfile syscall is not supported for SSL sockets and
811812
# non-mmap files even if sendfile is supported by OS
812-
raise events.SendfileNotAvailableError(
813+
raise exceptions.SendfileNotAvailableError(
813814
f"syscall sendfile is not available for socket {sock!r} "
814815
"and file {file!r} combination")
815816

@@ -1053,7 +1054,7 @@ async def sendfile(self, transport, file, offset=0, count=None,
10531054
try:
10541055
return await self._sendfile_native(transport, file,
10551056
offset, count)
1056-
except events.SendfileNotAvailableError as exc:
1057+
except exceptions.SendfileNotAvailableError as exc:
10571058
if not fallback:
10581059
raise
10591060

@@ -1066,7 +1067,7 @@ async def sendfile(self, transport, file, offset=0, count=None,
10661067
offset, count)
10671068

10681069
async def _sendfile_native(self, transp, file, offset, count):
1069-
raise events.SendfileNotAvailableError(
1070+
raise exceptions.SendfileNotAvailableError(
10701071
"sendfile syscall is not supported")
10711072

10721073
async def _sendfile_fallback(self, transp, file, offset, count):

‎Lib/asyncio/base_futures.py‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
__all__ = ()
22

3-
import concurrent.futures
43
import reprlib
54

65
from . import format_helpers
76

8-
CancelledError = concurrent.futures.CancelledError
9-
TimeoutError = concurrent.futures.TimeoutError
10-
InvalidStateError = concurrent.futures.InvalidStateError
11-
12-
137
# States for Future.
148
_PENDING = 'PENDING'
159
_CANCELLED = 'CANCELLED'

‎Lib/asyncio/events.py‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
__all__ = (
44
'AbstractEventLoopPolicy',
55
'AbstractEventLoop', 'AbstractServer',
6-
'Handle', 'TimerHandle', 'SendfileNotAvailableError',
6+
'Handle', 'TimerHandle',
77
'get_event_loop_policy', 'set_event_loop_policy',
88
'get_event_loop', 'set_event_loop', 'new_event_loop',
99
'get_child_watcher', 'set_child_watcher',
@@ -19,14 +19,7 @@
1919
import threading
2020

2121
from . import format_helpers
22-
23-
24-
class SendfileNotAvailableError(RuntimeError):
25-
"""Sendfile syscall is not available.
26-
27-
Raised if OS does not support sendfile syscall for given socket or
28-
file type.
29-
"""
22+
from . import exceptions
3023

3124

3225
class Handle:

‎Lib/asyncio/exceptions.py‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
"""asyncio exceptions."""
2+
3+
4+
__all__ = ('CancelledError', 'InvalidStateError', 'TimeoutError',
5+
'IncompleteReadError', 'LimitOverrunError',
6+
'SendfileNotAvailableError')
7+
8+
import concurrent.futures
9+
from . import base_futures
10+
11+
12+
class CancelledError(concurrent.futures.CancelledError):
13+
"""The Future or Task was cancelled."""
14+
15+
16+
class TimeoutError(concurrent.futures.TimeoutError):
17+
"""The operation exceeded the given deadline."""
18+
19+
20+
class InvalidStateError(concurrent.futures.InvalidStateError):
21+
"""The operation is not allowed in this state."""
22+
23+
24+
class SendfileNotAvailableError(RuntimeError):
25+
"""Sendfile syscall is not available.
26+
27+
Raised if OS does not support sendfile syscall for given socket or
28+
file type.
29+
"""
30+
31+
32+
class IncompleteReadError(EOFError):
33+
"""
34+
Incomplete read error. Attributes:
35+
36+
- partial: read bytes string before the end of stream was reached
37+
- expected: total number of expected bytes (or None if unknown)
38+
"""
39+
def __init__(self, partial, expected):
40+
super().__init__(f'{len(partial)} bytes read on a total of '
41+
f'{expected!r} expected bytes')
42+
self.partial = partial
43+
self.expected = expected
44+
45+
def __reduce__(self):
46+
return type(self), (self.partial, self.expected)
47+
48+
49+
class LimitOverrunError(Exception):
50+
"""Reached the buffer limit while looking for a separator.
51+
52+
Attributes:
53+
- consumed: total number of to be consumed bytes.
54+
"""
55+
def __init__(self, message, consumed):
56+
super().__init__(message)
57+
self.consumed = consumed
58+
59+
def __reduce__(self):
60+
return type(self), (self.args[0], self.consumed)

‎Lib/asyncio/futures.py‎

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
"""A Future class similar to the one in PEP 3148."""
22

33
__all__ = (
4-
'CancelledError', 'TimeoutError', 'InvalidStateError',
54
'Future', 'wrap_future', 'isfuture',
65
)
76

@@ -12,12 +11,10 @@
1211

1312
from . import base_futures
1413
from . import events
14+
from . import exceptions
1515
from . import format_helpers
1616

1717

18-
CancelledError = base_futures.CancelledError
19-
InvalidStateError = base_futures.InvalidStateError
20-
TimeoutError = base_futures.TimeoutError
2118
isfuture = base_futures.isfuture
2219

2320

@@ -170,9 +167,9 @@ def result(self):
170167
the future is done and has an exception set, this exception is raised.
171168
"""
172169
if self._state == _CANCELLED:
173-
raise CancelledError
170+
raise exceptions.CancelledError
174171
if self._state != _FINISHED:
175-
raise InvalidStateError('Result is not ready.')
172+
raise exceptions.InvalidStateError('Result is not ready.')
176173
self.__log_traceback = False
177174
if self._exception is not None:
178175
raise self._exception
@@ -187,9 +184,9 @@ def exception(self):
187184
InvalidStateError.
188185
"""
189186
if self._state == _CANCELLED:
190-
raise CancelledError
187+
raise exceptions.CancelledError
191188
if self._state != _FINISHED:
192-
raise InvalidStateError('Exception is not set.')
189+
raise exceptions.InvalidStateError('Exception is not set.')
193190
self.__log_traceback = False
194191
return self._exception
195192

@@ -231,7 +228,7 @@ def set_result(self, result):
231228
InvalidStateError.
232229
"""
233230
if self._state != _PENDING:
234-
raise InvalidStateError('{}: {!r}'.format(self._state, self))
231+
raise exceptions.InvalidStateError(f'{self._state}: {self!r}')
235232
self._result = result
236233
self._state = _FINISHED
237234
self.__schedule_callbacks()
@@ -243,7 +240,7 @@ def set_exception(self, exception):
243240
InvalidStateError.
244241
"""
245242
if self._state != _PENDING:
246-
raise InvalidStateError('{}: {!r}'.format(self._state, self))
243+
raise exceptions.InvalidStateError(f'{self._state}: {self!r}')
247244
if isinstance(exception, type):
248245
exception = exception()
249246
if type(exception) is StopIteration:
@@ -288,6 +285,18 @@ def _set_result_unless_cancelled(fut, result):
288285
fut.set_result(result)
289286

290287

288+
def _convert_future_exc(exc):
289+
exc_class = type(exc)
290+
if exc_class is concurrent.futures.CancelledError:
291+
return exceptions.CancelledError(*exc.args)
292+
elif exc_class is concurrent.futures.TimeoutError:
293+
return exceptions.TimeoutError(*exc.args)
294+
elif exc_class is concurrent.futures.InvalidStateError:
295+
return exceptions.InvalidStateError(*exc.args)
296+
else:
297+
return exc
298+
299+
291300
def _set_concurrent_future_state(concurrent, source):
292301
"""Copy state from a future to a concurrent.futures.Future."""
293302
assert source.done()
@@ -297,7 +306,7 @@ def _set_concurrent_future_state(concurrent, source):
297306
return
298307
exception = source.exception()
299308
if exception is not None:
300-
concurrent.set_exception(exception)
309+
concurrent.set_exception(_convert_future_exc(exception))
301310
else:
302311
result = source.result()
303312
concurrent.set_result(result)
@@ -317,7 +326,7 @@ def _copy_future_state(source, dest):
317326
else:
318327
exception = source.exception()
319328
if exception is not None:
320-
dest.set_exception(exception)
329+
dest.set_exception(_convert_future_exc(exception))
321330
else:
322331
result = source.result()
323332
dest.set_result(result)

‎Lib/asyncio/locks.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
from . import events
99
from . import futures
10+
from . import exceptions
1011
from .coroutines import coroutine
1112

1213

@@ -192,7 +193,7 @@ async def acquire(self):
192193
await fut
193194
finally:
194195
self._waiters.remove(fut)
195-
except futures.CancelledError:
196+
except exceptions.CancelledError:
196197
if not self._locked:
197198
self._wake_up_first()
198199
raise
@@ -363,11 +364,11 @@ async def wait(self):
363364
try:
364365
await self.acquire()
365366
break
366-
except futures.CancelledError:
367+
except exceptions.CancelledError:
367368
cancelled = True
368369

369370
if cancelled:
370-
raise futures.CancelledError
371+
raise exceptions.CancelledError
371372

372373
async def wait_for(self, predicate):
373374
"""Wait until a predicate becomes true.

‎Lib/asyncio/proactor_events.py‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
from . import constants
1616
from . import events
1717
from . import futures
18+
from . import exceptions
1819
from . import protocols
1920
from . import sslproto
2021
from . import transports
@@ -282,7 +283,7 @@ def _loop_reading(self, fut=None):
282283
self._force_close(exc)
283284
except OSError as exc:
284285
self._fatal_error(exc, 'Fatal read error on pipe transport')
285-
except futures.CancelledError:
286+
except exceptions.CancelledError:
286287
if not self._closing:
287288
raise
288289
else:
@@ -555,11 +556,11 @@ async def _sock_sendfile_native(self, sock, file, offset, count):
555556
try:
556557
fileno = file.fileno()
557558
except (AttributeError, io.UnsupportedOperation) as err:
558-
raise events.SendfileNotAvailableError("not a regular file")
559+
raise exceptions.SendfileNotAvailableError("not a regular file")
559560
try:
560561
fsize = os.fstat(fileno).st_size
561562
except OSError as err:
562-
raise events.SendfileNotAvailableError("not a regular file")
563+
raise exceptions.SendfileNotAvailableError("not a regular file")
563564
blocksize = count if count else fsize
564565
if not blocksize:
565566
return 0 # empty file
@@ -615,7 +616,7 @@ def _loop_self_reading(self, f=None):
615616
if f is not None:
616617
f.result() # may raise
617618
f = self._proactor.recv(self._ssock, 4096)
618-
except futures.CancelledError:
619+
except exceptions.CancelledError:
619620
# _close_self_pipe() has been called, stop waiting for data
620621
return
621622
except Exception as exc:
@@ -666,7 +667,7 @@ def loop(f=None):
666667
elif self._debug:
667668
logger.debug("Accept failed on socket %r",
668669
sock, exc_info=True)
669-
except futures.CancelledError:
670+
except exceptions.CancelledError:
670671
sock.close()
671672
else:
672673
self._accept_futures[sock.fileno()] = f

0 commit comments

Comments
 (0)