Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
cpython/Lib/distutils/archive_util.py at v3.5.3 · python/cpython · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
python
/
cpython
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
35.4k
Star
77.2k
Code
Issues
5k+
Pull requests
2.6k
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
v3.5.3
Breadcrumbs
cpython
/
Lib
/
distutils
/
archive_util.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
248 lines (202 loc) · 7.93 KB
v3.5.3
Breadcrumbs
cpython
/
Lib
/
distutils
/
archive_util.py
Copy path
Top
File metadata and controls
Code
Blame
248 lines (202 loc) · 7.93 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
"""distutils.archive_util
Utility functions for creating archive files (tarballs, zip files,
that sort of thing)."""
import
os
from
warnings
import
warn
import
sys
try
:
import
zipfile
except
ImportError
:
zipfile
=
None
from
distutils
.
errors
import
DistutilsExecError
from
distutils
.
spawn
import
spawn
from
distutils
.
dir_util
import
mkpath
from
distutils
import
log
try
:
from
pwd
import
getpwnam
except
ImportError
:
getpwnam
=
None
try
:
from
grp
import
getgrnam
except
ImportError
:
getgrnam
=
None
def
_get_gid
(
name
):
"""Returns a gid, given a group name."""
if
getgrnam
is
None
or
name
is
None
:
return
None
try
:
result
=
getgrnam
(
name
)
except
KeyError
:
result
=
None
if
result
is
not
None
:
return
result
[
2
]
return
None
def
_get_uid
(
name
):
"""Returns an uid, given a user name."""
if
getpwnam
is
None
or
name
is
None
:
return
None
try
:
result
=
getpwnam
(
name
)
except
KeyError
:
result
=
None
if
result
is
not
None
:
return
result
[
2
]
return
None
def
make_tarball
(
base_name
,
base_dir
,
compress
=
"gzip"
,
verbose
=
0
,
dry_run
=
0
,
owner
=
None
,
group
=
None
):
"""Create a (possibly compressed) tar file from all the files under
'base_dir'.
'compress' must be "gzip" (the default), "bzip2", "xz", "compress", or
None. ("compress" will be deprecated in Python 3.2)
'owner' and 'group' can be used to define an owner and a group for the
archive that is being built. If not provided, the current owner and group
will be used.
The output tar file will be named 'base_dir' + ".tar", possibly plus
the appropriate compression extension (".gz", ".bz2", ".xz" or ".Z").
Returns the output filename.
"""
tar_compression
=
{
'gzip'
:
'gz'
,
'bzip2'
:
'bz2'
,
'xz'
:
'xz'
,
None
:
''
,
'compress'
:
''
}
compress_ext
=
{
'gzip'
:
'.gz'
,
'bzip2'
:
'.bz2'
,
'xz'
:
'.xz'
,
'compress'
:
'.Z'
}
# flags for compression program, each element of list will be an argument
if
compress
is
not
None
and
compress
not
in
compress_ext
.
keys
():
raise
ValueError
(
"bad value for 'compress': must be None, 'gzip', 'bzip2', "
"'xz' or 'compress'"
)
archive_name
=
base_name
+
'.tar'
if
compress
!=
'compress'
:
archive_name
+=
compress_ext
.
get
(
compress
,
''
)
mkpath
(
os
.
path
.
dirname
(
archive_name
),
dry_run
=
dry_run
)
# creating the tarball
import
tarfile
# late import so Python build itself doesn't break
log
.
info
(
'Creating tar archive'
)
uid
=
_get_uid
(
owner
)
gid
=
_get_gid
(
group
)
def
_set_uid_gid
(
tarinfo
):
if
gid
is
not
None
:
tarinfo
.
gid
=
gid
tarinfo
.
gname
=
group
if
uid
is
not
None
:
tarinfo
.
uid
=
uid
tarinfo
.
uname
=
owner
return
tarinfo
if
not
dry_run
:
tar
=
tarfile
.
open
(
archive_name
,
'w|%s'
%
tar_compression
[
compress
])
try
:
tar
.
add
(
base_dir
,
filter
=
_set_uid_gid
)
finally
:
tar
.
close
()
# compression using `compress`
if
compress
==
'compress'
:
warn
(
"'compress' will be deprecated."
,
PendingDeprecationWarning
)
# the option varies depending on the platform
compressed_name
=
archive_name
+
compress_ext
[
compress
]
if
sys
.
platform
==
'win32'
:
cmd
=
[
compress
,
archive_name
,
compressed_name
]
else
:
cmd
=
[
compress
,
'-f'
,
archive_name
]
spawn
(
cmd
,
dry_run
=
dry_run
)
return
compressed_name
return
archive_name
def
make_zipfile
(
base_name
,
base_dir
,
verbose
=
0
,
dry_run
=
0
):
"""Create a zip file from all the files under 'base_dir'.
The output zip file will be named 'base_name' + ".zip". Uses either the
"zipfile" Python module (if available) or the InfoZIP "zip" utility
(if installed and found on the default search path). If neither tool is
available, raises DistutilsExecError. Returns the name of the output zip
file.
"""
zip_filename
=
base_name
+
".zip"
mkpath
(
os
.
path
.
dirname
(
zip_filename
),
dry_run
=
dry_run
)
# If zipfile module is not available, try spawning an external
# 'zip' command.
if
zipfile
is
None
:
if
verbose
:
zipoptions
=
"-r"
else
:
zipoptions
=
"-rq"
try
:
spawn
([
"zip"
,
zipoptions
,
zip_filename
,
base_dir
],
dry_run
=
dry_run
)
except
DistutilsExecError
:
# XXX really should distinguish between "couldn't find
# external 'zip' command" and "zip failed".
raise
DistutilsExecError
((
"unable to create zip file '%s': "
"could neither import the 'zipfile' module nor "
"find a standalone zip utility"
)
%
zip_filename
)
else
:
log
.
info
(
"creating '%s' and adding '%s' to it"
,
zip_filename
,
base_dir
)
if
not
dry_run
:
try
:
zip
=
zipfile
.
ZipFile
(
zip_filename
,
"w"
,
compression
=
zipfile
.
ZIP_DEFLATED
)
except
RuntimeError
:
zip
=
zipfile
.
ZipFile
(
zip_filename
,
"w"
,
compression
=
zipfile
.
ZIP_STORED
)
for
dirpath
,
dirnames
,
filenames
in
os
.
walk
(
base_dir
):
for
name
in
filenames
:
path
=
os
.
path
.
normpath
(
os
.
path
.
join
(
dirpath
,
name
))
if
os
.
path
.
isfile
(
path
):
zip
.
write
(
path
,
path
)
log
.
info
(
"adding '%s'"
%
path
)
zip
.
close
()
return
zip_filename
ARCHIVE_FORMATS
=
{
'gztar'
: (
make_tarball
, [(
'compress'
,
'gzip'
)],
"gzip'ed tar-file"
),
'bztar'
: (
make_tarball
, [(
'compress'
,
'bzip2'
)],
"bzip2'ed tar-file"
),
'xztar'
: (
make_tarball
, [(
'compress'
,
'xz'
)],
"xz'ed tar-file"
),
'ztar'
: (
make_tarball
, [(
'compress'
,
'compress'
)],
"compressed tar file"
),
'tar'
: (
make_tarball
, [(
'compress'
,
None
)],
"uncompressed tar file"
),
'zip'
: (
make_zipfile
, [],
"ZIP file"
)
}
def
check_archive_formats
(
formats
):
"""Returns the first format from the 'format' list that is unknown.
If all formats are known, returns None
"""
for
format
in
formats
:
if
format
not
in
ARCHIVE_FORMATS
:
return
format
return
None
def
make_archive
(
base_name
,
format
,
root_dir
=
None
,
base_dir
=
None
,
verbose
=
0
,
dry_run
=
0
,
owner
=
None
,
group
=
None
):
"""Create an archive file (eg. zip or tar).
'base_name' is the name of the file to create, minus any format-specific
extension; 'format' is the archive format: one of "zip", "tar", "gztar",
"bztar", "xztar", or "ztar".
'root_dir' is a directory that will be the root directory of the
archive; ie. we typically chdir into 'root_dir' before creating the
archive. 'base_dir' is the directory where we start archiving from;
ie. 'base_dir' will be the common prefix of all files and
directories in the archive. 'root_dir' and 'base_dir' both default
to the current directory. Returns the name of the archive file.
'owner' and 'group' are used when creating a tar archive. By default,
uses the current owner and group.
"""
save_cwd
=
os
.
getcwd
()
if
root_dir
is
not
None
:
log
.
debug
(
"changing into '%s'"
,
root_dir
)
base_name
=
os
.
path
.
abspath
(
base_name
)
if
not
dry_run
:
os
.
chdir
(
root_dir
)
if
base_dir
is
None
:
base_dir
=
os
.
curdir
kwargs
=
{
'dry_run'
:
dry_run
}
try
:
format_info
=
ARCHIVE_FORMATS
[
format
]
except
KeyError
:
raise
ValueError
(
"unknown archive format '%s'"
%
format
)
func
=
format_info
[
0
]
for
arg
,
val
in
format_info
[
1
]:
kwargs
[
arg
]
=
val
if
format
!=
'zip'
:
kwargs
[
'owner'
]
=
owner
kwargs
[
'group'
]
=
group
try
:
filename
=
func
(
base_name
,
base_dir
,
**
kwargs
)
finally
:
if
root_dir
is
not
None
:
log
.
debug
(
"changing back to '%s'"
,
save_cwd
)
os
.
chdir
(
save_cwd
)
return
filename
You can’t perform that action at this time.