mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-08 21:14:48 +08:00
366 lines
12 KiB
Python
366 lines
12 KiB
Python
import bz2
|
|
import io
|
|
import sys
|
|
from _typeshed import StrOrBytesPath, StrPath
|
|
from collections.abc import Callable, Iterable, Iterator, Mapping
|
|
from gzip import _ReadableFileobj as _GzipReadableFileobj, _WritableFileobj as _GzipWritableFileobj
|
|
from types import TracebackType
|
|
from typing import IO, Dict, List, Optional, Protocol, Set, Tuple, Type, Union, overload
|
|
from typing_extensions import Literal
|
|
|
|
class _Fileobj(Protocol):
|
|
def read(self, __size: int) -> bytes: ...
|
|
def write(self, __b: bytes) -> object: ...
|
|
def tell(self) -> int: ...
|
|
def seek(self, __pos: int) -> object: ...
|
|
def close(self) -> object: ...
|
|
# Optional fields:
|
|
# name: str | bytes
|
|
# mode: Literal["rb", "r+b", "wb", "xb"]
|
|
|
|
class _Bz2ReadableFileobj(bz2._ReadableFileobj):
|
|
def close(self) -> object: ...
|
|
|
|
class _Bz2WritableFileobj(bz2._WritableFileobj):
|
|
def close(self) -> object: ...
|
|
|
|
# tar constants
|
|
NUL: bytes
|
|
BLOCKSIZE: int
|
|
RECORDSIZE: int
|
|
GNU_MAGIC: bytes
|
|
POSIX_MAGIC: bytes
|
|
|
|
LENGTH_NAME: int
|
|
LENGTH_LINK: int
|
|
LENGTH_PREFIX: int
|
|
|
|
REGTYPE: bytes
|
|
AREGTYPE: bytes
|
|
LNKTYPE: bytes
|
|
SYMTYPE: bytes
|
|
CONTTYPE: bytes
|
|
BLKTYPE: bytes
|
|
DIRTYPE: bytes
|
|
FIFOTYPE: bytes
|
|
CHRTYPE: bytes
|
|
|
|
GNUTYPE_LONGNAME: bytes
|
|
GNUTYPE_LONGLINK: bytes
|
|
GNUTYPE_SPARSE: bytes
|
|
|
|
XHDTYPE: bytes
|
|
XGLTYPE: bytes
|
|
SOLARIS_XHDTYPE: bytes
|
|
|
|
USTAR_FORMAT: int
|
|
GNU_FORMAT: int
|
|
PAX_FORMAT: int
|
|
DEFAULT_FORMAT: int
|
|
|
|
# tarfile constants
|
|
|
|
SUPPORTED_TYPES: Tuple[bytes, ...]
|
|
REGULAR_TYPES: Tuple[bytes, ...]
|
|
GNU_TYPES: Tuple[bytes, ...]
|
|
PAX_FIELDS: Tuple[str, ...]
|
|
PAX_NUMBER_FIELDS: Dict[str, type]
|
|
PAX_NAME_FIELDS: Set[str]
|
|
|
|
ENCODING: str
|
|
|
|
def open(
|
|
name: Optional[StrOrBytesPath] = ...,
|
|
mode: str = ...,
|
|
fileobj: Optional[IO[bytes]] = ..., # depends on mode
|
|
bufsize: int = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
errors: str = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
compresslevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
|
|
class ExFileObject(io.BufferedReader):
|
|
def __init__(self, tarfile: TarFile, tarinfo: TarInfo) -> None: ...
|
|
|
|
class TarFile:
|
|
OPEN_METH: Mapping[str, str]
|
|
name: Optional[StrOrBytesPath]
|
|
mode: Literal["r", "a", "w", "x"]
|
|
fileobj: Optional[_Fileobj]
|
|
format: Optional[int]
|
|
tarinfo: Type[TarInfo]
|
|
dereference: Optional[bool]
|
|
ignore_zeros: Optional[bool]
|
|
encoding: Optional[str]
|
|
errors: str
|
|
fileobject: Type[ExFileObject]
|
|
pax_headers: Optional[Mapping[str, str]]
|
|
debug: Optional[int]
|
|
errorlevel: Optional[int]
|
|
offset: int # undocumented
|
|
def __init__(
|
|
self,
|
|
name: Optional[StrOrBytesPath] = ...,
|
|
mode: Literal["r", "a", "w", "x"] = ...,
|
|
fileobj: Optional[_Fileobj] = ...,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
errors: str = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
copybufsize: Optional[int] = ..., # undocumented
|
|
) -> None: ...
|
|
def __enter__(self) -> TarFile: ...
|
|
def __exit__(
|
|
self, exc_type: Optional[Type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType]
|
|
) -> None: ...
|
|
def __iter__(self) -> Iterator[TarInfo]: ...
|
|
@classmethod
|
|
def open(
|
|
cls,
|
|
name: Optional[StrOrBytesPath] = ...,
|
|
mode: str = ...,
|
|
fileobj: Optional[IO[bytes]] = ..., # depends on mode
|
|
bufsize: int = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
errors: str = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
@classmethod
|
|
def taropen(
|
|
cls,
|
|
name: Optional[StrOrBytesPath],
|
|
mode: Literal["r", "a", "w", "x"] = ...,
|
|
fileobj: Optional[_Fileobj] = ...,
|
|
*,
|
|
compresslevel: int = ...,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
@overload
|
|
@classmethod
|
|
def gzopen(
|
|
cls,
|
|
name: Optional[StrOrBytesPath],
|
|
mode: Literal["r"] = ...,
|
|
fileobj: Optional[_GzipReadableFileobj] = ...,
|
|
compresslevel: int = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
@overload
|
|
@classmethod
|
|
def gzopen(
|
|
cls,
|
|
name: Optional[StrOrBytesPath],
|
|
mode: Literal["w", "x"],
|
|
fileobj: Optional[_GzipWritableFileobj] = ...,
|
|
compresslevel: int = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
@overload
|
|
@classmethod
|
|
def bz2open(
|
|
cls,
|
|
name: Optional[StrOrBytesPath],
|
|
mode: Literal["w", "x"],
|
|
fileobj: Optional[_Bz2WritableFileobj] = ...,
|
|
compresslevel: int = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
@overload
|
|
@classmethod
|
|
def bz2open(
|
|
cls,
|
|
name: Optional[StrOrBytesPath],
|
|
mode: Literal["r"] = ...,
|
|
fileobj: Optional[_Bz2ReadableFileobj] = ...,
|
|
compresslevel: int = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
@classmethod
|
|
def xzopen(
|
|
cls,
|
|
name: Optional[StrOrBytesPath],
|
|
mode: Literal["r", "w", "x"] = ...,
|
|
fileobj: Optional[IO[bytes]] = ...,
|
|
preset: Optional[int] = ...,
|
|
*,
|
|
format: Optional[int] = ...,
|
|
tarinfo: Optional[Type[TarInfo]] = ...,
|
|
dereference: Optional[bool] = ...,
|
|
ignore_zeros: Optional[bool] = ...,
|
|
encoding: Optional[str] = ...,
|
|
pax_headers: Optional[Mapping[str, str]] = ...,
|
|
debug: Optional[int] = ...,
|
|
errorlevel: Optional[int] = ...,
|
|
) -> TarFile: ...
|
|
def getmember(self, name: str) -> TarInfo: ...
|
|
def getmembers(self) -> List[TarInfo]: ...
|
|
def getnames(self) -> List[str]: ...
|
|
def list(self, verbose: bool = ..., *, members: Optional[List[TarInfo]] = ...) -> None: ...
|
|
def next(self) -> Optional[TarInfo]: ...
|
|
def extractall(
|
|
self, path: StrOrBytesPath = ..., members: Optional[Iterable[TarInfo]] = ..., *, numeric_owner: bool = ...
|
|
) -> None: ...
|
|
def extract(
|
|
self, member: Union[str, TarInfo], path: StrOrBytesPath = ..., set_attrs: bool = ..., *, numeric_owner: bool = ...
|
|
) -> None: ...
|
|
def extractfile(self, member: Union[str, TarInfo]) -> Optional[IO[bytes]]: ...
|
|
def makedir(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def makefile(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def makeunknown(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def makefifo(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def makedev(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def makelink(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def chown(self, tarinfo: TarInfo, targetpath: StrOrBytesPath, numeric_owner: bool) -> None: ... # undocumented
|
|
def chmod(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
def utime(self, tarinfo: TarInfo, targetpath: StrOrBytesPath) -> None: ... # undocumented
|
|
if sys.version_info >= (3, 7):
|
|
def add(
|
|
self,
|
|
name: StrPath,
|
|
arcname: Optional[StrPath] = ...,
|
|
recursive: bool = ...,
|
|
*,
|
|
filter: Optional[Callable[[TarInfo], Optional[TarInfo]]] = ...,
|
|
) -> None: ...
|
|
else:
|
|
def add(
|
|
self,
|
|
name: StrPath,
|
|
arcname: Optional[StrPath] = ...,
|
|
recursive: bool = ...,
|
|
exclude: Optional[Callable[[str], bool]] = ...,
|
|
*,
|
|
filter: Optional[Callable[[TarInfo], Optional[TarInfo]]] = ...,
|
|
) -> None: ...
|
|
def addfile(self, tarinfo: TarInfo, fileobj: Optional[IO[bytes]] = ...) -> None: ...
|
|
def gettarinfo(
|
|
self, name: Optional[str] = ..., arcname: Optional[str] = ..., fileobj: Optional[IO[bytes]] = ...
|
|
) -> TarInfo: ...
|
|
def close(self) -> None: ...
|
|
|
|
if sys.version_info >= (3, 9):
|
|
def is_tarfile(name: Union[StrOrBytesPath, IO[bytes]]) -> bool: ...
|
|
|
|
else:
|
|
def is_tarfile(name: StrOrBytesPath) -> bool: ...
|
|
|
|
if sys.version_info < (3, 8):
|
|
def filemode(mode: int) -> str: ... # undocumented
|
|
|
|
class TarError(Exception): ...
|
|
class ReadError(TarError): ...
|
|
class CompressionError(TarError): ...
|
|
class StreamError(TarError): ...
|
|
class ExtractError(TarError): ...
|
|
class HeaderError(TarError): ...
|
|
|
|
class TarInfo:
|
|
name: str
|
|
path: str
|
|
size: int
|
|
mtime: int
|
|
chksum: int
|
|
devmajor: int
|
|
devminor: int
|
|
offset: int
|
|
offset_data: int
|
|
sparse: Optional[bytes]
|
|
tarfile: Optional[TarFile]
|
|
mode: int
|
|
type: bytes
|
|
linkname: str
|
|
uid: int
|
|
gid: int
|
|
uname: str
|
|
gname: str
|
|
pax_headers: Mapping[str, str]
|
|
def __init__(self, name: str = ...) -> None: ...
|
|
@classmethod
|
|
def frombuf(cls, buf: bytes, encoding: str, errors: str) -> TarInfo: ...
|
|
@classmethod
|
|
def fromtarfile(cls, tarfile: TarFile) -> TarInfo: ...
|
|
@property
|
|
def linkpath(self) -> str: ...
|
|
@linkpath.setter
|
|
def linkpath(self, linkname: str) -> None: ...
|
|
def get_info(self) -> Mapping[str, Union[str, int, bytes, Mapping[str, str]]]: ...
|
|
def tobuf(self, format: Optional[int] = ..., encoding: Optional[str] = ..., errors: str = ...) -> bytes: ...
|
|
def create_ustar_header(
|
|
self, info: Mapping[str, Union[str, int, bytes, Mapping[str, str]]], encoding: str, errors: str
|
|
) -> bytes: ...
|
|
def create_gnu_header(
|
|
self, info: Mapping[str, Union[str, int, bytes, Mapping[str, str]]], encoding: str, errors: str
|
|
) -> bytes: ...
|
|
def create_pax_header(self, info: Mapping[str, Union[str, int, bytes, Mapping[str, str]]], encoding: str) -> bytes: ...
|
|
@classmethod
|
|
def create_pax_global_header(cls, pax_headers: Mapping[str, str]) -> bytes: ...
|
|
def isfile(self) -> bool: ...
|
|
def isreg(self) -> bool: ...
|
|
def issparse(self) -> bool: ...
|
|
def isdir(self) -> bool: ...
|
|
def issym(self) -> bool: ...
|
|
def islnk(self) -> bool: ...
|
|
def ischr(self) -> bool: ...
|
|
def isblk(self) -> bool: ...
|
|
def isfifo(self) -> bool: ...
|
|
def isdev(self) -> bool: ...
|