Function extractall

gdown/extractall.py:17–51

Extract archive file. Parameters ---------- path: Path of archive file to be extracted. to: Directory to which the archive file will be extracted. If None, it will be set to the parent directory of the archive file. Raises ------ ValueError

(path: str, to: str | None = None)

def extractall(path: str, to: str | None = None) -> list[str]:
    """Extract archive file.

    Parameters
    ----------
    path:
        Path of archive file to be extracted.
    to:
        Directory to which the archive file will be extracted.
        If None, it will be set to the parent directory of the archive file.

    Raises
    ------
    ValueError
        If the archive format is unsupported, or if an archive member would
        extract outside the target directory.
    """
    if to is None:
        to = osp.dirname(path)

    if path.endswith(".zip"):
        return _extractall_zip(path=path, to=to)

    if path.endswith(".tar"):
        tar_mode = "r"
    elif path.endswith(".tar.gz") or path.endswith(".tgz"):
        tar_mode = "r:gz"
    elif path.endswith(".tar.bz2") or path.endswith(".tbz"):
        tar_mode = "r:bz2"
    else:
        raise ValueError(
            f"Could not extract '{path}' as no appropriate extractor is found"
        )

    return _extractall_tar(path=path, to=to, tar_mode=tar_mode)


def _extractall_zip(path: str, to: str) -> list[str]: