From 64f54b7ccd49764b0304e076bfd79b5482988f53 Mon Sep 17 00:00:00 2001 From: andrei kulakov Date: Wed, 21 Jul 2021 04:33:11 -0400 Subject: [PATCH] bpo-30511: Add note on thread safety to shutil.make_archive() (#26933) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ɓukasz Langa --- Doc/library/shutil.rst | 4 ++++ .../Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst | 2 ++ 2 files changed, 6 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index d5080da15bba41..11c67074921672 100644 --- 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 new file mode 100644 index 00000000000000..a358fb9cc2860b --- /dev/null +++ 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.