o

�
b��@sdZd
dl
Z
d
dlZd
dlZd
dlZd
dlmZmZmZ
d
dlm	Z	m
Z
mZmZm
Z
mZmZmZ
d
dlmZmZmZmZmZmZmZmZmZmZmZmZmZmZ
d
dl m!Z!m"Z"m#Z#
d
dl$m%Z%m&Z&m'Z'
d
dl(m)Z)m*Z*
d
d	l+m,Z,
d
d
l-m.Z.
d
dl/m0Z0m1Z1m2Z2m3Z3m4Z4
ej5ej6Bej7Be4BZ8dd
�Z9e:ej;de9�Z<ej=Z>e
j?Z@Gdd�de&�ZAGdd�deB�ZCGdd�deB�ZDGdd�deE�ZFdd�ZGGdd�d�ZHGdd�de.�ZIGdd�de.�ZJd+d e"eKeLfd!eLd"eKfd#d$�ZMd,d%d&�
ZNd,d'd(�
ZOe*e'eA�
Gd)d*�d*eH��
�
ZPePeP_QdS)-z1
Object-oriented filesystem path representation.
�N)�listdir�stat�utime)�abspath�basename�dirname�exists�isabs�join�normpath�splitext)�S_IMODE�S_IRGRP�S_IROTH�S_IRUSR�S_ISBLK�S_ISDIR�S_ISREG�S_ISSOCK�S_IWGRP�S_IWOTH�S_IWUSR�S_IXGRP�S_IXOTH�S_IXUSR)�IO�Union�cast)�	Attribute�	Interface�implementer)�cmp�
comparable)
�platform)
�FancyEqMixin)�ERROR_DIRECTORY�ERROR_FILE_NOT_FOUND�ERROR_INVALID_NAME�ERROR_PATH_NOT_FOUND�O_BINARYc


C�d
S)z�
    Always return C{False} if the operating system does not support symlinks.

    @param path: A path string.
    @type path: L{str}

    @return: C{False}
    @rtype: L{bool}
    F��
�pathr+r+�9/usr/lib/python3/dist-packages/twisted/python/filepath.py�_stub_islink@s
r/�islinkc@s�eZ
dZd
Zed�
Zdd�Zd!dd�
Zdd	�Zd
d�Z	dd
�Z
dd�Zdd�Zdd�Z
dd�Zdd�Zdd�Zdd�Zdd�Zdd�Zd S)"�	IFilePatha�
    File path object.

    A file path represents a location for a file-like-object and can be
    organized into a hierarchy; a file path can can children which are
    themselves file paths.

    A file path has a name which unique identifies it in the context of its
    parent (if it has one); a file path can not have two children with the same
    name.  This name is referred to as the file path's "base name".

    A series of such names can be used to locate nested children of a file
    path; such a series is referred to as the child's "path", relative to the
    parent.  In this case, each name in the path is referred to as a "path
    segment"; the child's base name is the segment in the path.

    When representing a file path as a string, a "path separator" is used to
    delimit the path segments within the string.  For a file system path, that
    would be C{os.sep}.

    Note that the values of child names may be restricted.  For example, a file
    system path will not allow the use of the path separator in a name, and
    certain names (e.g. C{"."} and C{".."}) may be reserved or have special
    meanings.

    @since: 12.1
    z3The path separator to use in string representationsc


Cr*)a�

        Obtain a direct child of this file path.  The child may or may not
        exist.

        @param name: the name of a child of this path. C{name} must be a direct
            child of this path and may not contain a path separator.
        @return: the child of this path with the given C{name}.
        @raise InsecurePath: if C{name} describes a file path that is not a
            direct child of this file path.
        Nr+�
�namer+r+r.�childq�zIFilePath.child�
rc


Cr*)z�
        Opens this file path with the given mode.

        @return: a file-like object.
        @raise Exception: if this file path cannot be opened.
        Nr+)
�moder+r+r.�open}r5zIFilePath.openc
Cr*)zT
        Clear any cached information about the state of this path on disk.
        Nr+r+r+r+r.�changed�r5zIFilePath.changedc
Cr*)z�
        Retrieve the size of this file in bytes.

        @return: the size of the file at this file path in bytes.
        @raise Exception: if the size cannot be obtained.
        Nr+r+r+r+r.�getsize�r5zIFilePath.getsizec
Cr*)��
        Retrieve the time of last access from this file.

        @return: a number of seconds from the epoch.
        @rtype: L{float}
        Nr+r+r+r+r.�getModificationTime�r5zIFilePath.getModificationTimec
Cr*)��
        Retrieve the time of the last status change for this file.

        @return: a number of seconds from the epoch.
        @rtype: L{float}
        Nr+r+r+r+r.�getStatusChangeTime�r5zIFilePath.getStatusChangeTimec
Cr*)��
        Retrieve the time that this file was last accessed.

        @return: a number of seconds from the epoch.
        @rtype: L{float}
        Nr+r+r+r+r.�
getAccessTime�r5zIFilePath.getAccessTimec
Cr*)z�
        Check if this file path exists.

        @return: C{True} if the file at this file path exists, C{False}
            otherwise.
        @rtype: L{bool}
        Nr+r+r+r+r.r�r5zIFilePath.existsc
Cr*)z�
        Check if this file path refers to a directory.

        @return: C{True} if the file at this file path is a directory, C{False}
            otherwise.
        Nr+r+r+r+r.�isdir�r5zIFilePath.isdirc
Cr*)z�
        Check if this file path refers to a regular file.

        @return: C{True} if the file at this file path is a regular file,
            C{False} otherwise.
        Nr+r+r+r+r.�isfile�r5zIFilePath.isfilec
Cr*)z�
        List the children of this path object.

        @return: a sequence of the children of the directory at this file path.
        @raise Exception: if the file at this file path is not a directory.
        Nr+r+r+r+r.�children�r5zIFilePath.childrenc
