o
0iv @ s d Z dZdZdZddlmZ ddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZddlZzddlZW n eyG dZY nw zddlZW n eyY dZY nw eefZzeef7 ZW n eyn Y nw g dZdZd Zed
Z d Z d Z d
Z d
Z dZ!dZ"dZ#dZ$dZ%dZ&dZ'dZ(dZ)dZ*dZ+dZ,dZ-dZ.dZ/d Z0dZ1d Z2d Z3e3Z4e"e#e$e%e(e)e*e&e'e+e,e-f Z5e"e#e*e-fZ6e+e,e-fZ7d Z8h d Z9e:e:e:e;e;e;d!Zne? Z>d$d% Z@d&d' ZAd(d) ZBd*e4fd+d,ZCd-d. ZDdedfd/d0ZEd1d2 ZFG d3d4 d4eGZHG d5d6 d6eHZIG d7d8 d8eHZJG d9d: d:eHZKG d;d< d d>eHZMG d?d@ d@eMZNG dAdB dBeMZOG dCdD dDeMZPG dEdF dFeMZQG dGdH dHeMZRG dIdJ dJZSG dKdL dLZTG dMdN dNeUZVG dOdP dPeUZWG dQdR dRe jXZYG dSdT dTeHZZG dUdV dVeZZ[G dWdX dXeZZ\G dYdZ dZeZZ]G d[d\ d\eZZ^G d]d^ d^eZZ_G d_d` d`eZZ`eZeeIfZadudbdcZbddde Zcdfdg Zddhdi ZeecedeedjZfeU ZgehdkZiG dldm dmeUZjG dndo doeUZkdpdq ZlekjZdrds Zmendtkrem dS dS )vz,Read from and write to tar format archives.
z0.9.0u" Lars Gustäbel (lars@gustaebel.de)u4 Gustavo Niemeyer, Niels Gustäbel, Richard Townsend. )openN)TarFileTarInfo
is_tarfileTarError ReadErrorCompressionError StreamError ExtractError HeaderErrorENCODING USTAR_FORMAT
GNU_FORMAT
PAX_FORMATDEFAULT_FORMATr i s ustar s ustar 00d 0 1 2 3 4 5 6 7 L K S x g X )pathlinkpathsizemtimeuidgidunamegname> r+ r& r% r, )Zatimectimer( r) r* r' ntutf-8c C s8 | du rt d| ||} | d| |t| t S )z8Convert a string to a null-terminated bytes object.
Nz metadata cannot contain None)
ValueErrorencodelenNUL)slengthencodingerrors r8 ./opt/alt/python310/lib64/python3.10/tarfile.pystn s r: c C s* | d}|dkr| d| } | ||S )z8Convert a null-terminated bytes object to a string.
r N)finddecode)r4 r6 r7 pr8 r8 r9 nts s
r? c C s | d dv r2d}t t| d D ]}|dK }|| |d 7 }q| d dkr0dt| d | }|S zt| dd} t| p?d d}W |S tyO td
w ) z/Convert a number field to a python number.
r ) r# rA asciistrict0invalid header)ranger2 r? intstripr0 InvalidHeaderError)r4 nir8 r8 r9 nti s rN rB c C s | }t | } d| krd|d k r%n ntd|d | f dt }|S |tkrmd|d | kr s
r c @ sj e Zd ZdZdddZdd Zdd Zd d
Zd d Zd
d Z e
j fddZ dddZ
dd Zdd ZdS ) _FileInFilezA thin wrapper around an existing file object that
provides a part of its data as an individual file
object.
Nc C s || _ || _|| _d| _t|dd | _d| _|d u r d|fg}d| _g | _d}| j}|D ]&\}}||kr>| j d||d f | j d||| |f ||7 }|| }q,|| jk re| j d|| jd f d S d S )Nr r FT)
r offsetr' positionrh r r map_indexmapr )r r r r' Z blockinfoZlastposZrealposr8 r8 r9 r b s*
z_FileInFile.__init__c C s d S r r8 r r8 r8 r9 r { z_FileInFile.flushc C dS NTr8 r r8 r8 r9 readable~ r z_FileInFile.readablec C r NFr8 r r8 r8 r9 writable r z_FileInFile.writablec C s
| j S r )r seekabler r8 r8 r9 r
z_FileInFile.seekablec C r )z*Return the current file position.
)r r r8 r8 r9 r r z_FileInFile.tellc C s |t jkrtt|d| j| _| jS |t jkr4|dk r't| j| d| _| jS t| j| | j| _| jS |t jkrItt| j| | jd| _| jS td)z(Seek to a position in the file.
r zInvalid argument) ioSEEK_SETminmaxr' r SEEK_CURSEEK_ENDr0 )r r whencer8 r8 r9 r s
z_FileInFile.seekc C s |du r | j | j }n t|| j | j }d}|dkr | j| j \}}}}|| j kr0|k r3n nn| jd7 _| jt| jkrEd| _qt||| j }|rp| j|| j| | j|}t||krkt d||7 }n|t
| 7 }||8 }| j|7 _|dks|S )z!Read data from the file.
Nr r Tr# rY ) r' r r r r r2 r r r] r r3 ) r r' rW datastartstopr r5 rd r8 r8 r9 r] s2
z_FileInFile.readc C s& | t|}||d t|< t|S r )r] r2 )r rd rW r8 r8 r9 readinto s z_FileInFile.readintoc C s
d| _ d S r )r r r8 r8 r9 r r z_FileInFile.closer )ro rp rq rr r r r r r r r r r r] r r r8 r8 r8 r9 r \ s
r c e Zd Z fddZ ZS ) ExFileObjectc s& t |j|j|j|j}t | d S r )r r offset_datar' sparsesuperr )r tarfiletarinfor __class__r8 r9 r s
zExFileObject.__init__ro rp rq r
__classcell__r8 r8 r r9 r s r c @ s e Zd ZdS ) FilterErrorN)ro rp rq r8 r8 r8 r9 r s r c r )AbsolutePathErrorc s || _ t d|jd d S )Nzmember z has an absolute pathr r r r r r r r8 r9 r s zAbsolutePathError.__init__r r8 r8 r r9 r r c r )OutsideDestinationErrorc . || _ || _t |jd|dd d S )Nz would be extracted to , which is outside the destinationr _pathr r r r r r% r r8 r9 r
z OutsideDestinationError.__init__r r8 r8 r r9 r r r c r )SpecialFileErrorc || _ t |jd d S )Nz is a special filer r r r8 r9 r zSpecialFileError.__init__r r8 r8 r r9 r r r c r )AbsoluteLinkErrorc r )Nz is a link to an absolute pathr r r r8 r9 r r zAbsoluteLinkError.__init__r r8 r8 r r9 r r r c r )LinkOutsideDestinationErrorc r )Nz would link to r r r r r r8 r9 r r z$LinkOutsideDestinationError.__init__r r8 r8 r r9 r r r c r )LinkFallbackErrorc s2 || _ || _t d|jdd|d d S )Nzlink z would be extracted as a zcopy of z, which was rejectedr r r r8 r9 r s
zLinkFallbackError.__init__r r8 r8 r r9 r r r Tc C s i }| j }tjj|tjjd}|dtjfr$| jdtj }|d< tj|r.t | tjjtj
||tjjd}tj ||g|krLt | || j
}|d ur|d@ }|r}| sa| rn|d@ si|dM }|dO }n| sv| ryd }nt| || j
kr||d< |r| jd urd |d < | jd urd |d
< | jd urd |d < | jd urd |d < | s| rtj| jrt| tj| j}|| jkr||d
< | rtj
|tj|| j}ntj
|| j}tjj|tjjd}tj ||g|krt| ||S )N)rE /r i @ i r r) r* r+ r, linkname) r r~ r% realpath
ALLOW_MISSINGr seplstripisabsr r
commonpathr r isregislnkisdirissymr r) r* r+ r, r r normpathdirnamer )member dest_pathZfor_data new_attrsr Z target_pathr Z
normalizedr8 r8 r9 _get_filtered_attrs sl
r c C s | S r r8 )r r r8 r8 r9 fully_trusted_filterA r r c C s, t | |d}|r| jdi |ddiS | S )NFdeepr8 r r r r r r8 r8 r9
tar_filterD r! c C s, t | |d}|r| jdi |ddiS | S )NTr Fr8 r r r8 r8 r9 data_filterJ r" r# )Z
fully_trustedr r s ([0-9]{1,20}) c @ s, e Zd ZdZed|i dddddddd d
d d d
ddddddddddddddd d d d d d!d"d#d$d%d&d%d'd%Zd}d)d*Zed+d, Zej d-d, Zed.d/ Z
e
j d0d/ Z
d1d2 Z e e e e e e e e d3e d4
d5d6Z
d7d8 Zeed9fd:d;Zdd? Zd@dA ZedBdC ZdDdE ZedFdG ZedHdI ZedJdK ZedLdM Z edNdO Z edPdQ Z dRdS Z dTdU Z dVdW Z!dXdY Z"dZd[ Z#d\d] Z$d^d_ Z%d`da Z&dbdc Z'ddde Z(dfdg Z)dhdi Z*djdk Z+dldm Z,dndo Z-dpdq Z.drds Z/dtdu Z0dvdw Z1dxdy Z2dzd{ Z3d%S )~r a Informational class which holds the details about an
archive member given by a tar header block.
TarInfo objects are returned by TarFile.getmember(),
TarFile.getmembers() and TarFile.gettarinfo() and are
usually created internally.
r zName of the archive member.r zPermission bits.r) z6User ID of the user who originally stored this member.r* z7Group ID of the user who originally stored this member.r' zSize in bytes.r( zTime of last modification.chksumzHeader checksum.typezFile type. type is usually one of these constants: REGTYPE, AREGTYPE, LNKTYPE, SYMTYPE, DIRTYPE, FIFOTYPE, CONTTYPE, CHRTYPE, BLKTYPE, GNUTYPE_SPARSE.r zcName of the target file name, which is only present in TarInfo objects of type LNKTYPE and SYMTYPE.r+ z
User name.r, z Group name.devmajorzDevice major number.devminorzDevice minor number.r zThe tar header starts here.r z The file's data starts here. pax_headerszMA dictionary containing key-value pairs of an associated pax extended header.r zSparse member information.r N_sparse_structs _link_targetr c C sj || _ d| _d| _d| _d| _d| _d| _t| _d| _ d| _
d| _ d| _ d| _
d| _d| _d| _i | _dS )zXConstruct a TarInfo object. name is the optional name
of the member.
i r r N)r r r) r* r' r( r$ REGTYPEr% r r+ r, r& r' r r r r( r r r8 r8 r9 r s"
zTarInfo.__init__c C r )z(In pax headers, "name" is called "path".r r r8 r8 r9 r% r z TarInfo.pathc C
|| _ d S r r- r, r8 r8 r9 r%
c C r )z0In pax headers, "linkname" is called "linkpath".r r r8 r8 r9 r& r zTarInfo.linkpathc C r. r r0 )r r r8 r8 r9 r& r/ c C s d| j j| jt| f S )Nz<%s %r at %#x>)r ro r idr r8 r8 r9 __repr__ s zTarInfo.__repr__T)
r r( r r r) r* r+ r, r _KEEPc
C s | rt | } nt | } ||
ur|| _||
ur|| _||
ur"|| _||
ur)|| _||
ur0|| _||
ur7|| _||
ur>|| _||
urE|| _ | S )zGReturn a deep copy of self with the given attributes replaced.
)
copyZdeepcopyr r( r r r) r* r+ r, ) r r r( r r r) r* r+ r, r r3 resultr8 r8 r9 r s(
zTarInfo.replacec C s | j du rd}n| j d@ }| j|| j| j| j| j| j| j| j| j | j
| j | j d
}|d t
kr>|d ds>|d d7 < |S )z9Return the TarInfo's attributes as a dictionary.
N )
r r r) r* r' r( r$ r% r r+ r, r& r' r% r r )r r r) r* r' r( r$ r% r r+ r, r& r' DIRTYPEr )r r infor8 r8 r9 get_info s(
zTarInfo.get_infosurrogateescapec C sv | }| D ]\}}|du rtd| q|tkr"| |||S |tkr-| |||S |tkr7| ||S td)z sD
zTarInfo.create_pax_headerc C s | |tdS )zAReturn the object as a pax global header block sequence.
r/ )rS XGLTYPE)clsr( r8 r8 r9 create_pax_global_headerN s z TarInfo.create_pax_global_headerc C s| | d}tdt|D ]-}d|d| }d||d }t|||tkr9t|||tkr9 ||fS q td)zUSplit a name longer than 100 chars into a prefix
and a name part.
r r# Nzname is too long)splitrH r2 r r1
LENGTH_PREFIXrE r0 )r r r6 r7 Z
componentsrM rB r8 r8 r9 rF T s
zTarInfo._posix_split_namec C s | dttfv }|r t| ddd|}t| ddd|}ntdd||}tdd||}| dt}|du r r8 r8 r8 r9 rS sB
( z"TarInfo._create_pax_generic_headerc C sf t |dkr
tdt |tkrtd|ttkr tdt|dd }|t|vr1t d| }t
|dd |||_ t|dd |_ t|d d
|_
t|d
d |_t|d d |_t|d d |_||_|dd
|_t
|d
d |||_t
|dd |||_t
|dd |||_t|dd |_t|dd |_t
|dd ||}|jtkr|j drt|_|jtkrd}g }t dD ]0} zt|||d }
t||d |d } W n
t y Y n
w | |
| f |d7 }qt |d } t|dd }
|| |
f|_ |! r |j "d|_ |r1|jt#vr1|d |j |_ |S ) zAConstruct a TarInfo object from a 512 byte bytes object.
r z empty headerztruncated headerzend of file header z bad checksumr l t | i i i) iI iQ iY i r i r rM i i i )$r2 rt r ru countr3 rv rN rX rK r? r r r) r* r' r( r$ r% r r+ r, r& r' AREGTYPEr r7 GNUTYPE_SPARSErH r0 r boolr) r rstrip GNU_TYPES)rW rW r6 r7 r$ objrB r structsrM r numbytes
isextendedorigsizer8 r8 r9 frombuf s\
zTarInfo.frombufc C s8 |j t}| ||j|j}|j t |_||S )zOReturn the next TarInfo object from TarFile object
tarfile.
) r r] r rx r6 r7 r r _proc_member)rW r rW rs r8 r8 r9 fromtarfile s
zTarInfo.fromtarfilec C sP | j ttfv r | |S | j tkr| |S | j tttfv r#| |S |
|S )zYChoose the right processing method depending on
the type and call it.
) r% rK rJ
_proc_gnulongro _proc_sparserT rV SOLARIS_XHDTYPE _proc_pax
_proc_builtin)r r r8 r8 r9 ry 0 s
zTarInfo._proc_memberc C sh |j | _| j}| s| jtvr|| | j7 }||_| |j
|j |j |
r2| jd| _| S )zfProcess a builtin type or an unknown type which
will be treated as a regular file.
r )r r r r r% SUPPORTED_TYPES_blockr' r _apply_pax_infor( r6 r7 r r rq )r r r r8 r8 r9 r = s zTarInfo._proc_builtinc
C s |j | | j}z| |}W n ty$ } ztt|dd}~ww | j|_| j t
kr8t ||j |j
|_n| j tkrFt ||j |j
|_| rQ|jd|_|S )zSProcess the blocks that hold a GNU longname
or longlink member.
Nr )r r] r r' rz r rw rR r r% rK r? r6 r7 r rJ r r removesuffix)r r rW nextr r8 r8 r9 r{ S s
zTarInfo._proc_gnulongc
C s | j \}}}| ` |rS|jt}d}tdD ]4}zt|||d }t||d |d } W n
ty: Y nw |rF| rF||| f |d7 }qt|d }|s
|| _ |j
| _ | j | | j
|_|| _
| S )z8Process a GNU sparse header plus extra headers.
r rM rl i )r) r r] r rH rN r0 r rp r r r r r' r )
r r rt rv rw rW r rM r ru r8 r8 r9 r| n s,
zTarInfo._proc_sparsec
C s |j | | j}| jtkr|j}n|j }d}d}g }t||kr|| dkrt
|| }s6t dz t |
d}W n tyJ t dw |dk rSt d|| t|kr_t d|d| d } ||dd | }
|
d\} } }
| r| dks|| dkrt d||| |
f | dkr|du r|
d kr|j}nd
}||7 }t||kr|| dks*|du rd
}|D ]*\}} }
| | d
d
|j}|tv r| |
||j|j}n | |
d
d
|j}|||< qz| |}W n ty } ztt|dd}~ww d |v r| || n#d |v r | || n| d
dkr3| ddkr3| ||| | jt t fv rf|!||j|j | j"|_"d|v rf|j#}|$ s[|jt%vrc|||j7 }||_"|S )zVProcess an extended or global header as described in
POSIX.1-2008.
r NrG r# ra r s
hdrcharsets BINARYr/ GNU.sparse.mapGNU.sparse.sizezGNU.sparse.major1zGNU.sparse.minorrF r' )&r r] r r' r% rV r( r4 r2 _header_length_prefix_rematchrK rI groupr0 r rg partitionr r6 _decode_pax_fieldr7 PAX_NAME_FIELDSrz r rw rR _proc_gnusparse_01_proc_gnusparse_00r[ _proc_gnusparse_10rT r} r r r r r )r r rW r( r r6 raw_headersr r5 Zheader_value_end_offsetZkeyword_and_valueZ raw_keywordZequalsZ raw_valuerc r? r r r r8 r8 r9 r~ s
)
zTarInfo._proc_paxc C s g }g }|D ];\}}}|dkr&z | t| W q ty% tdw |dkrAz | t| W q ty@ tdw qtt|||_dS )z?Process a GNU tar extended sparse header, version 0.0.
s GNU.sparse.offsetrG s GNU.sparse.numbytesN)r rI r= r0 rK listzipr )r r r Zoffsetsru _rc r? r8 r8 r9 r s" zTarInfo._proc_gnusparse_00c C s@ dd |d dD }tt|ddd |ddd |_dS )z?Process a GNU tar extended sparse header, version 0.1.
c S s g | ]}t |qS r8 )rI ).0xr8 r8 r9
s z.TarInfo._proc_gnusparse_01..r ,Nr$ r# )rY r r r )r r r( r r8 r8 r9 r s (zTarInfo._proc_gnusparse_01c C s d}g }|j t}|dd\}}t|}t||d k rAd|vr*||j t7 }|dd\}}|t| t||d k s |j |_t t
|ddd |ddd |_ dS )z?Process a GNU tar extended sparse header, version 1.0.
Nrb r# r$ ) r r] r rY rI r2 r r r r r r )r r r( r Zfieldsr rW Znumberr8 r8 r9 r s (zTarInfo._proc_gnusparse_10c C s | D ]T\}}|dkrt| d| q|dkr t| dt| q|dkr-t| dt| q|tv rX|tv rIzt| |}W n tyH d}Y nw |dkrR|d}t| || q| | _dS ) zoReplace fields with supplemental information from a previous
pax extended or global header.
zGNU.sparse.namer% r r' zGNU.sparse.realsizer r N) r; setattrrI
PAX_FIELDSPAX_NUMBER_FIELDSr0 rq r4 r( )r r( r6 r7 rc r? r8 r8 r9 r - s&
zTarInfo._apply_pax_infoc C s. z| |dW S ty | || Y S w )z1Decode a single field from a pax record.
rE )r= UnicodeDecodeError)r r? r6 Zfallback_encodingZfallback_errorsr8 r8 r9 r D s
zTarInfo._decode_pax_fieldc C s2 |dk rt dt|t\}}|r|d7 }|t S )z_Round up a byte count by BLOCKSIZE and return it,
e.g. _block(834) => 1024.
r zinvalid offsetr# )rK r\ r )r rm rb rc r8 r8 r9 r L s zTarInfo._blockc C s
| j tv S z4Return True if the Tarinfo object is a regular file.)r%
REGULAR_TYPESr r8 r8 r9 r X r/ z
TarInfo.isregc C s | S r )r r r8 r8 r9 isfile\ s zTarInfo.isfilec C
| j tkS )z!Return True if it is a directory.)r% r7 r r8 r8 r9 r ` r/ z
TarInfo.isdirc C r )z%Return True if it is a symbolic link.)r% SYMTYPEr r8 r8 r9 r d r/ z
TarInfo.issymc C r )z!Return True if it is a hard link.)r% LNKTYPEr r8 r8 r9 r h r/ z
TarInfo.islnkc C r )z(Return True if it is a character device.)r% r\ r r8 r8 r9 ischrl r/ z
TarInfo.ischrc C r )z$Return True if it is a block device.)r% r] r r8 r8 r9 isblkp r/ z
TarInfo.isblkc C r )z Return True if it is a FIFO.)r% FIFOTYPEr r8 r8 r9 isfifot r/ zTarInfo.isfifoc C s
| j d uS r )r r r8 r8 r9 issparsex r zTarInfo.issparsec C s | j tttfv S )zCReturn True if it is one of character device, block device or FIFO.)r% r\ r] r r r8 r8 r9 isdev{ s z
TarInfo.isdevr8 )r )4ro rp rq rr dict __slots__r propertyr% setterr& r2 r3 r r9 r r r@ r< r= r> classmethodrX rF staticmethodrG r_ rI rS rx rz ry r r{ r| r~ r r r r r r r r r r r r r r r r r8 r8 r8 r9 r ` s
:
)
2
>
y r c @ s e Zd ZdZdZdZdZdZeZ e
Z dZ e
ZeZdZ dkdd Zedddefd
d Zedld d
ZedmddZedmddZednddZdddddZdd Zd d Z d d Z d d! Z dod"d#Z dpdd%d&d'Z dqdd(d)d*Z!drd+d,Z"d-d. Z#dsddd0d1d2Z$d3d4 Z%dtddd0d6d7Z&d8d9 Z' drd:d;Z(dd? Z*d@dA Z+ $ dudddBdCdDZ,dEdF Z-dGdH Z.dIdJ Z/dKdL Z0dMdN Z1dOdP Z2dQdR Z3dSdT Z4dUdV Z5dWdX Z6dYdZ Z7dvd[d\Z8d]d^ Z9drd_d`Z:dadb Z;dcdd Zdidj Z?dS )wr z=The TarFile Class provides an interface to tar archives.
r Fr# Nr{ r: c
C s ddddd}||vrt d|| _|| | _|s4| jdkr*tj|s*d| _d| _t|| j}d | _n |d
u rHt|d rHt |j
t t frH|j
}t|d rQ|j| _d
| _|r\tj
|nd
| _
|| _|d
uri|| _|d
urp|| _|d
urw|| _|d
ur~|| _|d
ur|| _| | _|
d
ur| jtkr|
| _ni | _| d
ur| | _| d
ur| | _|
| _d | _g | _d | _ | j | _ i | _ z|| jdkrd
| _ | ! | _ | jdkr
| j"| j z| j#| }| j$| W n# t%y | j"| j Y n t&y } zt't |d
d
}~ww q| jdv r2d
| _ | jr5| j(| j) }| j*| | j t+|7 _ W d
S W d
S W d
S | jsD| j, d
| _ )a Open an (uncompressed) tar archive `name'. `mode' is either 'r' to
read from an existing archive, 'a' to append data to an existing
file or 'w' to create a new file overwriting an existing one. `mode'
defaults to 'r'.
If `fileobj' is given, it is used for reading or writing data. If it
can be determined, `mode' is overridden by `fileobj's mode.
`fileobj' is not closed, when TarFile is closed.
rbzr+bwbZxbr{ ar| r !mode must be 'r', 'a', 'w' or 'x'r r| FNr r Tr{ r r| r )-r0 r _moder~ r% exists bltn_openr r rO r rR rO abspathr rS r dereference ignore_zerosr6 r7 r r( debug
errorlevel copybufsizer members_loadedr r inodes firstmemberr r rz r rv r r rX r4 r^ r2 r )r r r r rS r r r r6 r7 r( r r r Zmodesr rW r8 r8 r9 r s
zTarFile.__init__c s |s|st d|dv ro fdd}g }t j|dD ]G}t j| } |dur-| }
z
| |d|fi |W S ttfyb } z|d| d | |durX||
W Y d} ~ qd} ~ ww d
|} td | d |v r|
d d
\}
}|
p~d}
|pd}| jv rt j| } ntd| | ||
|fi |S d|v r|
dd
\}
}|
pd}
|pd}|
dvrt dt ||
|||}z ||
|fi |}W n | d|_
|S |dv r j|||fi |S t d)a Open a tar archive for reading, writing or appending. Return
an appropriate TarFile class.
mode:
'r' or 'r:*' open for reading with transparent compression
'r:' open for reading exclusively uncompressed
'r:gz' open for reading with gzip compression
'r:bz2' open for reading with bzip2 compression
'r:xz' open for reading with lzma compression
'a' or 'a:' open for appending, creating the file if necessary
'w' or 'w:' open for writing without compression
'w:gz' open for writing with gzip compression
'w:bz2' open for writing with bzip2 compression
'w:xz' open for writing with lzma compression
'x' or 'x:' create a tarfile exclusively without compression, raise
an exception if the file is already created
'x:gz' create a gzip compressed tarfile, raise an exception
if the file is already created
'x:bz2' create a bzip2 compressed tarfile, raise an exception
if the file is already created
'x:xz' create an lzma compressed tarfile, raise an exception
if the file is already created
'r|*' open a stream of tar blocks with transparent compression
'r|' open an uncompressed stream of tar blocks for reading
'r|gz' open a gzip compressed stream of tar blocks
'r|bz2' open a bzip2 compressed stream of tar blocks
'r|xz' open an lzma compressed stream of tar blocks
'w|' open an uncompressed stream for writing
'w|gz' open a gzip compressed stream for writing
'w|bz2' open a bzip2 compressed stream for writing
'w|xz' open an lzma compressed stream for writing
znothing to open)r{ r:*c s j | dkS )Ntaropen) OPEN_METH)r rW r8 r9 not_compressed5 r z$TarFile.open..not_compressed)keyNr{ z - method z:
z'file could not be opened successfully:
:r# r r |rz zmode must be 'r' or 'w'Fr zundiscernible mode)r0 sortedr rh r r r r r r rY r r r r )rW r r r ra kwargsr Z
error_msgsr funcZ saved_posr Zerror_msgs_summaryfilemodestreamr r8 r r9 r sZ %
z TarFile.openc K s$ |dvrt d| |||fi |S )zCOpen uncompressed tar archive name for reading or writing.
r r )r0 )rW r r r r r8 r8 r9 r i s zTarFile.taropenr c
K s |dvrt dzddlm} W n ty tddw z |||d ||}W n tyB } z|dur=|dkr=td | d}~ww z
| j|||fi |}W n! tyj } z| |dkretd | d}~w | d
|_ |S ) zkOpen gzip compressed tar archive name for reading or writing.
Appending is not allowed.
r{ r| r mode must be 'r', 'w' or 'x'r )GzipFilez gzip module is not availableNrd r{ r F)
r0 Zgzipr r r r r r r r ) rW r r r
compresslevelr r r r r8 r8 r9 gzopenq s8
zTarFile.gzopenc
K s |dvrt dzddlm} W n ty tddw ||p!|||d}z
| j|||fi |}W n# ttfyO } z| |dkrJt d | d}~w | d
|_
|S ) zlOpen bzip2 compressed tar archive name for reading or writing.
Appending is not allowed.
r r r )BZ2Filer N)r r{ znot a bzip2 fileF) r0 r r r r r r EOFErrorr r r ) rW r r r r r r r r r8 r8 r9 bz2open s*
zTarFile.bz2openc
K s |dvrt dz
ddlm}m} W n ty tddw ||p#|||d}z
| j|||fi |}W n# |tfyQ } z| |dkrLt d | d} ~ w | d
|_
|S ) zkOpen lzma compressed tar archive name for reading or writing.
Appending is not allowed.
r r r )LZMAFiler r N)presetr{ znot an lzma fileF) r0 r r r r r r r r r r )
rW r r r r r r r r r r8 r8 r9 xzopen s*
zTarFile.xzopenr r r r )r r r r c C s | j rdS d| _ z;| jdv r7| jttd | jtd 7 _t| jt\}}|dkr7| jtt| W | j sB| j
dS dS | j sM| j
w w )zlClose the TarFile. In write-mode, two finishing zero blocks are
appended to the archive.
NTr r$ r ) r r r r^ r3 r r r\
RECORDSIZEr r )r rb rc r8 r8 r9 r s
z
TarFile.closec C s( | |d}|du rtd| |S )a Return a TarInfo object for member `name'. If `name' can not be
found in the archive, KeyError is raised. If a member occurs more
than once in the archive, its last occurrence is assumed to be the
most up-to-date version.
r Nzfilename %r not found)
_getmemberrq KeyError)r r r r8 r8 r9 getmember s zTarFile.getmemberc C s | | js | | jS )zReturn the members of the archive as a list of TarInfo objects. The
list has the same order as the members in the archive.
)_checkr _loadr r r8 r8 r9
getmembers s zTarFile.getmembersc C s dd | D S )zReturn the members of the archive as a list of their names. It has
the same order as the list returned by getmembers().
c S s g | ]}|j qS r8 r- )r r r8 r8 r9 r s z$TarFile.getnames..)r r r8 r8 r9 getnames s zTarFile.getnamesc C sJ | d |dur |j}|du r|}tj|\}}|tjd}|d}| }| |_ |du r@| j
s:t |}n
t |}nt
| }d}|j}t |r|j|jf} | j
ss|jdkrs| | jv rs|| j| krst}
| j| }n;t}
| d r~|| j| < n/t |rt}
n't |rt}
n t |rt }
t |}nt |rt }
n
t |rt!}
ndS ||_||_"|j#|_$|j%|_&|
tkr|j'|_(nd|_(|j)|_*|
|_+||_,t-rz t-.|j$d |_/W n t0y Y nw t1rz t12|j&d |_3W n
t0y Y nw |
t t!fv r#t4tdr#t4tdr#t5|j6|_7t8|j6|_9|S ) a Create a TarInfo object from the result of os.stat or equivalent
on an existing file. The file is either named by `name', or
specified as a file object `fileobj' with a file descriptor. If
given, `arcname' specifies an alternative name for the file in the
archive, otherwise, the name is taken from the 'name' attribute of
'fileobj', or the 'name' argument. The name should be a text
string.
awxNr r r# r majorminor):r r r~ r%
splitdriver r r r r r lstatstatfstatfilenost_modeS_ISREGst_inost_devst_nlinkr r r+ S_ISDIRr7 S_ISFIFOr S_ISLNKr readlinkS_ISCHRr\ S_ISBLKr] r st_uidr) st_gidr* st_sizer' st_mtimer( r% r pwdgetpwuidr+ r grpZgetgrgidr, r r st_rdevr& r r' ) r r arcnamer Zdrvr Zstatresr Zstmdinoder% r8 r8 r9
gettarinfo s
zTarFile.gettarinfoT)r c C s" | |du r
| }|D ]}|rf|jdu rtd ntt|j td|jp)|j|jp.|jf | s:|
rGtdd|j |j f ntd|j
|jdu rXtd ntdt|jdd t|j| rod
nd |r| rtd |j | rtd
|j t q dS )a Print a table of contents to sys.stdout. If `verbose' is False, only
the names of the members are printed. If it is True, an `ls -l'-like
output is produced. `members' is optional and must be a subset of the
list returned by getmembers().
Nz
??????????z%s/%sz%10sz%d,%dz%10dz????-??-?? ??:??:??z%d-%02d-%02d %02d:%02d:%02dr r r z-> zlink to )r r rl r r r+ r) r, r* r r r& r' r' r( r localtimer r r r r rk )r verboser r r8 r8 r9 r h s:
z TarFile.listfilterc C sP | d |du r |}| jdur#tj|| jkr#| dd| dS | d| | ||}|du r=| dd| dS |durS||}|du rS| dd| dS | rut|d}| || W d dS 1 snw Y dS |
r| | |rt t |D ]}| j
tj||tj||||d qdS dS | | dS )
a! Add the file `name' to the archive. `name' may be any type of file
(directory, fifo, symbolic link, etc.). If given, `arcname'
specifies an alternative name for the file in the archive.
Directories are added recursively by default. This can be avoided by
setting `recursive' to False. `filter' is a function
that expects a TarInfo object argument and returns the changed
TarInfo object, if it returns None the TarInfo object will be
excluded from the archive.
r Nr$ ztarfile: Skipped %rr# z tarfile: Unsupported type %rtarfile: Excluded %rr r )r r r~ r% r _dbgr r r addfiler r listdiraddr )r r r recursiver r fr8 r8 r9 r s<
"
z TarFile.addc C s | d t|}|| j| j| j}| j| | jt |7 _| j
}|durWt || j|j |d t
|j t\}}|dkrN| jtt| |d7 }| j|t 7 _| j| dS )a Add the TarInfo object `tarinfo' to the archive. If `fileobj' is
given, it should be a binary file, and tarinfo.size bytes are read
from it and added to the archive. You can create TarInfo objects
directly, or by using gettarinfo().
r N)ra r r# )r r4 r@ rS r6 r7 r r^ r r2 r r[ r' r\ r r3 r r )r r r rW ra rb rc r8 r8 r9 r s
zTarFile.addfilec C sh |d u r| j }|d u r
tS t|trtd|S t|r |S zt| W S ty3 td|dd w )NzrString names are not supported for TarFile.extraction_filter. Use a function such as tarfile.data_filter directly.zfilter z
not found) extraction_filterr rO rR TypeErrorcallable_NAMED_FILTERSr r0 )r r r8 r8 r9 _get_filter_function s
z TarFile._get_filter_function.)
numeric_ownerr c C s g }| |}|du r
| }|D ]&}| |||\}} |du r q| r(|| | j||| ||d q|jdd dd |D ]} zsz|| |}W n tyf }
z| | t|
W Y d}
~
W qAd}
~
ww |du rs| | d W qAt j
||j } zt
| } W n ty | |d Y W qAw t| js| |d W qA| j|| |d
| || | || W qA ty }
z | |
W Y d}
~
qAd}
~
ww dS ) a Extract all members from the archive to the current working
directory and set owner, modification time and permissions on
directories afterwards. `path' specifies a different directory
to extract to. `members' is optional and must be a subset of the
list returned by getmembers(). If `numeric_owner` is True, only
the numbers for user/group names are used and not the names.
The `filter` function will be called on each member just
before extraction.
It can return a changed TarInfo or None to skip the member.
String names of common filters are accepted.
N) set_attrsr filter_functionc S r r r- )r r8 r8 r9 s z$TarFile.extractall..T)r reversezexcluded by filterZmissingznot a directory)r )r _get_extract_tarinfor r _extract_onesort_FILTER_ERRORS_log_no_directory_fixupreprr~ r% r r r FileNotFoundErrorr r r chownutimechmodr
_handle_nonfatal_error)r r% r r r Z directoriesr r r
unfilteredexcdirpathr r r8 r8 r9
extractall sb
zTarFile.extractallc C s | dd|j|f d S )Nr$ z(tarfile: Not fixing up directory %r (%s))r r )r r reasonr8 r8 r9 r 1 s
z TarFile._log_no_directory_fixupr c C s< | |}| |||\}}|dur | |||| dS dS )a Extract a member from the archive to the current working directory,
using its full name. Its file information is extracted as accurately
as possible. `member' may be a filename or a TarInfo object. You can
specify a different directory using `path'. File attributes (owner,
mtime, mode) are set unless `set_attrs' is False. If `numeric_owner`
is True, only the numbers for user/group names are used and not
the names.
The `filter` function will be called before extraction.
It can return a changed TarInfo or None to skip the member.
String names of common filters are accepted.
N)r r r ) r r r% r r r r r r$ r8 r8 r9 extract5 s
zTarFile.extractc
C s t |tr | |}n|}d}z|||}W n/ ttfy/ } z | | W Y d}~nd}~w tyE } z | | W Y d}~nd}~ww |du rU| dd|j dS |
rgt |}t j
||j|_||fS )zGet (filtered, unfiltered) TarInfos from *member*
*member* might be a string.
Return (None, None) if not found.
Nr$ r )NN)rO rR r r r _handle_fatal_errorr
r# r r r r4 r~ r% r r r* )r r r r% r$ filteredr r8 r8 r9 r I s(
z TarFile._get_extract_tarinfoc
C s | d z| j|tj||j||||d W dS ty1 } z | | W Y d}~dS d}~w tyH } z | | W Y d}~dS d}~ww )zExtract from filtered tarinfo to disk.
filter_function is only used when extracting a *different*
member (e.g. as fallback to creating a symlink)
r{ )r r r extraction_rootN)
r _extract_memberr~ r% r r r r* r
r# )r r r% r r r r r8 r8 r9 r g s
zTarFile._extract_onec C s | j dkr | dd| dS )z=Handle non-fatal error (ExtractError) according to errorlevelr# tarfile: %sN)r r r r r8 r8 r9 r# { s
z TarFile._handle_nonfatal_errorc C sp | j dkr t|tr)|jdu r| dd|j dS | dd|j|jf dS | ddt|j|f dS )z1Handle "fatal" error according to self.errorlevelr Nr# r. ztarfile: %s %rztarfile: %s %s)r rO r filenamer strerrorr% ro r/ r8 r8 r9 r* s
zTarFile._handle_fatal_errorc C sz | d t|tr| |}n|}| s|jtvr!| | |S | s)| r;t| j
t r3t d|
| |S dS )a\ Extract a member from the archive as a file object. `member' may be
a filename or a TarInfo object. If `member' is a regular file or
a link, an io.BufferedReader object is returned. For all other
existing members, None is returned. If `member' does not appear
in the archive, KeyError is raised.
r{ z'cannot extract (sym)link as file objectN)r rO rR r r r% r
fileobjectr r r r r extractfile_find_link_target)r r r r8 r8 r9 r3 s
zTarFile.extractfiler r, c C s\ | d}|dtj}tj|}|r tj|s t| | s'| r4|
dd|j |j f n|
d|j |
rF| || nI| rQ| || n>| r\| || n3| sd| rk| || n$| ss| r}| j||||d n|jtvr| || n| || |r| ||| | s| || | || dS dS dS )zExtract the filtered TarInfo object tarinfo to a physical
file called targetpath.
filter_function is only used when extracting a *different*
member (e.g. as fallback to creating a symlink)
r r# z%s -> %sr5 N) rq r r~ r r% r r makedirsr r r r r r makefiler makedirr makefifor r makedevmakelink_with_filterr% r makeunknownr r" r! )r r
targetpathr r r r, Z upperdirsr8 r8 r9 r- s@
zTarFile._extract_memberc C sB z|j du rt| W dS t|d W dS ty Y dS w )z,Make a directory called targetpath.
Ni )r r~ mkdirFileExistsErrorr r r= r8 r8 r9 r8 s
zTarFile.makedirc C s | j }||j | j}t|d?}|jdur7|jD ]\}}|| t|||t| q||j | nt|||jt| W d dS W d dS 1 sSw Y dS )z'Make a file called targetpath.
r N)
r r r r r r r[ r r' truncate)r r r= sourcera targetr r' r8 r8 r9 r7 s
"zTarFile.makefilec C s" | || | dd|j dS )zYMake a file from a TarInfo object with an unknown type
at targetpath.
r# z9tarfile: Unknown file type %r, extracted as regular file.N)r7 r r% r@ r8 r8 r9 r<
s
zTarFile.makeunknownc C s t tdr t| dS td)z'Make a fifo called targetpath.
mkfifoz fifo not supported by systemN)r r~ rD r
r@ r8 r8 r9 r9
s
zTarFile.makefifoc C sj t tdr
t tdstd|j}|du rd}| r!|tjO }n|tjO }t||t |j
|j dS )z
z
TarFile.chownc
C sF |j du rdS z
t||j W dS ty" } ztd|d}~ww )zASet file permissions of targetpath according to tarinfo.
Nzcould not change mode)r r~ r" r r
)r r r= r r8 r8 r9 r" |
s
z
TarFile.chmodc
C sZ |j }|du r dS ttdsdS z t|||f W dS ty, } ztd|d}~ww )zBSet modification time of targetpath according to tarinfo.
Nr! z"could not change modification time)r( r r~ r! r r
)r r r= r( r r8 r8 r9 r!
s
z
TarFile.utimec C s: | d | jdur| j}d| _|S | j| j kr-| j| jd | jds-tdd} z| j | }W n t
ye } z!| j r[| dd| j|f | jt
7 _W Y d}~q/W Y d}~nd}~w ty } z-| j r| dd| j|f | jt
7 _W Y d}~q/| jdkrtt|dW Y d}~nqd}~w ty | jdkrtd dY n[ ty } z| jdkrtt|dW Y d}~nBd}~w ty } ztt|dd}~w ty } z zddl}t||jrtd
| d| ty |w d}~ww |dur| j| |S d| _|S ) zReturn the next member of the archive as a TarInfo object, when
TarFile is opened for reading. Return None if there is no more
available.
ZraNr# rY Tr$ z0x%X: %sr z
empty filez zlib error: )r r r r r r r] r r rz rv r r r rK rR rt ru rw Exceptionr rO r r r r r )r mr r r r8 r8 r9 r
st
z TarFile.nextc C s | }d}|dur#z||}W n ty d}Y nw |d| }|r+tj|}t|D ]"}|r<|j|jkr;d}q/|rFtj|j}n|j}||krQ| S q/|rXt|dS )z}Find an archive member by name from bottom to top.
If tarinfo is given, it is used as the starting point.
FNT) r indexr0 r~ r% r reversedr r ) r r r normalizer ZskippingrV r member_namer8 r8 r9 r
s2 zTarFile._getmemberc C s | }|du r
nqd| _dS )zWRead through the entire archive file and look for readable
members.
TN)r r r r8 r8 r9 r
s
z
TarFile._loadc C s> | j r td| jj |dur| j|vr td| j dS dS )znCheck if TarFile is still open, and if the operation's mode
corresponds to TarFile's mode.
z %s is closedNzbad operation for mode %r)r r r ro r )r r r8 r8 r9 r s
zTarFile._checkc C s` | rdtdtj|j|jf}d}n|j}|}| j||dd}|du r.t d| |S )zZFind the target member of a symlink or hardlink member in the
archive.
r NT)r rX zlinkname %r not found)
r r r r~ r% r r r r r )r r r limitr r8 r8 r9 r4 s zTarFile._find_link_targetc c s | j r | jE dH dS d}| jdur | }|d7 }|V |t| jk r,| j| }n| j s;| }|s:d| _ dS ndS |d7 }|V q )z$Provide an iterator object.
Nr r# T)r r r r r2 )r rV r r8 r8 r9 __iter__! s,
zTarFile.__iter__c C s || j krt|tjd dS dS )z.Write debugging output to sys.stderr.
fileN)r rk ri stderr)r levelmsgr8 r8 r9 r @ s
z TarFile._dbgc C s | | S r )r r r8 r8 r9 __enter__F s zTarFile.__enter__c C s. |d u r
| d S | js| j d| _d S r )r r r r )r r% r? tracebackr8 r8 r9 __exit__J s
zTarFile.__exit__)
Nr{ NNNNNNr: NNNN)r{ N)r{ Nr )r{ NN)NNNTr r )r N)r T)TFr )@ro rp rq rr r r r r r rS r r6 r7 r r r r2 r r r r r r r r r r r r r r r r r r r r' r r) r r r# r* r3 r- r8 r7 r< r9 r: rH r; r r" r! r r r r r4 r[ r ra rc r8 r8 r8 r9 r s
o]
c&
3 E
82!
?(
r c C sB zt | dr t| d}nt| }| W dS ty Y dS w )zReturn True if name points to a tar archive that we
are able to handle, else return False.
'name' should be a string, file, or file-like object.
r] )r TF)r r r r )r r r8 r8 r9 r X s
r c C sh dd l } d}| j|d}|jdddddd |jd
d td d
|jdd}|jddddd |jdddddd |jdd dd d d |jd d dd!d | }|jr]|jd u r]|d"d# |j d ur|j }t
|rt |d$}| t
| tjd% W d n1 sw Y |jrt
d&| d S d S |d"d'| d S |jd ur|j}t
|rt |d(}|j|jd) W d d S 1 sw Y d S |d"d'| d S |jd urRt|jd"kr|jd }tj}nt|jd*kr|j\}}n|d"| t
|rGt |d(}|j||jd+ W d n 1 s%w Y |jrE|d,kr9d-|} nd.||} t
| d S d S |d"d'| d S |jd ur|jd}
tj |
\} } d/d/d0d0d1d1d1d1d2}
| |
v r|d3|
| nd4}|j}t |
|}|D ]}| | qW d n 1 sw Y |jrt
d5|
d S d S d S )6Nr z3A simple command-line interface for tarfile module.) descriptionz-vz --verbose
store_trueFzVerbose output)actiondefaulthelpz--filterz zFilter for extraction)metavarchoicesri T)Zrequiredz-lz--list zShow listing of a tarfile)rj ri z-ez --extract+)rl z z Extract tarfile into target dir)nargsrj ri z-cz--create)zzzCreate tarfile from sourcesz-tz--testzTest if a tarfile is validr# z&--filter is only valid for extraction
r{ r\ z{!r} is a tar archive.z{!r} is not a tar archive.
r )r r$ )r% r r z{!r} file is extracted.z+{!r} file is extracted into {!r} directory.r r r )r z.tgzz.xzz.txzz.bz2z.tbzz.tbz2z.tb2zw:r| z{!r} file created.) argparseArgumentParser add_argumentr Z add_mutually_exclusive_group
parse_argsr r) exittestr r r rk ri r^ r rS r r r2 r~ curdirZ format_helpr' Zcreatepopr% splitextr )ro re parserr argsr_ r Ztfru r` Ztar_namer ZextZ compressionsZtar_modeZ tar_files file_namer8 r8 r9 maink s
"
r{ __main__rd )orr version
__author__ __credits__builtinsr r ri r~ r rZ r r rV r4 rewarningsr r r AttributeErrorNotImplementedErrorrM r NameError__all__r3 r r rH rC rE rD rZ r+ rn r r r\ r] r7 r ZCONTTYPErK rJ ro rT rV r} r
r r r r r rr r r rP rI r r r getfilesystemencodingr: r? rN rT rX r[ rl rT r r
r r r r rt ru rv rK rw ry r objectr r BufferedReaderr r r r r r r r r r r r! r# r r3 compiler r r r r{ ro r8 r8 r8 r9 s(
s h
D
& a
_