class documentation

I represent a file or directory contained within a zip file.

Method __cmp__ Undocumented
Method __init__ Don't construct me directly. Use ZipArchive.child().
Method __repr__ Undocumented
Method basename Subclasses must implement this.
Method changed Clear any cached information about the state of this path on disk.
Method child Return a new ZipPath representing a path in self.archive which is a child of this path.
Method dirname Undocumented
Method exists Check if this file path exists.
Method getAccessTime Retrieve this file's last access-time. This is the same as the last access time for the archive.
Method getModificationTime Retrieve this file's last modification time. This is the time of modification recorded in the zipfile.
Method getsize Retrieve this file's size.
Method getStatusChangeTime Retrieve this file's last modification time. This name is provided for compatibility, and returns the same value as getmtime.
Method isdir Subclasses must implement this.
Method isfile Check if this file path refers to a regular file.
Method islink Undocumented
Method listdir Subclasses must implement this.
Method open Subclasses must implement this.
Method parent Subclasses must implement this.
Method parents Retrieve an iterator of all the ancestors of this path.
Method sibling Return a FilePath with the same directory as this instance but with a basename of path.
Method splitext Return a value similar to that returned by os.path.splitext.
Instance Variable archive Undocumented
Instance Variable path Undocumented
Instance Variable pathInArchive Undocumented
Property sep Return a zip directory separator.
Method _nativeParent Return parent, discarding our own encoding in favor of whatever the archive's is.
Instance Variable _nativePathInArchive Undocumented

Inherited from AbstractFilePath:

Method __hash__ Hash the same as another AbstractFilePath with the same path as mine.
Method children List the children of this path object.
Method descendant Retrieve a child or child's child of this path.
Method getatime Deprecated. Use getAccessTime instead.
Method getContent Retrieve the contents of the file at this path.
Method getctime Deprecated. Use getStatusChangeTime instead.
Method getmtime Deprecated. Use getModificationTime instead.
Method segmentsFrom Return a list of segments between a child and its ancestor.
Method walk Yield myself, then each of my children, and each of those children's children in turn.
Type Variable Selfish Undocumented
def __cmp__(self, other: object) -> int: (source)

Undocumented

def __init__(self, archive: ZipArchive[_ArchiveStr], pathInArchive: _ZipStr): (source)

Don't construct me directly. Use ZipArchive.child().

Parameters
archive:ZipArchive[_ArchiveStr]a ZipArchive instance.
pathInArchive:_ZipStra ZIP_PATH_SEP-separated string.
def __repr__(self) -> str: (source)

Undocumented

def changed(self): (source)

Clear any cached information about the state of this path on disk.

Return a new ZipPath representing a path in self.archive which is a child of this path.

Note
Requesting the ".." (or other special name) child will not cause InsecurePath to be raised since these names do not have any special meaning inside a zip archive. Be particularly careful with the path attribute (if you absolutely must use it) as this means it may include special names with special meaning outside of the context of a zip archive.
def dirname(self) -> _ZipStr: (source)

Undocumented

def exists(self) -> bool: (source)

Check if this file path exists.

Returns
boolTrue if the file at this file path exists, False otherwise.
def getAccessTime(self) -> float: (source)

Retrieve this file's last access-time. This is the same as the last access time for the archive.

Returns
floata number of seconds since the epoch
def getModificationTime(self) -> float: (source)

Retrieve this file's last modification time. This is the time of modification recorded in the zipfile.

Returns
floata number of seconds since the epoch.
def getsize(self) -> int: (source)

Retrieve this file's size.

Returns
intfile size, in bytes
def getStatusChangeTime(self) -> float: (source)

Retrieve this file's last modification time. This name is provided for compatibility, and returns the same value as getmtime.

Returns
floata number of seconds since the epoch.
def isdir(self) -> bool: (source)
def isfile(self) -> bool: (source)

Check if this file path refers to a regular file.

Returns
boolTrue if the file at this file path is a regular file, False otherwise.
def islink(self) -> bool: (source)

Undocumented

def listdir(self) -> List[_ZipStr]: (source)

Subclasses must implement this.

def open(self, mode: Literal['r', 'w'] = 'r') -> IO[bytes]: (source)

Retrieve an iterator of all the ancestors of this path.

Returns
Iterable[Union[ZipPath[_ZipStr, _ArchiveStr], ZipArchive[_ZipStr]]]an iterator of all the ancestors of this path, from the most recent (its immediate parent) to the root of its filesystem.

Return a FilePath with the same directory as this instance but with a basename of path.

Parameters
path:strThe basename of the FilePath to return.
Returns
FilePathThe sibling path.
Note
for type-checking, subclasses should override this signature to make it clear that it returns the subclass and not AbstractFilePath.
def splitext(self) -> Tuple[_ZipStr, _ZipStr]: (source)

Return a value similar to that returned by os.path.splitext.

pathInArchive: _ZipStr = (source)

Undocumented

Return a zip directory separator.

Returns
The same type as self.path.Undocumented

Return parent, discarding our own encoding in favor of whatever the archive's is.

_nativePathInArchive: _ArchiveStr = (source)

Undocumented