Cr*)z�
        Retrieve the final component of the file path's path (everything
        after the final path separator).

        @return: the base name of this file path.
        @rtype: L{str}
        Nr+r+r+r+r.r�r5zIFilePath.basenamec
Cr*)zV
        A file path for the directory containing the file at this file path.
        Nr+r+r+r+r.�parent�r5zIFilePath.parentc


Cr*)a$

        A file path for the directory containing the file at this file path.

        @param name: the name of a sibling of this path.  C{name} must be a
            direct sibling of this path and may not contain a path separator.

        @return: a sibling file path of this one.
        Nr+r2r+r+r.�sibling�r5zIFilePath.siblingN�
r6)�__name__�
__module__�__qualname__�__doc__r�sepr4r8r9r:r<r>r@rrArBrCrrDrEr+r+r+r.r1Rs"

		r1c
@�eZ
dZd
ZdS)�InsecurePathzP
    Error that is raised when the path provided to L{FilePath} is invalid.
    N�rGrHrIrJr+r+r+r.rM��
rMc
@rL)�	LinkErrorz�
    An error with symlinks - either that there are cyclical symlinks or that
    symlink are not supported on this platform.
    NrNr+r+r+r.rP�rOrPc@seZ
dZd
Zdefdd�ZdS)�UnlistableErrorai

    An exception which is used to distinguish between errors which mean 'this
    is not a directory you can list' and other, more catastrophic errors.

    This error will try to look as much like the original error as possible,
    while still being catchable as an independent type.

    @ivar originalException: the actual original exception instance.
    �originalExceptioncCs|j�
|
j�

|
|_d
S)zq
        Create an UnlistableError exception.

        @param originalException: an instance of OSError.
        N)�__dict__�updaterR)�selfrRr+r+r.�__init__�s

zUnlistableError.__init__N)rGrHrIrJ�OSErrorrVr+r+r+r.rQ�s

rQc
Cstt
d
�
�
dd
�}
t||
�S)a

    Compute a string usable as a new, temporary filename.

    @param path: The path that the new temporary filename should be able to be
        concatenated with.

    @return: A pseudorandom, 16 byte string for use in secure filenames.
    @rtype: the type of C{path}
    �N)�armor�randomBytes�_coerceToFilesystemEncoding)r-�secureishStringr+r+r.�_secureEnoughString
s


r]c@sjeZ
dZd
Zdd�Zdd�Zdd�Zdd	d
�
Zdd�Zd
d�Z	dd�Z
dd�Zdd�Zdd�Z
dd�ZdS)�AbstractFilePatha-

    Abstract implementation of an L{IFilePath}; must be completed by a
    subclass.

    This class primarily exists to provide common implementations of certain
    methods in L{IFilePath}. It is *not* a required parent class for
    L{IFilePath} implementations, just a useful starting point.
    c
Cs4|���}
|
�
�Wd
�
S1sw



Y
d
S)z�
        Retrieve the contents of the file at this path.

        @return: the contents of the file
        @rtype: L{bytes}
        N)r8�read)rU�fpr+r+r.�
getContent
s

$�zAbstractFilePath.getContentc
cs8�|}
|
��}|
|kr|V
|}
|��}|
|ksd
Sd
S)z�
        Retrieve an iterator of all the ancestors of this path.

        @return: an iterator of all the ancestors of this path, from the most
        recent (its immediate parent) to the root of its filesystem.
        N)
rD)rUr-rDr+r+r.�parents(
s�



�zAbstractFilePath.parentsc

stz���}
Wn*t
y0
}
zt|d
d�ttttfvrt|�
�
|jtj	tj
fvr+t|�
�
�d}~w
w�f
dd�|
D�
S)a�
        List the children of this path object.

        @raise OSError: If an error occurs while listing the directory.  If the
        error is 'serious', meaning that the operation failed due to an access
        violation, exhaustion of some kind of resource (file descriptors or
        memory), OSError or a platform-specific variant will be raised.

        @raise UnlistableError: If the inability to list the directory is due
        to this path not existing or not being a directory, the more specific
        OSError subclass L{UnlistableError} is raised instead.

        @return: an iterable of all currently-existing children of this object.
        �winerrorNc
