mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-07 20:54:28 +08:00
358 lines
14 KiB
Python
358 lines
14 KiB
Python
import os
|
|
import sys
|
|
from _typeshed import Self
|
|
from types import TracebackType
|
|
from typing import IO, Any, AnyStr, Generic, Iterable, Iterator, List, Optional, Tuple, Type, Union, overload
|
|
from typing_extensions import Literal
|
|
|
|
if sys.version_info >= (3, 9):
|
|
from types import GenericAlias
|
|
|
|
# global variables
|
|
TMP_MAX: int
|
|
tempdir: Optional[str]
|
|
template: str
|
|
|
|
_DirT = Union[AnyStr, os.PathLike[AnyStr]]
|
|
|
|
if sys.version_info >= (3, 8):
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"],
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
delete: bool = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> _TemporaryFileWrapper[str]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
delete: bool = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> _TemporaryFileWrapper[bytes]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: str = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
delete: bool = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> _TemporaryFileWrapper[Any]: ...
|
|
|
|
else:
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"],
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
delete: bool = ...,
|
|
) -> _TemporaryFileWrapper[str]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
delete: bool = ...,
|
|
) -> _TemporaryFileWrapper[bytes]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: str = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
delete: bool = ...,
|
|
) -> _TemporaryFileWrapper[Any]: ...
|
|
|
|
if sys.platform == "win32":
|
|
TemporaryFile = NamedTemporaryFile
|
|
else:
|
|
if sys.version_info >= (3, 8):
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"],
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> IO[str]: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> IO[bytes]: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: str = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> IO[Any]: ...
|
|
else:
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"],
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
) -> IO[str]: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
) -> IO[bytes]: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: str = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[AnyStr] = ...,
|
|
prefix: Optional[AnyStr] = ...,
|
|
dir: Optional[_DirT[AnyStr]] = ...,
|
|
) -> IO[Any]: ...
|
|
|
|
class _TemporaryFileWrapper(Generic[AnyStr], IO[AnyStr]):
|
|
file: IO[AnyStr] # io.TextIOWrapper, io.BufferedReader or io.BufferedWriter
|
|
name: str
|
|
delete: bool
|
|
def __init__(self, file: IO[AnyStr], name: str, delete: bool = ...) -> None: ...
|
|
def __enter__(self: Self) -> Self: ...
|
|
def __exit__(
|
|
self, exc: Optional[Type[BaseException]], value: Optional[BaseException], tb: Optional[TracebackType]
|
|
) -> Optional[bool]: ...
|
|
def __getattr__(self, name: str) -> Any: ...
|
|
def close(self) -> None: ...
|
|
# These methods don't exist directly on this object, but
|
|
# are delegated to the underlying IO object through __getattr__.
|
|
# We need to add them here so that this class is concrete.
|
|
def __iter__(self) -> Iterator[AnyStr]: ...
|
|
# FIXME: __next__ doesn't actually exist on this class and should be removed:
|
|
# see also https://github.com/python/typeshed/pull/5456#discussion_r633068648
|
|
# >>> import tempfile
|
|
# >>> ntf=tempfile.NamedTemporaryFile()
|
|
# >>> next(ntf)
|
|
# Traceback (most recent call last):
|
|
# File "<stdin>", line 1, in <module>
|
|
# TypeError: '_TemporaryFileWrapper' object is not an iterator
|
|
def __next__(self) -> AnyStr: ...
|
|
def fileno(self) -> int: ...
|
|
def flush(self) -> None: ...
|
|
def isatty(self) -> bool: ...
|
|
def read(self, n: int = ...) -> AnyStr: ...
|
|
def readable(self) -> bool: ...
|
|
def readline(self, limit: int = ...) -> AnyStr: ...
|
|
def readlines(self, hint: int = ...) -> list[AnyStr]: ...
|
|
def seek(self, offset: int, whence: int = ...) -> int: ...
|
|
def seekable(self) -> bool: ...
|
|
def tell(self) -> int: ...
|
|
def truncate(self, size: Optional[int] = ...) -> int: ...
|
|
def writable(self) -> bool: ...
|
|
def write(self, s: AnyStr) -> int: ...
|
|
def writelines(self, lines: Iterable[AnyStr]) -> None: ...
|
|
|
|
# It does not actually derive from IO[AnyStr], but it does implement the
|
|
# protocol.
|
|
class SpooledTemporaryFile(IO[AnyStr]):
|
|
@property
|
|
def encoding(self) -> str: ... # undocumented
|
|
@property
|
|
def newlines(self) -> str | Tuple[str, ...] | None: ... # undocumented
|
|
# bytes needs to go first, as default mode is to open as bytes
|
|
if sys.version_info >= (3, 8):
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[bytes],
|
|
max_size: int = ...,
|
|
mode: Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ...,
|
|
dir: Optional[str] = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[str],
|
|
max_size: int = ...,
|
|
mode: Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ...,
|
|
dir: Optional[str] = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self,
|
|
max_size: int = ...,
|
|
mode: str = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ...,
|
|
dir: Optional[str] = ...,
|
|
*,
|
|
errors: Optional[str] = ...,
|
|
) -> None: ...
|
|
@property
|
|
def errors(self) -> Optional[str]: ...
|
|
else:
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[bytes],
|
|
max_size: int = ...,
|
|
mode: Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ...,
|
|
dir: Optional[str] = ...,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[str],
|
|
max_size: int = ...,
|
|
mode: Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"] = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ...,
|
|
dir: Optional[str] = ...,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self,
|
|
max_size: int = ...,
|
|
mode: str = ...,
|
|
buffering: int = ...,
|
|
encoding: Optional[str] = ...,
|
|
newline: Optional[str] = ...,
|
|
suffix: Optional[str] = ...,
|
|
prefix: Optional[str] = ...,
|
|
dir: Optional[str] = ...,
|
|
) -> None: ...
|
|
def rollover(self) -> None: ...
|
|
def __enter__(self: Self) -> Self: ...
|
|
def __exit__(
|
|
self, exc_type: Optional[Type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType]
|
|
) -> Optional[bool]: ...
|
|
# These methods are copied from the abstract methods of IO, because
|
|
# SpooledTemporaryFile implements IO.
|
|
# See also https://github.com/python/typeshed/pull/2452#issuecomment-420657918.
|
|
def close(self) -> None: ...
|
|
def fileno(self) -> int: ...
|
|
def flush(self) -> None: ...
|
|
def isatty(self) -> bool: ...
|
|
def read(self, n: int = ...) -> AnyStr: ...
|
|
def readline(self, limit: int = ...) -> AnyStr: ...
|
|
def readlines(self, hint: int = ...) -> List[AnyStr]: ...
|
|
def seek(self, offset: int, whence: int = ...) -> int: ...
|
|
def tell(self) -> int: ...
|
|
def truncate(self, size: Optional[int] = ...) -> int: ...
|
|
def write(self, s: AnyStr) -> int: ...
|
|
def writelines(self, iterable: Iterable[AnyStr]) -> None: ...
|
|
def __iter__(self) -> Iterator[AnyStr]: ...
|
|
# Other than the following methods, which do not exist on SpooledTemporaryFile
|
|
def readable(self) -> bool: ...
|
|
def seekable(self) -> bool: ...
|
|
def writable(self) -> bool: ...
|
|
def __next__(self) -> AnyStr: ...
|
|
if sys.version_info >= (3, 9):
|
|
def __class_getitem__(cls, item: Any) -> GenericAlias: ...
|
|
|
|
class TemporaryDirectory(Generic[AnyStr]):
|
|
name: AnyStr
|
|
@overload
|
|
def __init__(self: TemporaryDirectory[str], suffix: None = ..., prefix: None = ..., dir: None = ...) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self, suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ..., dir: Optional[_DirT[AnyStr]] = ...
|
|
) -> None: ...
|
|
def cleanup(self) -> None: ...
|
|
def __enter__(self) -> AnyStr: ...
|
|
def __exit__(
|
|
self, exc_type: Optional[Type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType]
|
|
) -> None: ...
|
|
if sys.version_info >= (3, 9):
|
|
def __class_getitem__(cls, item: Any) -> GenericAlias: ...
|
|
|
|
@overload
|
|
def mkstemp() -> Tuple[int, str]: ...
|
|
@overload
|
|
def mkstemp(
|
|
suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ..., dir: Optional[_DirT[AnyStr]] = ..., text: bool = ...
|
|
) -> Tuple[int, AnyStr]: ...
|
|
@overload
|
|
def mkdtemp() -> str: ...
|
|
@overload
|
|
def mkdtemp(suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ..., dir: Optional[_DirT[AnyStr]] = ...) -> AnyStr: ...
|
|
@overload
|
|
def mktemp() -> str: ...
|
|
@overload
|
|
def mktemp(suffix: Optional[AnyStr] = ..., prefix: Optional[AnyStr] = ..., dir: Optional[_DirT[AnyStr]] = ...) -> AnyStr: ...
|
|
def gettempdirb() -> bytes: ...
|
|
def gettempprefixb() -> bytes: ...
|
|
def gettempdir() -> str: ...
|
|
def gettempprefix() -> str: ...
|