Oct 5, 2022 · Jun 22, 2022 · Jun 25, 2022 · Sep 29, 2022 · Sep 29, 2022 · Sep 29, 2022
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
   ..note::

      This function is not thread-safe when custom archivers registered
      with:func:`register_archive_format` are used.  In this case it
      with:func:`register_archive_format` do not support the *root_dir*
      argument.  In this case it
      temporarily changes the current working directory of the process
      to perform archiving.
      to*root_dir* toperform archiving.

   ..versionchanged::3.8
      The modern pax (POSIX.1-2001) format is now used instead of
   Further arguments are passed as keyword arguments: *owner*, *group*,
   *dry_run* and *logger* (as passed in:func:`make_archive`).

   If *function* has the custom attribute ``function.supports_root_dir`` set to ``True``,
   the *root_dir* argument is passed as a keyword argument.
   Otherwise the current working directory of the process is temporarily
   changed to *root_dir* before calling *function*.
   In this case:func:`make_archive` is not thread-safe.

   If given, *extra_args* is a sequence of ``(name, value)`` pairs that will be
   used as extra keywords arguments when the archiver callable is used.

   *description* is used by:func:`get_archive_formats` which returns the
   list of archivers.  Defaults to an empty string.

   ..versionchanged::3.12
      Added support for functions supporting the *root_dir* argument.


 ..function::unregister_archive_format(name)

diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
  for a process with :func:`os.pidfd_open` in non-blocking mode.
  (Contributed by Kumar Aditya in :gh:`93312`.)

 shutil
 ------

 * :func:`shutil.make_archive` now passes the *root_dir* argument to custom
  archivers which support it.
  In this case it no longer temporarily changes the current working directory
  of the process to *root_dir* to perform archiving.
  (Contributed by Serhiy Storchaka in :gh:`74696`.)


 sqlite3
 -------