�g|]}
��|
�
�qSr+�
r4)�.0r3�
rUr+r.�
<listcomp>`
�z-AbstractFilePath.children.<locals>.<listcomp>)rrW�getattrr(r&r'r%rQ�errno�ENOENT�ENOTDIR)rU�subnames�oser+rgr.rC7
s 






�

��zAbstractFilePath.childrenNccsz�|V
|��r9|�
�D].}|
d
us|
|�
r5|�|
�
D]}tj�|j�
�tj�|j�
�
r0td�
�
|V
qq|V
qd
Sd
S)a�
        Yield myself, then each of my children, and each of those children's
        children in turn.

        The optional argument C{descend} is a predicate that takes a FilePath,
        and determines whether or not that FilePath is traversed/descended
        into.  It will be called with each path for which C{isdir} returns
        C{True}.  If C{descend} is not specified, all directories will be
        traversed (including symbolic links which refer to directories).

        @param descend: A one-argument callable that will return True for
            FilePaths that should be traversed, False otherwise.

        @return: a generator yielding FilePath-like objects.
        NzCycle in file graph.)rArC�walk�osr-�realpath�
startswithrP)rU�descend�
c�subcr+r+r.rpb
s�




�
��
zAbstractFilePath.walkcCs|���
|
�
S)
a

        Return a L{FilePath} with the same directory as this instance but with
        a basename of C{path}.

        @param path: The basename of the L{FilePath} to return.
        @type path: L{str}

        @return: The sibling path.
        @rtype: L{FilePath}
        )rDr4)rUr-r+r+r.rE�
szAbstractFilePath.siblingcCs|}|
D]}|�|�
}q|S)
aM

        Retrieve a child or child's child of this path.

        @param segments: A sequence of path segments as L{str} instances.

        @return: A L{FilePath} constructed by looking up the C{segments[0]}
            child of this path, the C{segments[1]} child of that path, and so
            on.

        @since: 10.2
        re)rU�segmentsr-r3r+r+r.�
descendant�
s


zAbstractFilePath.descendantcCsp|}|��}g}||
kr'||kr'|�
�g
|d
d
�<|}|��}||
kr'||ks||
kr/|r/|St|
�d|���
�
)a
        Return a list of segments between a child and its ancestor.

        For example, in the case of a path X representing /a/b/c/d and a path Y
        representing /a/b, C{Y.segmentsFrom(X)} will return C{['c',
        'd']}.

        @param ancestor: an instance of the same class as self, ostensibly an
        ancestor of self.

        @raise ValueError: If the C{ancestor} parameter is not actually an
        ancestor, i.e. a path for /x/y/z is passed as an ancestor for /a/b/c/d.

        @return: a list of strs
        r
z not parent of )rDr�
ValueError)rU�ancestor�
f�
prwr+r+r.�segmentsFrom�
s





�

zAbstractFilePath.segmentsFromc

Cst|j
|jf�
S)
zR
        Hash the same as another L{FilePath} with the same path as mine.
        )�hash�	__class__r-rgr+r+r.�__hash__�
szAbstractFilePath.__hash__c

C�t|�
��
S)
z?
        Deprecated.  Use getModificationTime instead.
        )�intr<rgr+r+r.�getmtime�
�zAbstractFilePath.getmtimec

Cr�)
z9
        Deprecated.  Use getAccessTime instead.
        )r�r@rgr+r+r.�getatime�
r�zAbstractFilePath.getatimec

Cr�)
z?
        Deprecated.  Use getStatusChangeTime instead.
        )r�r>rgr+r+r.�getctime�
r�zAbstractFilePath.getctime�
N)rGrHrIrJrarbrCrprErxr}r�r�r�r�r+r+r+r.r^
s
	

+
r^c@�2eZ
dZd
ZdZdd�Zdefdd�Zdd	�Zd
S)�RWXa�

    A class representing read/write/execute permissions for a single user
    category (i.e. user/owner, group, or other/world).  Instantiate with
    three boolean values: readable? writable? executable?.

    @type read: C{bool}
    @ivar read: Whether permission to read is given

    @type write: C{bool}
    @ivar write: Whether permission to write is given

    @type execute: C{bool}
    @ivar execute: Whether permission to execute is given

    @since: 11.1
    �r_�write�executecCs|
|_||_
||_dSr�r�)rU�readable�writable�
executabler+r+r.rV�
s



zRWX.__init__�returnc

Csd
�|j
|j|j�S)Nz"RWX(read={}, write={}, execute={}))�formatr_r�r�rgr+r+r.�__repr__�
s




�zRWX.__repr__c
Cs@gd
�
}
d}|j|j
|jfD]}|sd|
|<|d7}qd�|
�
S)z�
        Returns a short string representing the permission bits.  Looks like
        part of what is printed by command line utilities such as 'ls -l'
        (e.g. 'rwx')

        @return: The shorthand string.
        @rtype: L{str}
        )r6�
w�
xr
�
-�
�)r_r�r�r
)rU�	returnval�
i�valr+r+r.�	shorthand�
s	







z
RWX.shorthandN�	rGrHrIrJ�compareAttributesrV�strr�r�r+r+r+r.r��
s
r�c@r�)�Permissionsae

    A class representing read/write/execute permissions.  Instantiate with any
    portion of the file's mode that includes the permission bits.

    @type user: L{RWX}
    @ivar user: User/Owner permissions

    @type group: L{RWX}
    @ivar group: Group permissions

    @type other: L{RWX}
    @ivar other: Other/World permissions

    @since: 11.1
    )�user�group�othercs:�f
d
d�tt
tgtttgtttgfD�
\|_	|_
|_dS)Nc
3s&�|]}
t�f
dd
�|
D�
�V
qdS)c
3s�|]	}
�|
@dkV
qd
S)r
Nr+)rf�bit�
�statModeIntr+r.�	<genexpr>s�z1Permissions.__init__.<locals>.<genexpr>.<genexpr>N)
r�)rf�bitGroupr�r+r.r�s
��
�z'Permissions.__init__.<locals>.<genexpr>)rrrrrrrrrr�r�r�)rUr�r+r�r.rVs



��zPermissions.__init__r�c

Cs*d
t|j
�
�dt|j�
�dt|j�
�d�S)N�
[z | �
])r�r�r�r�rgr+r+r.r�'s*
zPermissions.__repr__c

Cs d
�dd�|j
|j|jfD�
�
S)z�
        Returns a short string representing the permission bits.  Looks like
        what is printed by command line utilities such as 'ls -l'
        (e.g. 'rwx-wx--x')

        @return: The shorthand string.
        @rtype: L{str}
        r�c
Ssg|]}
|
���qSr+)
r�)rfr�r+r+r.rh3sz)Permissions.shorthand.<locals>.<listcomp>)r
r�r�r�rgr+r+r.r�*s 	zPermissions.shorthandNr�r+r+r+r.r�
s

r�r�r-�encodingr�cCs$t|t
�r|S|
s
t��}
|�|
�
S)
aR

    Return C{path} as a string of L{bytes} suitable for use on this system's
    filesystem.

    @param path: The path to be made suitable.
    @type path: L{bytes} or L{unicode}
    @param encoding: The encoding to use if coercing to L{bytes}. If none is
        given, L{sys.getfilesystemencoding} is used.

    @return: L{bytes}
    )�
isinstance�bytes�sys�getfilesystemencoding�encode�r-r�r+r+r.�_asFilesystemBytes6s





r�cCs*t|�
t
kr|S|
d
urt��}
|�|
�
S)aY

    Return C{path} as a string of L{unicode} suitable for use on this system's
    filesystem.

    @param path: The path to be made suitable.
    @type path: L{bytes} or L{unicode}

    @param encoding: The encoding to use if coercing to L{unicode}. If none
        is given, L{sys.getfilesystemencoding} is used.

    @return: L{unicode}
    N)�typer�r�r��decoder�r+r+r.�_asFilesystemTextJs





r�cCs$t|�
t
krt|
|d
�St|
|d
�S)a

    Return a C{newpath} that is suitable for joining to C{path}.

    @param path: The path that it should be suitable for joining to.
    @param newpath: The new portion of the path to be coerced if needed.
    @param encoding: If coerced, the encoding that will be used.
    �
r�)r�r�r�r�)r-�newpathr�r+r+r.r[_s
r[c@seZ
dZUd
ZdZdZeeefe	d<dydd�
Z
dd�Zed	d
��
Z
dzdd�
Zdzd
d�
Zdzdd�
Zdzdd�
Zdd�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd{d$ed%eefd&d'�Zd|d)d*�
Zd+d,�Zd-d.�Zd/d0�Zd1d2�Z d3d4�Z!d5d6�Z"d7d8�Z#d9d:�Z$d;d<�Z%d=d>�Z&d?d@�Z'dAdB�Z(dCdD�Z)dEdF�Z*dGdH�Z+dIdJ�Z,dKdL�Z-dMdN�Z.dOdP�Z/dQdR�Z0dSdT�Z1d%efdUdV�Z2dWdX�Z3dYdZ�Z4dyd[d\�
Z5d]d^�Z6d_d`�Z7dadb�Z8dcdd�Z9d}dfdg�
Z:dhdi�Z;djdk�Z<d~dmdn�
Z=d%eefdodp�Z>ddrds�
Z?dtZ@d|dudv�
ZAd|dwdx�
ZBdS)��FilePatha�
    I am a path on the filesystem that only permits 'downwards' access.

    Instantiate me with a pathname (for example,
    FilePath('/home/myuser/public_html')) and I will attempt to only provide
    access to files which reside inside that path.  I may be a path to a file,
    a directory, or a file which does not exist.

    The correct way to use me is to instantiate me, and then do ALL filesystem
    access through me.  In other words, do not import the 'os' module; if you
    need to open a file, call my 'open' method.  If you need to list a
    directory, call my 'path' method.

    Even if you pass me a relative path, I will convert that to an absolute
    path internally.

    The type of C{path} when instantiating decides the mode of the L{FilePath}.
    That is, C{FilePath(b"/")} will return a L{bytes} mode L{FilePath}, and
    C{FilePath(u"/")} will return a L{unicode} mode L{FilePath}.
    C{FilePath("/")} will return a L{bytes} mode L{FilePath} on Python 2, and a
    L{unicode} mode L{FilePath} on Python 3.

    Methods that return a new L{FilePath} use the type of the given subpath to
    decide its mode. For example, C{FilePath(b"/").child(u"tmp")} will return a
    L{unicode} mode L{FilePath}.

    @type alwaysCreate: L{bool}
    @ivar alwaysCreate: When opening this file, only succeed if the file does
        not already exist.

    @ivar path: The path from which 'downward' traversal is permitted.
    Nr-FcCst|
