bpo-30511: Add note on thread safety to shutil.make_archive() (#26933)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
python · Jul 21, 2021 · 64f54b7 · 64f54b7
1 parent 3b56b3b
commit 64f54b7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
@@ -595,6 +595,10 @@ provided.  They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
 
    .. audit-event:: shutil.make_archive base_name,format,root_dir,base_dir shutil.make_archive
 
+   .. note::
+
+      This function is not thread-safe.
+
    .. versionchanged:: 3.8
       The modern pax (POSIX.1-2001) format is now used instead of
       the legacy GNU format for archives created with ``format="tar"``.

diff --git a/Misc/NEWS.d/next/Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst b/Misc/NEWS.d/next/Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst
@@ -0,0 +1,2 @@
+Clarify that :func:`shutil.make_archive` is not thread-safe due to
+reliance on changing the current working directory.