/usr/lib/python3/dist-packages/twisted/python/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/python/__pycache__/filepath.cpython-310.pyc (52050B)
o
b @ s d Z ddlZddlZddlZddlZddlmZmZmZ ddlm Z m
Z
m Z m Z m
Z
mZmZmZ ddlmZmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z ddl 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/m0Z0m1Z1m2Z2m3Z3m4Z4 ej5ej6B ej7B e4B Z8d d
Z9e:ej;de9Z
ej?Z@G dd de&ZAG dd deBZCG dd deBZDG dd deEZFdd ZGG dd dZHG dd d e.ZIG d d d e.ZJd+d e"eKeLf d!eLd"eKfd#d$ZMd,d%d&ZNd,d'd(ZOe*e'eAG d)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_BINARYc C dS )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 e Zd ZdZedZdd Zd!ddZdd Zd
d Z d d
Z
dd Z dd Z dd Z
dd Zdd Zdd Zdd Zd d Zd d 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 C r* )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.childrc C r* )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} r5 zIFilePath.openc C r* )zT
Clear any cached information about the state of this path on disk.
Nr+ r+ r+ r+ r. changed r5 zIFilePath.changedc C r* )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 r5 zIFilePath.getsizec C r* )
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 r5 z IFilePath.getModificationTimec C r* )
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 r5 z IFilePath.getStatusChangeTimec C r* )
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 r5 zIFilePath.getAccessTimec C r* )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 r5 zIFilePath.existsc C r* )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 r5 zIFilePath.isdirc C r* )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 r5 zIFilePath.isfilec C r* )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 r5 zIFilePath.childrenc C r* )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 r5 zIFilePath.basenamec C r* )zV
A file path for the directory containing the file at this file path.
Nr+ r+ r+ r+ r. parent r5 zIFilePath.parentc C r* )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+ r2 r+ r+ r. sibling r5 zIFilePath.siblingNr6 )__name__
__module__ __qualname____doc__r sepr4 r8 r9 r: r< r> r@ r rA rB rC r rD rE r+ r+ r+ r. r1 R s"
r1 c @ e Zd ZdZdS ) InsecurePathzP
Error that is raised when the path provided to L{FilePath} is invalid.
NrG rH rI rJ r+ r+ r+ r. rM rM c @ rL ) LinkErrorz
An error with symlinks - either that there are cyclical symlinks or that
symlink are not supported on this platform.
NrN r+ r+ r+ r. rP rO rP c @ s e Zd ZdZdefddZdS )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.
originalExceptionc C s | j |j || _dS )zq
Create an UnlistableError exception.
@param originalException: an instance of OSError.
N)__dict__updaterR )selfrR r+ r+ r. __init__ s
zUnlistableError.__init__N)rG rH rI rJ OSErrorrV r+ r+ r+ r. rQ s
rQ c C s t tddd }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 @ sj e Zd ZdZdd Zdd Zdd Zdd d
Zd d Zd
d Z dd Z
dd Z dd 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 C s4 | }| W d S 1 sw Y dS )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 c s8 | }| }||kr|V |}| }||ks dS dS )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 )rU r- rD r+ r+ r. parents( s zAbstractFilePath.parentsc
st z }W n* ty0 } z t|ddttttfv r t||jtj tj
fv r+t| d}~ww fdd|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 | ]} |qS r+ r4 ).0r3 rU r+ r.
` z-AbstractFilePath.children..) r rW getattrr( r& r' r% rQ errnoENOENTENOTDIR)rU subnamesoser+ rg r. rC 7 s
zAbstractFilePath.childrenNc c sz | V | r9| D ].}|du s||r5||D ]}tj| jtj|jr0td|V qq |V q dS dS )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.)rA rC walkosr- realpath
startswithrP )rU descendcsubcr+ r+ r. rp b s zAbstractFilePath.walkc C s | |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}
)rD r4 )rU r- r+ r+ r. rE s zAbstractFilePath.siblingc C s | }|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- r3 r+ r+ r.
descendant s zAbstractFilePath.descendantc C sp | }| }g }||kr'||kr'| g|dd< |}| }||kr'||ks||kr/|r/|S t|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 )rD r
ValueError)rU ancestorfprw r+ r+ r. segmentsFrom s z AbstractFilePath.segmentsFromc C s t | j| jfS )zR
Hash the same as another L{FilePath} with the same path as mine.
)hash __class__r- rg r+ r+ r. __hash__ s zAbstractFilePath.__hash__c C t | S )z?
Deprecated. Use getModificationTime instead.
)intr< rg r+ r+ r. getmtime zAbstractFilePath.getmtimec C r )z9
Deprecated. Use getAccessTime instead.
)r r@ rg r+ r+ r. getatime r zAbstractFilePath.getatimec C r )z?
Deprecated. Use getStatusChangeTime instead.
)r r> rg r+ r+ r. getctime r zAbstractFilePath.getctimeN)rG rH rI rJ ra rb rC rp rE rx r} r r r r r+ r+ r+ r. r^ s
+
r^ c @ 2 e Zd ZdZdZdd ZdefddZdd 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_ writeexecutec C s || _ || _|| _d S r r )rU readablewritable
executabler+ r+ r. rV s
z RWX.__init__returnc C s d | j| j| jS )Nz"RWX(read={}, write={}, execute={}))formatr_ r r rg r+ r+ r. __repr__ s
z RWX.__repr__c C s@ g d}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 wxr - )r_ r r r
)rU returnvalivalr+ r+ r. shorthand s
z
RWX.shorthandN rG rH rI rJ 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
)usergroupotherc s: fddt ttgtttgtttgfD \| _ | _
| _ d S )Nc 3 s& | ]}t fd d|D V qdS )c 3 s | ] } |@ d kV qdS )r Nr+ )rf bit statModeIntr+ r. s z1Permissions.__init__...N)r )rf bitGroupr r+ r. r s
z'Permissions.__init__..) r r r r r r r r r r r r )rU r r+ r r. rV s
zPermissions.__init__r c C s* dt | j dt | j dt | j dS )N[z | ])r r r r rg r+ r+ r. r ' s *zPermissions.__repr__c C s 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 S s g | ]}| qS r+ )r )rf r r+ r+ r. rh 3 s z)Permissions.shorthand..)r
r r r rg r+ r+ r. r * s zPermissions.shorthandNr r+ r+ r+ r. r
s
r r r- encodingr c C s$ 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- r r+ r+ r. _asFilesystemBytes6 s
r c C s* t | tkr| S |du rt }| |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. _asFilesystemTextJ s
r c C s$ t | tkr t||dS t||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 )r r r r )r- newpathr r+ r+ r. r[ _ s r[ c @ s e Zd ZU dZdZdZeeef e d< dyddZ
dd Z e d d
Z
dzd d Zdzd
dZdzddZdzddZdd Zdd Zdd Zdd Zdd Zd d Zd d Zd!d" Zd{d$ed%ee fd&d'Zd|d)d*Z d+d, Z d-d. Z d/d0 Z d1d2 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%efdUdVZ2dWdX Z3dYdZ Z4dyd[d\Z5d]d^ Z6d_d` Z7dadb Z8dcdd Z9d}dfdgZ:dhdi Z;djdk ZddrdsZ?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- Fc C s t || _|| _dS )z
Convert a path string to an absolute path if necessary and initialize
the L{FilePath} with the result.
N)r r- alwaysCreate)rU r- r r+ r+ r. rV s
zFilePath.__init__c C s | j }d|v r |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 C s t | jtjS )z
Return a filesystem separator.
@return: The native filesystem separator.
@returntype: The same type as C{self.path}.
)r[ r- rq rK rg r+ r+ r. rK z FilePath.sepc C t | 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 )r r- rU r r+ r+ r. _asBytesPath zFilePath._asBytesPathc C r )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._asTextPathc C $ 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 )r r- r clonePathr r r+ r+ r. asBytesMode zFilePath.asBytesModec C r )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.asTextModec C s t |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.
)r r r r )rU patternr+ r+ r. _getPathAsSameTypeAs s z FilePath._getPathAsSameTypeAsc C s t |d}t |tj}| |}t r ||r t|dt|}||v r/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[ rq rK r r# isWindowscountrM r r joinpathrs r )rU r- colonrK ourPathnormr r+ r+ r. r4 s
zFilePath.childc C sB | |}tt|t|}||s t| 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 r r r rs rM r )rU r- r r r+ r+ r. preauthChild
s
zFilePath.preauthChildc G s8 |D ]}| |}t||}t|r| | S qdS )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 r r )rU pathsr4 r| jpr+ r+ r. childSearchPreauth s
zFilePath.childSearchPreauthc G s |D ]P}|s| r| S | |}t|d}t|d}||krCt|| }tt|D ]}||rB| tt|| S q-|| }t |rR| | S qdS )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) r r r[ r r r rs r r ) rU extsextr| stardotbasedotfnp2r+ r+ r. siblingExtensionSearch2 s"
z FilePath.siblingExtensionSearchc C s6 | 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)r0 rq r- rr rP r )rU resultr+ r+ r. rr P s
zFilePath.realpathc C s | |}| || 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 )rU r r r+ r+ r. siblingExtensioni s
zFilePath.siblingExtensionc C s t | j|j dS )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. linkTov s
zFilePath.linkTor6 r7 r c C s: | j rd|vs J d| 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 == Truebr )r createreplacer8 r- rU r7 r+ r+ r. r8 s
z
FilePath.openTc C s4 z t | j| _W dS ty d| _|r Y dS w )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)r r- r rW )rU reraiser+ r+ r. restat s zFilePath.restatc C s
d| _ dS )zl
Clear any cached information about the state of this path on disk.
@since: 10.1.0
N)r rg r+ r+ r. r9 s
zFilePath.changedc C s t | 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)rq chmodr- r r+ r+ r. r s zFilePath.chmodc C s | 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_sizerU str+ r+ r. r: s
zFilePath.getsizec C " | j }|s | | j }t|jS )r; )r r floatst_mtimer r+ r+ r. r<
z FilePath.getModificationTimec C r )r= )r r r st_ctimer r+ r+ r. r> r z FilePath.getStatusChangeTimec C r )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 C r )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 C r )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 z FilePath.getNumberOfHardLinksc C r )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 C r )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.
getGroupIDO r zFilePath.getGroupIDc C s& | 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
)r r r r
st_moder r+ r+ r. getPermissionsb s
zFilePath.getPermissionsc C s" | j rdS | d | j rdS dS )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 rg r+ r+ r. r q s
zFilePath.existsc C , | j }|s| d | j }|sdS t|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)r r r r r r+ r+ r. rA
zFilePath.isdirc C r )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 r r r r+ r+ r. rB r zFilePath.isfilec C r )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 r r r r+ r+ r.
isBlockDevice r zFilePath.isBlockDevicec C r )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 r r r r+ r+ r. isSocket r zFilePath.isSocketc C
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}
)r0 r- rg r+ r+ r. r0
zFilePath.islinkc C r )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- rg r+ r+ r. r
zFilePath.isabsc C r )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.
)r r- rg r+ r+ r. r r
zFilePath.listdirc C r )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- rg r+ r+ r. r r zFilePath.splitextc C s d| j dS )Nz FilePath()r, rg r+ r+ r. r s zFilePath.__repr__c C s6 z | d W n ty Y nw t| 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 closerW r r- rg r+ r+ r. touch s zFilePath.touchc C sL | r| s| D ]}| q t| j nt| 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)rA r0 rC removerq rmdirr- r9 )rU r4 r+ r+ r. r s
zFilePath.removec
C sP zt | jW S ty' } z|jtjkr|r| s W Y d}~dS d}~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)rq makedirsr- rW rk EEXISTrA )rU ignoreExistingDirectoryer+ r+ r. r s zFilePath.makedirsc sX t |tj} |}ddl}|d |kr|| p |||g} fdd||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 Nc rd r+ )r )rf r| rg r+ r. rh 8 ri z)FilePath.globChildren..)r[ rq rK r globr
)rU r rK r r r- r+ rg r. globChildren' s
"zFilePath.globChildrenc C r )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
)r r- rg r+ r+ r. r : r zFilePath.basenamec C r )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
)r r- rg r+ r+ r. r E r zFilePath.dirnamec C s | | 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 r rg r+ r+ r. rD P r zFilePath.parent .newc C st | |}|d
}|| W d n1 sw Y t r.t| jr.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}.
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) temporarySiblingr8 r r# r r r- rq unlinkrenamer )rU contentr sibr{ r+ r+ r.
setContentZ s
- zFilePath.setContentc C s t |tstS t| j|jS r )r r NotImplementedr! r- )rU r r+ r+ r. __cmp__ s
zFilePath.__cmp__c C s t | j dS )z
Create the directory the L{FilePath} refers to.
@see: L{makedirs}
@raise OSError: If the directory cannot be created.
N)rq mkdirr- rg r+ r+ r. createDirectory s zFilePath.createDirectoryr c C s
|| _ 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 )rU r r+ r+ r.
requireCreate s
zFilePath.requireCreatec C s$ t | jt}ttt t |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)rq r8 r-
_CREATE_FLAGSr r r fdopen)rU fdintr+ r+ r. r s zFilePath.create c C s6 | |}| 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 rE r] r r r# )rU extensionr r r+ r+ r. r s
zFilePath.temporarySiblingi c C s | r|stt| j|j dS | r5| s | | D ]}| |
}| || q#dS | r|
d:}|
} || j}|| t|| jk rXnqEW d n1 scw Y W d dS W d dS 1 s{w Y dS | 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
Nr r zNo such file or directoryz/Only copying of files and directories supported)r0 rq r readlinkr- rA r r" rC r4 r copyTorB r8 r_
_chunkSizer lenrW rk rl r )rU destination followLinksr4 destChild writefilereadfilechunkr+ r+ r. r* s. %
P zFilePath.copyToc
C s z
t | |j|j W n9 tyF } z-|jtjkr:| }| || | || | }| || |
n W Y d}~dS d}~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) rq r r r- rW rk EXDEVr r* moveTor r9 )rU r- r. ro secsibmysecsibr+ r+ r. r4 s
zFilePath.moveTo)Fr rF )T)r )r )r' )CrG rH rI rJ r r- r r r __annotations__rV r propertyrK r r r r r r4 r r r rr r r r r8 r r9 r r: r< r> r@ r r r r r r r rA rB r r r0 r r r r r r r r r r rD r r r" r# r r r+ r* r4 r+ r+ r+ r. r m sx
!
4
Gr )r r )RrJ base64rk rq r r r r os.pathr r r r r r
r r r r
r r r r r r r r r r r r r typingr r r zope.interfacer r r twisted.python.compatr! r" twisted.python.runtimer# twisted.python.utilr$ twisted.python.win32r% r& r' r( r) O_EXCLO_CREATO_RDWRr$ r/ rj r- r0 urandomrZ urlsafe_b64encoderY r1 ExceptionrM rP rW rQ r] r^ r r r r r r r[ r r r+ r+ r+ r. sV (@
E2 ,
a