�
|_
||_d
S)z�
        Convert a path string to an absolute path if necessary and initialize
        the L{FilePath} with the result.
        N)rr-�alwaysCreate)rUr-r�r+r+r.rV�s


zFilePath.__init__c
Cs|j�
�}
d
|
vr|
d
=|
S)zv
        Support serialization by discarding cached L{os.stat} results and
        returning everything else.
        �	_statinfo)rS�copy)rU�
dr+r+r.�__getstate__�s



zFilePath.__getstate__c

Cst|j
tj�S)
z�
        Return a filesystem separator.

        @return: The native filesystem separator.
        @returntype: The same type as C{self.path}.
        )r[r-rqrKrgr+r+r.rK��zFilePath.sepcC�t|j
|
d
�S)z�
        Return the path of this L{FilePath} as bytes.

        @param encoding: The encoding to use if coercing to L{bytes}. If none is
            given, L{sys.getfilesystemencoding} is used.

        @return: L{bytes}
        r�)r�r-�rUr�r+r+r.�_asBytesPath��	zFilePath._asBytesPathcCr�)z�
        Return the path of this L{FilePath} as text.

        @param encoding: The encoding to use if coercing to L{unicode}. If none
            is given, L{sys.getfilesystemencoding} is used.

        @return: L{unicode}
        r�)r�r-r�r+r+r.�_asTextPath�r�zFilePath._asTextPathcC�$t|j
�
tkr|�|j|
d
�
�
S|S)z�
        Return this L{FilePath} in L{bytes}-mode.

        @param encoding: The encoding to use if coercing to L{bytes}. If none is
            given, L{sys.getfilesystemencoding} is used.

        @return: L{bytes} mode L{FilePath}
        r�)r�r-r��	clonePathr�r�r+r+r.�asBytesMode��	

zFilePath.asBytesModecCr�)z�
        Return this L{FilePath} in L{unicode}-mode.

        @param encoding: The encoding to use if coercing to L{unicode}. If none
            is given, L{sys.getfilesystemencoding} is used.

        @return: L{unicode} mode L{FilePath}
        r�)r�r-r�r�r�r�r+r+r.�
asTextMode�r�zFilePath.asTextModecCst|
�
t
kr
|��S|��S)
a

        If C{pattern} is C{bytes}, return L{FilePath.path} as L{bytes}.
        Otherwise, return L{FilePath.path} as L{unicode}.

        @param pattern: The new element of the path that L{FilePath.path} may
            need to be coerced to match.
        )r�r�r�r�)rU�patternr+r+r.�_getPathAsSameTypeAs�s
