o b@sdZddlZddlZddlZddlZddlmZmZmZddlm Z m Z m Z m Z m Z mZmZmZddlmZmZmZmZmZmZmZmZmZmZmZmZmZmZddl m!Z!m"Z"m#Z#ddl$m%Z%m&Z&m'Z'ddl(m)Z)m*Z*dd l+m,Z,dd l-m.Z.dd l/m0Z0m1Z1m2Z2m3Z3m4Z4ej5ej6Bej7Be4BZ8d d Z9e:ej;de9Zej?Z@Gddde&ZAGdddeBZCGdddeBZDGdddeEZFddZGGdddZHGddde.ZIGddde.ZJd+d e"eKeLfd!eLd"eKfd#d$ZMd,d%d&ZNd,d'd(ZOe*e'eAGd)d*d*eHZPePeP_QdS)-z1 Object-oriented filesystem path representation. N)listdirstatutime)abspathbasenamedirnameexistsisabsjoinnormpathsplitext)S_IMODES_IRGRPS_IROTHS_IRUSRS_ISBLKS_ISDIRS_ISREGS_ISSOCKS_IWGRPS_IWOTHS_IWUSRS_IXGRPS_IXOTHS_IXUSR)IOUnioncast) Attribute Interface implementer)cmp comparable)platform) FancyEqMixin)ERROR_DIRECTORYERROR_FILE_NOT_FOUNDERROR_INVALID_NAMEERROR_PATH_NOT_FOUNDO_BINARYcCdS)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} Fpathr+r+9/usr/lib/python3/dist-packages/twisted/python/filepath.py _stub_islink@s r/islinkc@seZdZdZedZddZd!ddZdd Zd d Z d d Z ddZ ddZ ddZ ddZddZddZddZddZddZd 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 representationscCr*)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.childqzIFilePath.childrcCr*)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.opencCr*)zT Clear any cached information about the state of this path on disk. Nr+r+r+r+r.changedr5zIFilePath.changedcCr*)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.getsizer5zIFilePath.getsizecCr*) 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.getModificationTimer5zIFilePath.getModificationTimecCr*) 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.getStatusChangeTimer5zIFilePath.getStatusChangeTimecCr*) 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. getAccessTimer5zIFilePath.getAccessTimecCr*)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.rr5zIFilePath.existscCr*)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.isdirr5zIFilePath.isdircCr*)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.isfiler5zIFilePath.isfilecCr*)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.childrenr5zIFilePath.childrencCr*)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.rr5zIFilePath.basenamecCr*)zV A file path for the directory containing the file at this file path. Nr+r+r+r+r.parentr5zIFilePath.parentcCr*)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.siblingr5zIFilePath.siblingNr6)__name__ __module__ __qualname____doc__rsepr4r8r9r:r<r>r@rrArBrCrrDrEr+r+r+r.r1Rs"   r1c@eZdZdZdS) InsecurePathzP Error that is raised when the path provided to L{FilePath} is invalid. NrGrHrIrJr+r+r+r.rMrMc@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.rPrOrPc@seZdZdZdefddZdS)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||_dS)zq Create an UnlistableError exception. @param originalException: an instance of OSError. N)__dict__updaterR)selfrRr+r+r.__init__s zUnlistableError.__init__N)rGrHrIrJOSErrorrVr+r+r+r.rQs rQcCsttddd}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._secureEnoughStrings r]c@sjeZdZdZddZddZddZdd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZdS)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. cCs4| }|WdS1swYdS)z Retrieve the contents of the file at this path. @return: the contents of the file @rtype: L{bytes} N)r8read)rUfpr+r+r. getContents $zAbstractFilePath.getContentccs8|}|}||kr|V|}|}||ks dSdS)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(szAbstractFilePath.parentsc stz}Wn*ty0}zt|ddttttfvrt||jtj tj fvr+t|d}~wwfdd|DS)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. winerrorNcg|]}|qSr+r4).0r3rUr+r. `z-AbstractFilePath.children..) rrWgetattrr(r&r'r%rQerrnoENOENTENOTDIR)rUsubnamesoser+rgr.rC7s   zAbstractFilePath.childrenNccsz|V|r9|D].}|dus||r5||D]}tj|jtj|jr0td|Vqq |Vq dSdS)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.)rArCwalkosr-realpath startswithrP)rUdescendcsubcr+r+r.rpbs  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.rEs zAbstractFilePath.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)rUsegmentsr-r3r+r+r. descendants  zAbstractFilePath.descendantcCsp|}|}g}||kr'||kr'|g|dd<|}|}||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 rz not parent of )rDr ValueError)rUancestorfprwr+r+r. segmentsFroms zAbstractFilePath.segmentsFromcCst|j|jfS)zR Hash the same as another L{FilePath} with the same path as mine. )hash __class__r-rgr+r+r.__hash__szAbstractFilePath.__hash__cC t|S)z? Deprecated. Use getModificationTime instead. )intr<rgr+r+r.getmtime zAbstractFilePath.getmtimecCr)z9 Deprecated. Use getAccessTime instead. )rr@rgr+r+r.getatimerzAbstractFilePath.getatimecCr)z? Deprecated. Use getStatusChangeTime instead. )rr>rgr+r+r.getctimerzAbstractFilePath.getctimeN)rGrHrIrJrarbrCrprErxr}rrrrr+r+r+r.r^s   +  r^c@2eZdZdZdZddZdefddZdd 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_writeexecutecCs||_||_||_dSrr)rUreadablewritable executabler+r+r.rVs z RWX.__init__returncCsd|j|j|jS)Nz"RWX(read={}, write={}, execute={}))formatr_rrrgr+r+r.__repr__s z RWX.__repr__cCs@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} )r6wxr-)r_rrr )rU returnvalivalr+r+r. shorthands   z RWX.shorthandN rGrHrIrJcompareAttributesrVstrrrr+r+r+r.rs  rc@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 )usergroupothercs:fddtttgtttgtttgfD\|_ |_ |_ dS)Nc3s&|]}tfdd|DVqdS)c3s|] }|@dkVqdS)rNr+)rfbit statModeIntr+r. sz1Permissions.__init__...N)r)rfbitGrouprr+r.rs  z'Permissions.__init__..) rrrrrrrrrrrr)rUrr+rr.rVs zPermissions.__init__rcCs*dt|jdt|jdt|jdS)N[z | ])rrrrrgr+r+r.r's*zPermissions.__repr__cCs ddd|j|j|jfDS)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} rcSsg|]}|qSr+)r)rfrr+r+r.rh3sz)Permissions.shorthand..)r rrrrgr+r+r.r*s zPermissions.shorthandNrr+r+r+r.r s  rrr-encodingrcCs$t|tr|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} ) isinstancebytessysgetfilesystemencodingencoder-rr+r+r._asFilesystemBytes6s  rcCs*t|tkr|S|durt}||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)typerrrdecoderr+r+r._asFilesystemTextJs  rcCs$t|tkr t||dSt||dS)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)rrrr)r-newpathrr+r+r.r[_s   r[c@seZdZUdZdZdZeeefe d<dyddZ ddZ e d d Z dzd d Zdzd dZdzddZdzddZddZddZddZddZddZddZdd Zd!d"Zd{d$ed%eefd&d'Zd|d)d*Zd+d,Zd-d.Zd/d0Zd1d2Z d3d4Z!d5d6Z"d7d8Z#d9d:Z$d;d<Z%d=d>Z&d?d@Z'dAdBZ(dCdDZ)dEdFZ*dGdHZ+dIdJZ,dKdLZ-dMdNZ.dOdPZ/dQdRZ0dSdTZ1d%efdUdVZ2dWdXZ3dYdZZ4dyd[d\Z5d]d^Z6d_d`Z7dadbZ8dcddZ9d}dfdgZ:dhdiZ;djdkZddrdsZ?dtZ@d|dudvZAd|dwdxZBdS)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||_||_dS)z Convert a path string to an absolute path if necessary and initialize the L{FilePath} with the result. N)rr- alwaysCreate)rUr-rr+r+r.rVs  zFilePath.__init__cCs|j}d|vr |d=|S)zv Support serialization by discarding cached L{os.stat} results and returning everything else. _statinfo)rScopy)rUdr+r+r. __getstate__s zFilePath.__getstate__cCst|jtjS)z Return a filesystem separator. @return: The native filesystem separator. @returntype: The same type as C{self.path}. )r[r-rqrKrgr+r+r.rKz FilePath.sepcCt|j|dS)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)rr-rUrr+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)rr-rr+r+r. _asTextPathrzFilePath._asTextPathcC$t|jtkr||j|dS|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)rr-r clonePathrrr+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)rr-rrrrr+r+r. asTextModerzFilePath.asTextModecCst|tkr |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. )rrrr)rUpatternr+r+r._getPathAsSameTypeAss zFilePath._getPathAsSameTypeAscCst|d}t|tj}||}tr ||r t|dt|}||vr/t|dt 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[rqrKrr# isWindowscountrMr rjoinpathrsr)rUr-colonrKourPathnormrr+r+r.r4s     zFilePath.childcCsB||}tt|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)rrrr rsrMr)rUr-rrr+r+r. preauthChild s   zFilePath.preauthChildcGs8|D]}||}t||}t|r||SqdS)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)rrrr)rUpathsr4r|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) rrr[rrrrsrr) rUextsextr|stardotbasedotfnp2r+r+r.siblingExtensionSearch2s"      zFilePath.siblingExtensionSearchcCs6|rtj|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)rUresultr+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}. )rr)rUrrr+r+r.siblingExtensionis zFilePath.siblingExtensioncCst|j|jdS)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)rqsymlinkr-)rU linkFilePathr+r+r.linkTovs zFilePath.linkTor6r7rcCs:|jrd|vs Jd|S|dd}t|j|dS)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 == Truebr)rcreatereplacer8r-rUr7r+r+r.r8s  z FilePath.openTcCs4z t|j|_WdStyd|_|rYdSw)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. rN)rr-rrW)rUreraiser+r+r.restats  zFilePath.restatcCs d|_dS)zl Clear any cached information about the state of this path on disk. @since: 10.1.0 N)rrgr+r+r.r9s zFilePath.changedcCst|j|dS)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)rqchmodr-rr+r+r.rs zFilePath.chmodcCs|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} )rrst_sizerUstr+r+r.r:s zFilePath.getsizecC"|j}|s ||j}t|jS)r;)rrfloatst_mtimerr+r+r.r<  zFilePath.getModificationTimecCr)r=)rrrst_ctimerr+r+r.r>rzFilePath.getStatusChangeTimecCr)r?)rrrst_atimerr+r+r.r@rzFilePath.getAccessTimecC*trt|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#rNotImplementedErrorrrst_inorr+r+r.getInodeNumbers zFilePath.getInodeNumbercCr)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#rrrrst_devrr+r+r. getDevice szFilePath.getDevicecCr)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#rrrrst_nlinkrr+r+r.getNumberOfHardLinks#szFilePath.getNumberOfHardLinkscCr)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#rrrrst_uidrr+r+r. getUserID< zFilePath.getUserIDcCr)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#rrrrst_gidrr+r+r. getGroupIDOrzFilePath.getGroupIDcCs&|j}|s ||j}tt|jS)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 )rrrr st_moderr+r+r.getPermissionsbs  zFilePath.getPermissionscCs"|jrdS|d|jrdSdS)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)rrrgr+r+r.rqs  zFilePath.existscC,|j}|s|d|j}|sdSt|jS)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)rrrrrr+r+r.rA  zFilePath.isdircCr)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)rrrrrr+r+r.rBrzFilePath.isfilecCr)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)rrrrrr+r+r. isBlockDevicerzFilePath.isBlockDevicecCr)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)rrrrrr+r+r.isSocketrzFilePath.isSocketcC t|jS)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.islinkcCr )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.isabscCr )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.rr zFilePath.listdircCr )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.splitextcCsd|jdS)Nz FilePath()r,rgr+r+r.rszFilePath.__repr__cCs6z |dWn tyYnwt|jddS)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. rN)r8closerWrr-rgr+r+r.touchs   zFilePath.touchcCsL|r|s|D]}|q t|jnt|j|dS)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)rAr0rCremoverqrmdirr-r9)rUr4r+r+r.rs     zFilePath.removec CsPzt|jWSty'}z|jtjkr|r|sWYd}~dSd}~ww)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)rqmakedirsr-rWrkEEXISTrA)rUignoreExistingDirectoryer+r+r.rs zFilePath.makedirscsXt|tj}|}ddl}|d|kr||p|||g}fdd||DS)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 rNcrdr+)r)rfr|rgr+r.rh8riz)FilePath.globChildren..)r[rqrKrglobr )rUrrKrrr-r+rgr. globChildren's "zFilePath.globChildrencCr )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.basenamecCr )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.dirnamecCs||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} )rrrgr+r+r.rDPrzFilePath.parent.newcCst||}|d }||Wdn1swYtr.t|jr.t|jt |j| jdS)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}. 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} rN) temporarySiblingr8rr#rrr-rqunlinkrenamer)rUcontentrsibr{r+r+r. setContentZs -   zFilePath.setContentcCst|tstSt|j|jSr)rrNotImplementedr!r-)rUrr+r+r.__cmp__s zFilePath.__cmp__cCst|jdS)z Create the directory the L{FilePath} refers to. @see: L{makedirs} @raise OSError: If the directory cannot be created. N)rqmkdirr-rgr+r+r.createDirectoryszFilePath.createDirectoryrcCs ||_dS)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)rUrr+r+r. requireCreates zFilePath.requireCreatecCs$t|jt}tttt|dS)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_FLAGSrrrfdopen)rUfdintr+r+r.rszFilePath.createcCs6||}|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} )rrEr]rrr#)rU extensionrrr+r+r.rs  zFilePath.temporarySiblingic Cs |r|stt|j|jdS|r5|s||D]}| | }| ||q#dS| r| d:}| } ||j}||t||jkrXnqEWdn1scwYWddSWddS1s{wYdS|sttjdtd)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 NrrzNo such file or directoryz/Only copying of files and directories supported)r0rqrreadlinkr-rArr"rCr4rcopyTorBr8r_ _chunkSizerlenrWrkrlr)rU destination followLinksr4 destChild writefilereadfilechunkr+r+r.r*s. %    P zFilePath.copyToc Csz t||j|jWn9tyF}z-|jtjkr:|}|||| |||}| ||| nWYd}~dSd}~ww| | dS)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) rqrrr-rWrkEXDEVrr*moveTorr9)rUr-r.rosecsibmysecsibr+r+r.r4s       zFilePath.moveTo)FrrF)T)r)r)r')CrGrHrIrJrr-rrr__annotations__rVrpropertyrKrrrrrr4rrrrrrrrr8rr9rr:r<r>r@rrrrrrrrArBrrr0r rr rrrrrrrrDrr r"r#rrr+r*r4r+r+r+r.rmsx !                 4   Gr)rr)RrJbase64rkrqrrrros.pathrrrrr r rr r r rrrrrrrrrrrrrtypingrrrzope.interfacerrr twisted.python.compatr!r"twisted.python.runtimer#twisted.python.utilr$twisted.python.win32r%r&r'r(r)O_EXCLO_CREATO_RDWRr$r/rjr-r0urandomrZurlsafe_b64encoderYr1 ExceptionrMrPrWrQr]r^rrrrrrr[rrr+r+r+r.sV(@     E2 ,   a