mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-23 09:19:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

gh-74696: Pass root_dir to custom archivers which support it (GH-94251)

Browse source 
Co-authored-by: Éric <merwok@netwok.org>
This commit is contained in:
Serhiy Storchaka 2022-10-05 12:48:59 +03:00 • committed by GitHub
parent 4b83cd0b22
commit e3ef400be7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 77 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Lib/shutil.py
View file

@ -1023,28 +1023,30 @@ def _make_zipfile(base_name, base_dir, verbose=0, dry_run=0,
zip_filename = os.path.abspath(zip_filename)
return zip_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")
def get_archive_formats():
"""Returns a list of supported formats for archiving and unarchiving.
@ -1075,7 +1077,7 @@ def register_archive_format(name, function, extra_args=None, description=''):
if not isinstance(element, (tuple, list)) or len(element) !=2:
raise TypeError('extra_args elements are : (arg_name, value)')
_ARCHIVE_FORMATS[name] = (function, extra_args, description, False)
_ARCHIVE_FORMATS[name] = (function, extra_args, description)
def unregister_archive_format(name):
del _ARCHIVE_FORMATS[name]
@ -1114,10 +1116,10 @@ def make_archive(base_name, format, root_dir=None, base_dir=None, verbose=0,
if base_dir is None:
base_dir = os.curdir
support_root_dir = format_info[3]
supports_root_dir = getattr(func, 'supports_root_dir', False)
save_cwd = None
if root_dir is not None:
if support_root_dir:
if supports_root_dir:
# Support path-like base_name here for backwards-compatibility.
base_name = os.fspath(base_name)
kwargs['root_dir'] = root_dir

49
Lib/test/test_shutil.py
View file

@ -1568,28 +1568,65 @@ class TestArchives(BaseTest, unittest.TestCase):
finally:
archive.close()
def test_make_archive_cwd_default(self):
current_dir = os.getcwd()
def archiver(base_name, base_dir, **kw):
self.assertNotIn('root_dir', kw)
self.assertEqual(base_name, 'basename')
self.assertEqual(os.getcwd(), current_dir)
raise RuntimeError()
register_archive_format('xxx', archiver, [], 'xxx file')
try:
with no_chdir:
with self.assertRaises(RuntimeError):
make_archive('basename', 'xxx')
self.assertEqual(os.getcwd(), current_dir)
finally:
unregister_archive_format('xxx')
def test_make_archive_cwd(self):
current_dir = os.getcwd()
root_dir = self.mkdtemp()
def _breaks(*args, **kw):
def archiver(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)
raise RuntimeError()
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:
with support.swap_attr(os, 'chdir', _chdir) as orig_chdir:
try:
make_archive('xxx', 'xxx', root_dir=root_dir)
except Exception:
pass
with self.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')
def test_make_archive_cwd_supports_root_dir(self):
current_dir = os.getcwd()
root_dir = self.mkdtemp()
def archiver(base_name, base_dir, **kw):
self.assertEqual(base_name, 'basename')
self.assertEqual(kw['root_dir'], root_dir)
self.assertEqual(os.getcwd(), current_dir)
raise RuntimeError()
archiver.supports_root_dir = True
register_archive_format('xxx', archiver, [], 'xxx file')
try:
with no_chdir:
with self.assertRaises(RuntimeError):
make_archive('basename', 'xxx', root_dir=root_dir)
self.assertEqual(os.getcwd(), current_dir)
finally:
unregister_archive_format('xxx')
def test_make_tarfile_in_curdir(self):
# Issue #21280
root_dir = self.mkdtemp()