zFilePath._getPathAsSameTypeAscCs�t|
d
�}t|
t
j�}|�|
�
}t��r |
�|�
r t|
�d��
�
t|
�
}||vr/t|
�d��
�
t	t
||��
}|�|�
sDt|�d|���
�
|�|�
S)a0
        Create and return a new L{FilePath} representing a path contained by
        C{self}.

        @param path: The base name of the new L{FilePath}.  If this contains
            directory separators or parent references it will be rejected.
        @type path: L{bytes} or L{unicode}

        @raise InsecurePath: If the result of combining this path with C{path}
            would result in a path which is not a direct child of this path.

        @return: The child path.
        @rtype: L{FilePath} with a mode equal to the type of C{path}.
        �
:z contains a colon.z* contains one or more directory separators� is not a child of )
r[rqrKr�r#�	isWindows�countrMrr�joinpathrsr�)rUr-�colonrK�ourPath�normr�r+r+r.r4�s










zFilePath.childcCsB|�|
�
}t
t|t|
�
��
}|�|�
st|�d
|���
�
|�|�
S)a�

        Use me if C{path} might have slashes in it, but you know they're safe.

        @param path: A relative path (ie, a path not starting with C{"/"})
            which will be interpreted as a child or descendant of this path.
        @type path: L{bytes} or L{unicode}

        @return: The child path.
        @rtype: L{FilePath} with a mode equal to the type of C{path}.
        r�)r�rr�rrsrMr�)rUr-r�r�r+r+r.�preauthChild
s






zFilePath.preauthChildc
Gs8|
D]}|�|�
}t
||�}t|�
r|�|�

Sqd
S)a�

        Return my first existing child with a name in C{paths}.

        C{paths} is expected to be a list of *pre-secured* path fragments;
        in most cases this will be specified by a system administrator and not
        an arbitrary user.

        If no appropriately-named children exist, this will return L{None}.

        @return: L{None} or the child path.
        @rtype: L{None} or L{FilePath}
        N)r�r�rr�)rU�pathsr4r|�jpr+r+r.�childSearchPreauths





��zFilePath.childSearchPreauthc
	Gs�|
D]P}|s|��r|
S|�
|�
}t|d
�}t|d�}||krCt|�
|}tt|�
�
D]}|�|�
rB|�tt|�
|��


Sq-||}t|�
rR|�|�

SqdS)a�

        Attempt to return a path with my name, given multiple possible
        extensions.

        Each extension in C{exts} will be tested and the first path which
        exists will be returned.  If no path exists, L{None} will be returned.
        If C{''} is in C{exts}, then if the file referred to by this path
        exists, C{self} will be returned.

        The extension '*' has a magic meaning, which means "any path that
        begins with C{self.path + '.'} is acceptable".
        �
*�
.N)	rr�r[rrrrsr�r�)	rU�exts�extr|�star�dot�basedot�fn�p2r+r+r.�siblingExtensionSearch2s"












�

��zFilePath.siblingExtensionSearchc
Cs6|��rt
j�|j�
}
|
|jkrtd
�
�
|�|
�
S|S)a�
        Returns the absolute target as a L{FilePath} if self is a link, self
        otherwise.

        The absolute link is the ultimate file or directory the
        link refers to (for instance, if the link refers to another link, and
        another...).  If the filesystem does not support symlinks, or
        if the link is cyclical, raises a L{LinkError}.

        Behaves like L{os.path.realpath} in that it does not resolve link
        names in the middle (ex. /x/y/z, y is a link to w - realpath on z
        will return /x/y/z, not /x/w/z).

        @return: L{FilePath} of the target path.
        @rtype: L{FilePath}
        @raises LinkError: if links are not supported or links are cyclical.
        z!Cyclical link - will loop forever)r0rqr-rrrPr�)rU�resultr+r+r.rrPs






zFilePath.realpathcCs|�|
�
}|�
||
�
S)
a

        Attempt to return a path with my name, given the extension at C{ext}.

        @param ext: File-extension to search for.
        @type ext: L{bytes} or L{unicode}

        @return: The sibling path.
        @rtype: L{FilePath} with the same mode as the type of C{ext}.
        )r�r�)rUr�r�r+r+r.�siblingExtensionis


zFilePath.siblingExtensioncCst�
|j|
j�
d
S)a�

        Creates a symlink to self to at the path in the L{FilePath}
        C{linkFilePath}.

        Only works on posix systems due to its dependence on
        L{os.symlink}.  Propagates L{OSError}s up from L{os.symlink} if
        C{linkFilePath.parent()} does not exist, or C{linkFilePath} already
        exists.

        @param linkFilePath: a FilePath representing the link to be created.
        @type linkFilePath: L{FilePath}
        N)rq�symlinkr-)rU�linkFilePathr+r+r.�linkTovs
zFilePath.linkTor6r7r�cCs:|jrd
|
v
sJd�
�
|�
�S|
�dd�}
t|j|
d�S)a�

        Open this file using C{mode} or for writing if C{alwaysCreate} is
        C{True}.

        In all cases the file is opened in binary mode, so it is not necessary
        to include C{"b"} in C{mode}.

        @param mode: The mode to open the file in.  Default is C{"r"}.
        @raises AssertionError: If C{"a"} is included in the mode and
            C{alwaysCreate} is C{True}.
        @return: An open file-like object.
        �
az1Appending not supported when alwaysCreate == True�
br�)r��create�replacer8r-�rUr7r+r+r.r8�s


�
z
FilePath.openTcCs4z	t|j
�
|_WdSty


d
|_|
r�YdSw)a�

        Re-calculate cached effects of 'stat'.  To refresh information on this
        path after you know the filesystem may have changed, call this method.

        @param reraise: a boolean.  If true, re-raise exceptions from
            L{os.stat}; otherwise, mark this path as not existing, and remove
            any cached stat information.

        @raise Exception: If C{reraise} is C{True} and an exception occurs
            while reloading metadata.
        r
N)rr-r�rW)rU�reraiser+r+r.�restat�s




��zFilePath.restatc

Cs
d
|_d
S)zl
        Clear any cached information about the state of this path on disk.

        @since: 10.1.0
        N)
