summaryrefslogtreecommitdiffstats
path: root/Lib
diff options
context:
space:
mode:
Diffstat (limited to 'Lib')
-rw-r--r--Lib/asyncio/futures.py6
-rw-r--r--Lib/asyncio/tasks.py5
-rw-r--r--Lib/test/test_asyncio/test_futures.py12
-rw-r--r--Lib/test/test_asyncio/test_taskgroups.py8
-rw-r--r--Lib/test/test_asyncio/test_tasks.py54
5 files changed, 70 insertions, 15 deletions
diff --git a/Lib/asyncio/futures.py b/Lib/asyncio/futures.py
index bfd4ee9..08c79e7 100644
--- a/Lib/asyncio/futures.py
+++ b/Lib/asyncio/futures.py
@@ -8,6 +8,7 @@ import concurrent.futures
import contextvars
import logging
import sys
+import warnings
from types import GenericAlias
from . import base_futures
@@ -150,6 +151,11 @@ class Future:
change the future's state to cancelled, schedule the callbacks and
return True.
"""
+ if msg is not None:
+ warnings.warn("Passing 'msg' argument to Future.cancel() "
+ "is deprecated since Python 3.11, and "
+ "scheduled for removal in Python 3.14.",
+ DeprecationWarning, stacklevel=2)
self.__log_traceback = False
if self._state != _PENDING:
return False
diff --git a/Lib/asyncio/tasks.py b/Lib/asyncio/tasks.py
index e876f8d..27fe58d 100644
--- a/Lib/asyncio/tasks.py
+++ b/Lib/asyncio/tasks.py
@@ -207,6 +207,11 @@ class Task(futures._PyFuture): # Inherit Python Task implementation
This also increases the task's count of cancellation requests.
"""
+ if msg is not None:
+ warnings.warn("Passing 'msg' argument to Task.cancel() "
+ "is deprecated since Python 3.11, and "
+ "scheduled for removal in Python 3.14.",
+ DeprecationWarning, stacklevel=2)
self._log_traceback = False
if self.done():
return False
diff --git a/Lib/test/test_asyncio/test_futures.py b/Lib/test/test_asyncio/test_futures.py
index 84d7d45..cf677f6 100644
--- a/Lib/test/test_asyncio/test_futures.py
+++ b/Lib/test/test_asyncio/test_futures.py
@@ -228,14 +228,22 @@ class BaseFutureTests:
self.assertTrue(hasattr(f, '_cancel_message'))
self.assertEqual(f._cancel_message, None)
- f.cancel('my message')
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ f.cancel('my message')
with self.assertRaises(asyncio.CancelledError):
self.loop.run_until_complete(f)
self.assertEqual(f._cancel_message, 'my message')
def test_future_cancel_message_setter(self):
f = self._new_future(loop=self.loop)
- f.cancel('my message')
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ f.cancel('my message')
f._cancel_message = 'my new message'
self.assertEqual(f._cancel_message, 'my new message')
diff --git a/Lib/test/test_asyncio/test_taskgroups.py b/Lib/test/test_asyncio/test_taskgroups.py
index dea5d6d..69369a6 100644
--- a/Lib/test/test_asyncio/test_taskgroups.py
+++ b/Lib/test/test_asyncio/test_taskgroups.py
@@ -191,12 +191,10 @@ class TestTaskGroup(unittest.IsolatedAsyncioTestCase):
await asyncio.sleep(0.1)
self.assertFalse(r.done())
- r.cancel("test")
+ r.cancel()
with self.assertRaises(asyncio.CancelledError) as cm:
await r
- self.assertEqual(cm.exception.args, ('test',))
-
self.assertEqual(NUM, 5)
async def test_taskgroup_07(self):
@@ -253,12 +251,10 @@ class TestTaskGroup(unittest.IsolatedAsyncioTestCase):
await asyncio.sleep(0.1)
self.assertFalse(r.done())
- r.cancel("test")
+ r.cancel()
with self.assertRaises(asyncio.CancelledError) as cm:
await r
- self.assertEqual(cm.exception.args, ('test',))
-
async def test_taskgroup_09(self):
t1 = t2 = None
diff --git a/Lib/test/test_asyncio/test_tasks.py b/Lib/test/test_asyncio/test_tasks.py
index b86646e..8df1957 100644
--- a/Lib/test/test_asyncio/test_tasks.py
+++ b/Lib/test/test_asyncio/test_tasks.py
@@ -113,7 +113,11 @@ class BaseTaskTests:
self.assertTrue(hasattr(t, '_cancel_message'))
self.assertEqual(t._cancel_message, None)
- t.cancel('my message')
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ t.cancel('my message')
self.assertEqual(t._cancel_message, 'my message')
with self.assertRaises(asyncio.CancelledError) as cm:
@@ -125,7 +129,11 @@ class BaseTaskTests:
async def coro():
pass
t = self.new_task(self.loop, coro())
- t.cancel('my message')
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ t.cancel('my message')
t._cancel_message = 'my new message'
self.assertEqual(t._cancel_message, 'my new message')
@@ -582,7 +590,14 @@ class BaseTaskTests:
async def coro():
task = self.new_task(loop, sleep())
await asyncio.sleep(0)
- task.cancel(*cancel_args)
+ if cancel_args not in ((), (None,)):
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ task.cancel(*cancel_args)
+ else:
+ task.cancel(*cancel_args)
done, pending = await asyncio.wait([task])
task.result()
@@ -616,7 +631,14 @@ class BaseTaskTests:
async def coro():
task = self.new_task(loop, sleep())
await asyncio.sleep(0)
- task.cancel(*cancel_args)
+ if cancel_args not in ((), (None,)):
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ task.cancel(*cancel_args)
+ else:
+ task.cancel(*cancel_args)
done, pending = await asyncio.wait([task])
task.exception()
@@ -639,10 +661,17 @@ class BaseTaskTests:
fut.set_result(None)
await asyncio.sleep(10)
+ def cancel(task, msg):
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ task.cancel(msg)
+
async def coro():
inner_task = self.new_task(loop, sleep())
await fut
- loop.call_soon(inner_task.cancel, 'msg')
+ loop.call_soon(cancel, inner_task, 'msg')
try:
await inner_task
except asyncio.CancelledError as ex:
@@ -668,7 +697,11 @@ class BaseTaskTests:
async def coro():
task = self.new_task(loop, sleep())
# We deliberately leave out the sleep here.
- task.cancel('my message')
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ task.cancel('my message')
done, pending = await asyncio.wait([task])
task.exception()
@@ -2029,7 +2062,14 @@ class BaseTaskTests:
async def main():
qwe = self.new_task(loop, test())
await asyncio.sleep(0.2)
- qwe.cancel(*cancel_args)
+ if cancel_args not in ((), (None,)):
+ with self.assertWarnsRegex(
+ DeprecationWarning,
+ "Passing 'msg' argument"
+ ):
+ qwe.cancel(*cancel_args)
+ else:
+ qwe.cancel(*cancel_args)
await qwe
try: