[Python-checkins] bpo-39349: Add cancel_futures to Executor.shutdown base class (GH-22023)

[Shantanu]

https://github.com/python/cpython/commit/17dc1b789ecc33b4a254eb3b799085f4b3624ca5
commit: 17dc1b789ecc33b4a254eb3b799085f4b3624ca5
branch: master
author: Shantanu <12621235+hauntsaninja at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2020-09-01T17:18:07-04:00
summary:

bpo-39349: Add cancel_futures to Executor.shutdown base class (GH-22023)

* Add cancel_futures parameter to the Executor base class, since it was missed in the original PR (https://github.com/python/cpython/pull/18057) that added cancel_futures.

files:
M Lib/concurrent/futures/_base.py

diff --git a/Lib/concurrent/futures/_base.py b/Lib/concurrent/futures/_base.py
index bf546f8ae1d1c..00eb54881f295 100644
--- a/Lib/concurrent/futures/_base.py
+++ b/Lib/concurrent/futures/_base.py
@@ -605,7 +605,7 @@ def result_iterator():
                     future.cancel()
         return result_iterator()
 
-    def shutdown(self, wait=True):
+    def shutdown(self, wait=True, *, cancel_futures=False):
         """Clean-up the resources associated with the Executor.
 
         It is safe to call this method several times. Otherwise, no other
@@ -615,6 +615,9 @@ def shutdown(self, wait=True):
             wait: If True then shutdown will not return until all running
                 futures have finished executing and the resources used by the
                 executor have been reclaimed.
+            cancel_futures: If True then shutdown will cancel all pending
+                futures. Futures that are completed or running will not be
+                cancelled.
         """
         pass