r�rgr+r+r.r9�s
zFilePath.changedcCst�
|j|
�
d
S)z�
        Changes the permissions on self, if possible.  Propagates errors from
        L{os.chmod} up.

        @param mode: integer representing the new permissions desired (same as
            the command line chmod)
        @type mode: L{int}
        N)rq�chmodr-r�r+r+r.r��s	zFilePath.chmodc
Cs|j}
|
s|�
�
|j}
|
jS)
z�
        Retrieve the size of this file in bytes.

        @return: The size of the file at this file path in bytes.
        @raise Exception: if the size cannot be obtained.
        @rtype: L{int}
        )r�r��st_size�rU�str+r+r.r:�s




zFilePath.getsizec
C�"|j}
|
s|�
�
|j}
t|
j�
S)
r;)r�r��float�st_mtimer�r+r+r.r<��





zFilePath.getModificationTimec
Cr�)
r=)r�r�r��st_ctimer�r+r+r.r>�r�zFilePath.getStatusChangeTimec
Cr�)
r?)r�r�r��st_atimer�r+r+r.r@�r�zFilePath.getAccessTimec
C�*t�
�rt�
|j}
|
s|��
|j}
|
jS)
a�

        Retrieve the file serial number, also called inode number, which
        distinguishes this file from all other files on the same device.

        @raise NotImplementedError: if the platform is Windows, since the
            inode number would be a dummy value for all files in Windows
        @return: a number representing the file serial number
        @rtype: L{int}
        @since: 11.0
        )r#r��NotImplementedErrorr�r��st_inor�r+r+r.�getInodeNumber�s




zFilePath.getInodeNumberc
Cr�)
a�

        Retrieves the device containing the file.  The inode number and device
        number together uniquely identify the file, but the device number is
        not necessarily consistent across reboots or system crashes.

        @raise NotImplementedError: if the platform is Windows, since the
            device number would be 0 for all partitions on a Windows platform

        @return: a number representing the device
        @rtype: L{int}

        @since: 11.0
        )r#r�r�r�r��st_devr�r+r+r.�	getDevices




zFilePath.getDevicec
Cr�)
a�
        Retrieves the number of hard links to the file.

        This count keeps track of how many directories have entries for this
        file. If the count is ever decremented to zero then the file itself is
        discarded as soon as no process still holds it open.  Symbolic links
        are not counted in the total.

        @raise NotImplementedError: if the platform is Windows, since Windows
            doesn't maintain a link count for directories, and L{os.stat} does
            not set C{st_nlink} on Windows anyway.
        @return: the number of hard links to the file
        @rtype: L{int}
        @since: 11.0
        )r#r�r�r�r��st_nlinkr�r+r+r.�getNumberOfHardLinks#s




zFilePath.getNumberOfHardLinksc
Cr�)
a	

        Returns the user ID of the file's owner.

        @raise NotImplementedError: if the platform is Windows, since the UID
            is always 0 on Windows
        @return: the user ID of the file's owner
        @rtype: L{int}
        @since: 11.0
        )r#r�r�r�r��st_uidr�r+r+r.�	getUserID<�





zFilePath.getUserIDc
Cr�)
z�
        Returns the group ID of the file.

        @raise NotImplementedError: if the platform is Windows, since the GID
            is always 0 on windows
        @return: the group ID of the file
        @rtype: L{int}
        @since: 11.0
        )r#r�r�r�r��st_gidr�r+r+r.�
getGroupIDOr
zFilePath.getGroupIDc
Cs&|j}
|
s|�
�
|j}
tt|
j�
�
S)
a

        Returns the permissions of the file.  Should also work on Windows,
        however, those permissions may not be what is expected in Windows.

        @return: the permissions for the file
        @rtype: L{Permissions}
        @since: 11.1
        )r�r�r�r
�st_moder�r+r+r.�getPermissionsbs
	



zFilePath.getPermissionsc

Cs"|jrd
S|�
d�

|jrd
SdS)z�
        Check if this L{FilePath} exists.

        @return: C{True} if the stats of C{path} can be retrieved successfully,
            C{False} in the other cases.
        @rtype: L{bool}
        TF)r�r�rgr+r+r.rqs



zFilePath.existsc
C�,|j}
|
s|�
d
�

|j}
|
sd
St|
j�
S)z�
        Check if this L{FilePath} refers to a directory.

        @return: C{True} if this L{FilePath} refers to a directory, C{False}
            otherwise.
        @rtype: L{bool}
        F)r�r�rr
r�r+r+r.rA��







zFilePath.isdirc
Cr
)z�
        Check if this file path refers to a regular file.

        @return: C{True} if this L{FilePath} points to a regular file (not a
            directory, socket, named pipe, etc), C{False} otherwise.
        @rtype: L{bool}
        F)r�r�rr
r�r+r+r.rB�r
zFilePath.isfilec
Cr
)z�
        Returns whether the underlying path is a block device.

        @return: C{True} if it is a block device, C{False} otherwise
        @rtype: L{bool}
        @since: 11.1
        F)r�r�rr
r�r+r+r.�
isBlockDevice�r
zFilePath.isBlockDevicec
Cr
)z�
        Returns whether the underlying path is a socket.

        @return: C{True} if it is a socket, C{False} otherwise
        @rtype: L{bool}
        @since: 11.1
        F)r�r�rr
r�r+r+r.�isSocket�r
zFilePath.isSocketc

C�
t|j
�
S)
z�
        Check if this L{FilePath} points to a symbolic link.

        @return: C{True} if this L{FilePath} points to a symbolic link,
            C{False} otherwise.
        @rtype: L{bool}
        )r0r-rgr+r+r.r0��
zFilePath.islinkc

Cr	
)
z�
        Check if this L{FilePath} refers to an absolute path.

        This always returns C{True}.

        @return: C{True}, always.
        @rtype: L{bool}
        )r	r-rgr+r+r.r	��
	zFilePath.isabsc