diff --git a/Lib/shutil.py b/Lib/shutil.py
 zip_filename=os.path.abspath(zip_filename)
 returnzip_filename

 _make_tarball.supports_root_dir=True
 _make_zipfile.supports_root_dir=True

 # Maps the name of the archive format to a tuple containing:
 # * the archiving function
 # * extra keyword arguments
 # * description
 # * does it support the root_dir argument?
 _ARCHIVE_FORMATS= {
 'tar':   (_make_tarball, [('compress',None)],
 "uncompressed tar file",True),
 "uncompressed tar file"),
 }

 if_ZLIB_SUPPORTED:
 _ARCHIVE_FORMATS['gztar']= (_make_tarball, [('compress','gzip')],
 "gzip'ed tar-file",True)
 _ARCHIVE_FORMATS['zip']= (_make_zipfile, [],"ZIP file",True)
 "gzip'ed tar-file")
 _ARCHIVE_FORMATS['zip']= (_make_zipfile, [],"ZIP file")

 if_BZ2_SUPPORTED:
 _ARCHIVE_FORMATS['bztar']= (_make_tarball, [('compress','bzip2')],
 "bzip2'ed tar-file",True)
 "bzip2'ed tar-file")

 if_LZMA_SUPPORTED:
 _ARCHIVE_FORMATS['xztar']= (_make_tarball, [('compress','xz')],
 "xz'ed tar-file",True)
 "xz'ed tar-file")

 defget_archive_formats():
 """Returns a list of supported formats for archiving and unarchiving.
 ifnotisinstance(element, (tuple,list))orlen(element)!=2:
 raiseTypeError('extra_args elements are : (arg_name, value)')

 _ARCHIVE_FORMATS[name]= (function,extra_args,description,False)
 _ARCHIVE_FORMATS[name]= (function,extra_args,description)

 defunregister_archive_format(name):
 del_ARCHIVE_FORMATS[name]
 ifbase_dirisNone:
 base_dir=os.curdir

 support_root_dir=format_info[3]
 supports_root_dir=getattr(func,'supports_root_dir',False)
 save_cwd=None
 ifroot_dirisnotNone:
 ifsupport_root_dir:
 ifsupports_root_dir:
 # Support path-like base_name here for backwards-compatibility.
 base_name=os.fspath(base_name)
 kwargs['root_dir']=root_dir
diff --git a/Lib/test/test_shutil.py b/Lib/test/test_shutil.py
 finally:
 archive.close()

 deftest_make_archive_cwd_default(self):
 current_dir=os.getcwd()
 defarchiver(base_name,base_dir,**kw):
 self.assertNotIn('root_dir',kw)
 self.assertEqual(base_name,'basename')
 self.assertEqual(os.getcwd(),current_dir)
 raiseRuntimeError()

 register_archive_format('xxx',archiver, [],'xxx file')
 try:
 withno_chdir:
 withself.assertRaises(RuntimeError):
 make_archive('basename','xxx')
 self.assertEqual(os.getcwd(),current_dir)
 finally:
 unregister_archive_format('xxx')

 deftest_make_archive_cwd(self):
 current_dir=os.getcwd()
 root_dir=self.mkdtemp()
 def_breaks(*args,**kw):
 defarchiver(base_name,base_dir,**kw):
 self.assertNotIn('root_dir',kw)
 self.assertEqual(base_name,os.path.join(current_dir,'basename'))
 self.assertEqual(os.getcwd(),root_dir)
 raiseRuntimeError()
 dirs= []
 def_chdir(path):
 dirs.append(path)
 orig_chdir(path)

 register_archive_format('xxx',_breaks, [],'xxx file')
 register_archive_format('xxx',archiver, [],'xxx file')
 try:
 withsupport.swap_attr(os,'chdir',_chdir)asorig_chdir:
 try:
 make_archive('xxx','xxx',root_dir=root_dir)
 exceptException:
 pass
 withself.assertRaises(RuntimeError):
 make_archive('basename','xxx',root_dir=root_dir)
 self.assertEqual(os.getcwd(),current_dir)
 self.assertEqual(dirs, [root_dir,current_dir])
 finally:
 unregister_archive_format('xxx')

 deftest_make_archive_cwd_supports_root_dir(self):
 current_dir=os.getcwd()
 root_dir=self.mkdtemp()
 defarchiver(base_name,base_dir,**kw):
 self.assertEqual(base_name,'basename')
 self.assertEqual(kw['root_dir'],root_dir)
 self.assertEqual(os.getcwd(),current_dir)
 raiseRuntimeError()
 archiver.supports_root_dir=True

 register_archive_format('xxx',archiver, [],'xxx file')
 try:
 withno_chdir:
 withself.assertRaises(RuntimeError):
 make_archive('basename','xxx',root_dir=root_dir)
 self.assertEqual(os.getcwd(),current_dir)
 finally:
 unregister_archive_format('xxx')

 deftest_make_tarfile_in_curdir(self):
 # Issue #21280
 root_dir=self.mkdtemp()
diff --git a/Misc/NEWS.d/next/Library/2022-06-25-09-12-23.gh-issue-74696.fxC9ua.rst b/Misc/NEWS.d/next/Library/2022-06-25-09-12-23.gh-issue-74696.fxC9ua.rst
 :func:`shutil.make_archive` now passes the *root_dir* argument to custom
 archivers which support it.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -575,9 +575,10 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
		..note::

		This function is not thread-safe when custom archivers registered
		with:func:`register_archive_format` are used. In this case it
		with:func:`register_archive_format` do not support the root_dir
		argument. In this case it
		temporarily changes the current working directory of the process
		to perform archiving.
		toroot_dir toperform archiving.

		..versionchanged::3.8
		The modern pax (POSIX.1-2001) format is now used instead of
Expand DownExpand Up		@@ -614,12 +615,21 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
		Further arguments are passed as keyword arguments: owner, group,
		dry_run and logger (as passed in:func:`make_archive`).

		If function has the custom attribute ``function.supports_root_dir`` set to ``True``,
		the root_dir argument is passed as a keyword argument.
		Otherwise the current working directory of the process is temporarily
		changed to root_dir before calling function.
		In this case:func:`make_archive` is not thread-safe.

		If given, extra_args is a sequence of ``(name, value)`` pairs that will be
		used as extra keywords arguments when the archiver callable is used.

		description is used by:func:`get_archive_formats` which returns the
		list of archivers. Defaults to an empty string.

		..versionchanged::3.12
		Added support for functions supporting the root_dir argument.


		..function::unregister_archive_format(name)

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -127,6 +127,15 @@ os
		for a process with :func:`os.pidfd_open` in non-blocking mode.
		(Contributed by Kumar Aditya in :gh:`93312`.)

		shutil
		------

		* :func:`shutil.make_archive` now passes the root_dir argument to custom
		archivers which support it.
		In this case it no longer temporarily changes the current working directory
		of the process to root_dir to perform archiving.
		(Contributed by Serhiy Storchaka in :gh:`74696`.)


		sqlite3
		-------
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1023,28 +1023,30 @@ def _make_zipfile(base_name, base_dir, verbose=0, dry_run=0,
		zip_filename=os.path.abspath(zip_filename)
		returnzip_filename

		_make_tarball.supports_root_dir=True
		_make_zipfile.supports_root_dir=True

		# Maps the name of the archive format to a tuple containing:
		# * the archiving function
		# * extra keyword arguments
		# * description
		# * does it support the root_dir argument?
		_ARCHIVE_FORMATS= {
		'tar': (_make_tarball, [('compress',None)],
		"uncompressed tar file",True),
		"uncompressed tar file"),
		}

		if_ZLIB_SUPPORTED:
		_ARCHIVE_FORMATS['gztar']= (_make_tarball, [('compress','gzip')],
		"gzip'ed tar-file",True)
		_ARCHIVE_FORMATS['zip']= (_make_zipfile, [],"ZIP file",True)
		"gzip'ed tar-file")
		_ARCHIVE_FORMATS['zip']= (_make_zipfile, [],"ZIP file")

		if_BZ2_SUPPORTED:
		_ARCHIVE_FORMATS['bztar']= (_make_tarball, [('compress','bzip2')],
		"bzip2'ed tar-file",True)
		"bzip2'ed tar-file")

		if_LZMA_SUPPORTED:
		_ARCHIVE_FORMATS['xztar']= (_make_tarball, [('compress','xz')],
		"xz'ed tar-file",True)
		"xz'ed tar-file")

		defget_archive_formats():
		"""Returns a list of supported formats for archiving and unarchiving.