Cr	
)
a�

        List the base names of the direct children of this L{FilePath}.

        @return: A L{list} of L{bytes}/L{unicode} giving the names of the
            contents of the directory this L{FilePath} refers to. These names
            are relative to this L{FilePath}.
        @rtype: L{list}

        @raise OSError: Any exception the platform L{os.listdir} implementation
            may raise.
        )rr-rgr+r+r.r�r

zFilePath.listdirc

Cr	
)
a

        Split the file path into a pair C{(root, ext)} such that
        C{root + ext == path}.

        @return: Tuple where the first item is the filename and second item is
            the file extension. See Python docs for L{os.path.splitext}.
        @rtype: L{tuple}
        )rr-rgr+r+r.r�r
zFilePath.splitextc

Csd
|j�d�S)Nz	FilePath(�
)r,rgr+r+r.r��s
zFilePath.__repr__c

Cs6z	|�d
�
�
�
Wn	ty


Yn
wt|jd�
dS)a$

        Updates the access and last modification times of the file at this
        file path to the current time. Also creates the file if it does not
        already exist.

        @raise Exception: if unable to create or modify the last modification
            time of the file.
        r�N)r8�closerWrr-rgr+r+r.�touch�s	


�zFilePath.touchc
CsL|��r|�
�s|��D]}
|
��
qt�|j�

nt�|j�

|��
d
S)z�
        Removes the file or directory that is represented by self.  If
        C{self.path} is a directory, recursively remove all its children
        before removing the directory. If it's a file or link, just delete it.
        N)rAr0rC�removerq�rmdirr-r9)rUr4r+r+r.r
s




zFilePath.removec
CsPzt�
|j�
WSty'
}
z|jtjkr|
r|��s�WYd
}~d
Sd
}~w
w)a

        Create all directories not yet existing in C{path} segments, using
        L{os.makedirs}.

        @param ignoreExistingDirectory: Don't raise L{OSError} if directory
            already exists.
        @type ignoreExistingDirectory: L{bool}

        @return: L{None}
        N)rq�makedirsr-rWrk�EEXISTrA)rU�ignoreExistingDirectory�
er+r+r.r
s

���zFilePath.makedirscsXt|
t
j�}��|
�
}d
dl}|d|kr||
p|�||
g�
}�f
dd�|�|�
D�
S)a�

        Assuming I am representing a directory, return a list of FilePaths
        representing my children that match the given pattern.

        @param pattern: A glob pattern to use to match child paths.
        @type pattern: L{unicode} or L{bytes}

        @return: A L{list} of matching children.
        @rtype: L{list} of L{FilePath}, with the mode of C{pattern}'s type
        r
N���c
rdr+)
r�)rfr|rgr+r.rh8riz)FilePath.globChildren.<locals>.<listcomp>)r[rqrKr��globr
)rUr�rKr�r
r-r+rgr.�globChildren's


"
zFilePath.globChildrenc

Cr	
)
a:

        Retrieve the final component of the file path's path (everything
        after the final path separator).

        @return: The final component of the L{FilePath}'s path (Everything
            after the final path separator).
        @rtype: the same type as this L{FilePath}'s C{path} attribute
        )rr-rgr+r+r.r:r
zFilePath.basenamec

Cr	
)
ah

        Retrieve all of the components of the L{FilePath}'s path except the
        last one (everything up to the final path separator).

        @return: All of the components of the L{FilePath}'s path except the
            last one (everything up to the final path separator).
        @rtype: the same type as this L{FilePath}'s C{path} attribute
        )rr-rgr+r+r.rEr
zFilePath.dirnamec

Cs|�|�
��
S)
z�
        A file path for the directory containing the file at this file path.

        @return: A L{FilePath} representing the path which directly contains
            this L{FilePath}.
        @rtype: L{FilePath}
        )r�rrgr+r+r.rDPr�zFilePath.parent�.newcCst|�|�
}|�
d
�
�
}|�|
�

Wd�
n1sw



Y
t��r.t|j�
r.t�|j�

t�	|j|�
�j�
dS)a�
        Replace the file at this path with a new file that contains the given
        bytes, trying to avoid data-loss in the meanwhile.

        On UNIX-like platforms, this method does its best to ensure that by the
        time this method returns, either the old contents I{or} the new
        contents of the file will be present at this path for subsequent
        readers regardless of premature device removal, program crash, or power
        loss, making the following assumptions:

            - your filesystem is journaled (i.e. your filesystem will not
              I{itself} lose data due to power loss)

            - your filesystem's C{rename()} is atomic

            - your filesystem will not discard new data while preserving new
              metadata (see U{http://mjg59.livejournal.com/108257.html} for
              more detail)

        On most versions of Windows there is no atomic C{rename()} (see
        U{http://bit.ly/win32-overwrite} for more information), so this method
        is slightly less helpful.  There is a small window where the file at
        this path may be deleted before the new file is moved to replace it:
        however, the new file will be fully written and flushed beforehand so
        in the unlikely event that there is a crash at that point, it should be
        possible for the user to manually recover the new version of their
        data.  In the future, Twisted will support atomic file moves on those
        versions of Windows which I{do} support them: see U{Twisted ticket
        3004<http://twistedmatrix.com/trac/ticket/3004>}.

        This method should be safe for use by multiple concurrent processes,
        but note that it is not easy to predict which process's contents will
        ultimately end up on disk if they invoke this method at close to the
        same time.

        @param content: The desired contents of the file at this path.
        @type content: L{bytes}

        @param ext: An extension to append to the temporary filename used to
            store the bytes while they are being written.  This can be used to
            make sure that temporary files can be identified by their suffix,
            for cleanup in case of crashes.
        @type ext: L{bytes}
        r�N)�temporarySiblingr8r�r#r�rr-rq�unlink�renamer�)rU�contentr��sibr{r+r+r.�
setContentZs
-

�

zFilePath.setContentcCst|
t
�stSt|j|
j�Sr�)r�r��NotImplementedr!r-)rUr�r+r+r.�__cmp__�s



zFilePath.__cmp__c

Cst�
|j�

d
S)z�
        Create the directory the L{FilePath} refers to.

        @see: L{makedirs}

        @raise OSError: If the directory cannot be created.
        N)rq�mkdirr-rgr+r+r.�createDirectory�szFilePath.createDirectoryr�cCs
|
|_d
S)z�
        Sets the C{alwaysCreate} variable.

        @param val: C{True} or C{False}, indicating whether opening this path
            will be required to create the file or not.
        @type val: L{bool}

        @return: L{None}
        N)
r�)rUr�r+r+r.�
requireCreate�s

zFilePath.requireCreatec
Cs$t�
|jt�}
tttt�|
d
��S)z�
        Exclusively create a file, only if this file previously did not exist.

        @return: A file-like object opened from this path.
        zw+b)rqr8r-�
_CREATE_FLAGSrrr��fdopen)rU�fdintr+r+r.r��szFilePath.create�cCs6|�|
�
}|�
t|�
|�|�
��|
�
}|��
|S)
a�
        Construct a path referring to a sibling of this path.

        The resulting path will be unpredictable, so that other subprocesses
        should neither accidentally attempt to refer to the same path before it
        is created, nor they should other processes be able to guess its name
        in advance.

        @param extension: A suffix to append to the created filename.  (Note
            that if you want an extension with a '.' you must include the '.'
            yourself.)
        @type extension: L{bytes} or L{unicode}

        @return: a path object with the given extension suffix, C{alwaysCreate}
            set to True.
        @rtype: L{FilePath} with a mode equal to the type of C{extension}
        )r�rEr]r�rr#
)rU�	extensionr�r
r+r+r.r
�s



���
zFilePath.temporarySiblingi
c	Cs 
|��r|st
�t
�|j�
|
j�
d
S|��r5|
��s|
��
|��D]}|
�	|�
��
}|�||�
q#d
S|��r�|
�
d�
�:}|�
��}	|�|j�
}|�|�

t|�
|jkrXn
qEWd
�
n1scw



Y
Wd
�
d
SWd
�
d
S1s{w



Y
d
S|��s�ttjd��
td�
�
)a�
        Copies self to destination.

        If self doesn't exist, an OSError is raised.

        If self is a directory, this method copies its children (but not
        itself) recursively to destination - if destination does not exist as a
        directory, this method creates it.  If destination is a file, an
        IOError will be raised.

        If self is a file, this method copies it to destination.  If
        destination is a file, this method overwrites it.  If destination is a
        directory, an IOError will be raised.

        If self is a link (and followLinks is False), self will be copied
        over as a new symlink with the same target as returned by os.readlink.
        That means that if it is absolute, both the old and new symlink will
        link to the same thing.  If it's relative, then perhaps not (and
        it's also possible that this relative link will be broken).

        File/directory permissions and ownership will NOT be copied over.

        If followLinks is True, symlinks are followed so that they're treated
        as their targets.  In other words, if self is a link, the link's target
        will be copied.  If destination is a link, self will be copied to the
        destination's target (the actual destination will be destination's
        target).  Symlinks under self (if self is a directory) will be
        followed and its target's children be copied recursively.

        If followLinks is False, symlinks will be copied over as symlinks.

        @param destination: the destination (a FilePath) to which self
            should be copied
        @param followLinks: whether symlinks in self should be treated as links
            or as their targets
        Nr�r�zNo such file or directoryz/Only copying of files and directories supported)r0rqr��readlinkr-rArr"
rCr4r�copyTorBr8r_�
_chunkSizer��lenrWrkrlr�)rU�destination�followLinksr4�	destChild�	writefile�readfile�chunkr+r+r.r*
�s.%






�





�	P�
zFilePath.copyToc
Cs�z
t�
|�|
j�
|
j�
Wn9tyF
}
z-|jtjkr:|
��}|�||�
|�	|
|�
|��}|�	||�
|�
�
n
�WYd
}~d
Sd
}~w
w|��
|
��
d
S)a�
        Move self to destination - basically renaming self to whatever
        destination is named.

        If destination is an already-existing directory,
        moves all children to destination if destination is empty.  If
        destination is a non-empty directory, or destination is a file, an
        OSError will be raised.

        If moving between filesystems, self needs to be copied, and everything
        that applies to copyTo applies to moveTo.

        @param destination: the destination (a FilePath) to which self
            should be copied
        @param followLinks: whether symlinks in self should be treated as links
            or as their targets (only applicable when moving between
            filesystems)
        N)rqr
r�r-rWrk�EXDEVr
r*
�moveTor
r9)rUr-
r.
ro�secsib�mysecsibr+r+r.r4
s 


	




���
zFilePath.moveTo)
Fr�rF)
T)
r
)
r�)
r'
)CrGrHrIrJr�r-rr�r��__annotations__rVr��propertyrKr�r�r�r�r�r4r�r�r�rrr�r�rr8r�r9r�r:r<r>r@r�r�r�r�r
r
rrArBr
r
r0r	rrr�r
r
r
r
rrrDr
r 
r"
r#
r�r
r+
r*
r4
r+r+r+r.r�msx
!





	





 







4



Gr�)
r�r�)RrJ�base64rkrqr�rrr�os.pathrrrrr	r
r�rrr
rrrrrrrrrrrrr�typingrrr�zope.interfacerrr �twisted.python.compatr!r"�twisted.python.runtimer#�twisted.python.utilr$�twisted.python.win32r%r&r'r(r)�O_EXCL�O_CREAT�O_RDWRr$
r/rjr-r0�urandomrZ�urlsafe_b64encoderYr1�	ExceptionrMrPrWrQr]r^r�r�r�r�r�r�r[r�r�r+r+r+r.�<module>
sV



(
@







E2 ,




a