Expand DownExpand Up		@@ -1075,7 +1077,7 @@ def register_archive_format(name, function, extra_args=None, description=''):
		ifnotisinstance(element, (tuple,list))orlen(element)!=2:
		raiseTypeError('extra_args elements are : (arg_name, value)')

		_ARCHIVE_FORMATS[name]= (function,extra_args,description,False)
		_ARCHIVE_FORMATS[name]= (function,extra_args,description)

		defunregister_archive_format(name):
		del_ARCHIVE_FORMATS[name]
Expand DownExpand Up		@@ -1114,10 +1116,10 @@ def make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0,
		ifbase_dirisNone:
		base_dir=os.curdir

		support_root_dir=format_info[3]
		supports_root_dir=getattr(func,'supports_root_dir',False)
		save_cwd=None
		ifroot_dirisnotNone:
		ifsupport_root_dir:
		ifsupports_root_dir:
		# Support path-like base_name here for backwards-compatibility.
		base_name=os.fspath(base_name)
		kwargs['root_dir']=root_dir
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1568,28 +1568,65 @@ def test_tarfile_root_owner(self):
		finally:
		archive.close()

		deftest_make_archive_cwd_default(self):
		current_dir=os.getcwd()
		defarchiver(base_name,base_dir,**kw):
		self.assertNotIn('root_dir',kw)
		self.assertEqual(base_name,'basename')
		self.assertEqual(os.getcwd(),current_dir)
		raiseRuntimeError()

		register_archive_format('xxx',archiver, [],'xxx file')
		try:
		withno_chdir:
		withself.assertRaises(RuntimeError):
		make_archive('basename','xxx')
		self.assertEqual(os.getcwd(),current_dir)
		finally:
		unregister_archive_format('xxx')

		deftest_make_archive_cwd(self):
		current_dir=os.getcwd()
		root_dir=self.mkdtemp()
		def_breaks(args,*kw):
		defarchiver(base_name,base_dir,**kw):
		self.assertNotIn('root_dir',kw)
		self.assertEqual(base_name,os.path.join(current_dir,'basename'))
		self.assertEqual(os.getcwd(),root_dir)
		raiseRuntimeError()
		dirs= []
		def_chdir(path):
		dirs.append(path)
		orig_chdir(path)

		register_archive_format('xxx',_breaks, [],'xxx file')
		register_archive_format('xxx',archiver, [],'xxx file')
		try:
		withsupport.swap_attr(os,'chdir',_chdir)asorig_chdir:
		try:
		make_archive('xxx','xxx',root_dir=root_dir)
		exceptException:
		pass
		withself.assertRaises(RuntimeError):
		make_archive('basename','xxx',root_dir=root_dir)
		self.assertEqual(os.getcwd(),current_dir)
		self.assertEqual(dirs, [root_dir,current_dir])
		finally:
		unregister_archive_format('xxx')

		deftest_make_archive_cwd_supports_root_dir(self):
		current_dir=os.getcwd()
		root_dir=self.mkdtemp()
		defarchiver(base_name,base_dir,**kw):
		self.assertEqual(base_name,'basename')
		self.assertEqual(kw['root_dir'],root_dir)
		self.assertEqual(os.getcwd(),current_dir)
		raiseRuntimeError()
		archiver.supports_root_dir=True

		register_archive_format('xxx',archiver, [],'xxx file')
		try:
		withno_chdir:
		withself.assertRaises(RuntimeError):
		make_archive('basename','xxx',root_dir=root_dir)
		self.assertEqual(os.getcwd(),current_dir)
		finally:
		unregister_archive_format('xxx')

		deftest_make_tarfile_in_curdir(self):
		# Issue #21280
		root_dir=self.mkdtemp()
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		:func:`shutil.make_archive` now passes the root_dir argument to custom
		archivers which support it.