mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-07 04:34:28 +08:00
61ed105cdb
The following code errors at runtime: ```python import tempfile with tempfile.NamedTemporaryFile() as f: f.write(s=b"") ``` ``` TypeError: BufferedRandom.write() takes no keyword arguments ```
484 lines
16 KiB
Python
484 lines
16 KiB
Python
import io
|
|
import sys
|
|
from _typeshed import (
|
|
BytesPath,
|
|
GenericPath,
|
|
OpenBinaryMode,
|
|
OpenBinaryModeReading,
|
|
OpenBinaryModeUpdating,
|
|
OpenBinaryModeWriting,
|
|
OpenTextMode,
|
|
ReadableBuffer,
|
|
StrPath,
|
|
WriteableBuffer,
|
|
)
|
|
from collections.abc import Iterable, Iterator
|
|
from types import TracebackType
|
|
from typing import IO, Any, AnyStr, Generic, Literal, overload
|
|
from typing_extensions import Self
|
|
|
|
if sys.version_info >= (3, 9):
|
|
from types import GenericAlias
|
|
|
|
__all__ = [
|
|
"NamedTemporaryFile",
|
|
"TemporaryFile",
|
|
"SpooledTemporaryFile",
|
|
"TemporaryDirectory",
|
|
"mkstemp",
|
|
"mkdtemp",
|
|
"mktemp",
|
|
"TMP_MAX",
|
|
"gettempprefix",
|
|
"tempdir",
|
|
"gettempdir",
|
|
"gettempprefixb",
|
|
"gettempdirb",
|
|
]
|
|
|
|
# global variables
|
|
TMP_MAX: int
|
|
tempdir: str | None
|
|
template: str
|
|
|
|
if sys.version_info >= (3, 12):
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: OpenTextMode,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
delete: bool = True,
|
|
*,
|
|
errors: str | None = None,
|
|
delete_on_close: bool = True,
|
|
) -> _TemporaryFileWrapper[str]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: OpenBinaryMode = "w+b",
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
delete: bool = True,
|
|
*,
|
|
errors: str | None = None,
|
|
delete_on_close: bool = True,
|
|
) -> _TemporaryFileWrapper[bytes]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: str = "w+b",
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
delete: bool = True,
|
|
*,
|
|
errors: str | None = None,
|
|
delete_on_close: bool = True,
|
|
) -> _TemporaryFileWrapper[Any]: ...
|
|
|
|
else:
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: OpenTextMode,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
delete: bool = True,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> _TemporaryFileWrapper[str]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: OpenBinaryMode = "w+b",
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
delete: bool = True,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> _TemporaryFileWrapper[bytes]: ...
|
|
@overload
|
|
def NamedTemporaryFile(
|
|
mode: str = "w+b",
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
delete: bool = True,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> _TemporaryFileWrapper[Any]: ...
|
|
|
|
if sys.platform == "win32":
|
|
TemporaryFile = NamedTemporaryFile
|
|
else:
|
|
# See the comments for builtins.open() for an explanation of the overloads.
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: OpenTextMode,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> io.TextIOWrapper: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: OpenBinaryMode,
|
|
buffering: Literal[0],
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> io.FileIO: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
*,
|
|
buffering: Literal[0],
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
errors: str | None = None,
|
|
) -> io.FileIO: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: OpenBinaryModeWriting,
|
|
buffering: Literal[-1, 1] = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> io.BufferedWriter: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: OpenBinaryModeReading,
|
|
buffering: Literal[-1, 1] = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> io.BufferedReader: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: OpenBinaryModeUpdating = "w+b",
|
|
buffering: Literal[-1, 1] = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> io.BufferedRandom: ...
|
|
@overload
|
|
def TemporaryFile(
|
|
mode: str = "w+b",
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: AnyStr | None = None,
|
|
prefix: AnyStr | None = None,
|
|
dir: GenericPath[AnyStr] | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> IO[Any]: ...
|
|
|
|
class _TemporaryFileWrapper(IO[AnyStr]):
|
|
file: IO[AnyStr] # io.TextIOWrapper, io.BufferedReader or io.BufferedWriter
|
|
name: str
|
|
delete: bool
|
|
if sys.version_info >= (3, 12):
|
|
def __init__(self, file: IO[AnyStr], name: str, delete: bool = True, delete_on_close: bool = True) -> None: ...
|
|
else:
|
|
def __init__(self, file: IO[AnyStr], name: str, delete: bool = True) -> None: ...
|
|
|
|
def __enter__(self) -> Self: ...
|
|
def __exit__(self, exc: type[BaseException] | None, value: BaseException | None, tb: TracebackType | None) -> None: ...
|
|
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: int | None = ...) -> int: ...
|
|
def writable(self) -> bool: ...
|
|
@overload
|
|
def write(self: _TemporaryFileWrapper[str], s: str, /) -> int: ...
|
|
@overload
|
|
def write(self: _TemporaryFileWrapper[bytes], s: ReadableBuffer, /) -> int: ...
|
|
@overload
|
|
def write(self, s: AnyStr, /) -> int: ...
|
|
@overload
|
|
def writelines(self: _TemporaryFileWrapper[str], lines: Iterable[str]) -> None: ...
|
|
@overload
|
|
def writelines(self: _TemporaryFileWrapper[bytes], lines: Iterable[ReadableBuffer]) -> None: ...
|
|
@overload
|
|
def writelines(self, lines: Iterable[AnyStr]) -> None: ...
|
|
@property
|
|
def closed(self) -> bool: ...
|
|
|
|
if sys.version_info >= (3, 11):
|
|
_SpooledTemporaryFileBase = io.IOBase
|
|
else:
|
|
_SpooledTemporaryFileBase = object
|
|
|
|
# It does not actually derive from IO[AnyStr], but it does mostly behave
|
|
# like one.
|
|
class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
|
|
_file: 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
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[bytes],
|
|
max_size: int = 0,
|
|
mode: OpenBinaryMode = "w+b",
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: str | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[str],
|
|
max_size: int,
|
|
mode: OpenTextMode,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: str | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: SpooledTemporaryFile[str],
|
|
max_size: int = 0,
|
|
*,
|
|
mode: OpenTextMode,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: str | None = None,
|
|
errors: str | None = None,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self,
|
|
max_size: int,
|
|
mode: str,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: str | None = None,
|
|
*,
|
|
errors: str | None = None,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self,
|
|
max_size: int = 0,
|
|
*,
|
|
mode: str,
|
|
buffering: int = -1,
|
|
encoding: str | None = None,
|
|
newline: str | None = None,
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: str | None = None,
|
|
errors: str | None = None,
|
|
) -> None: ...
|
|
@property
|
|
def errors(self) -> str | None: ...
|
|
def rollover(self) -> None: ...
|
|
def __enter__(self) -> Self: ...
|
|
def __exit__(self, exc: type[BaseException] | None, value: BaseException | None, tb: TracebackType | None) -> None: ...
|
|
# 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: ...
|
|
if sys.version_info >= (3, 11):
|
|
# These three work only if the SpooledTemporaryFile is opened in binary mode,
|
|
# because the underlying object in text mode does not have these methods.
|
|
def read1(self, size: int = ..., /) -> AnyStr: ...
|
|
def readinto(self, b: WriteableBuffer) -> int: ...
|
|
def readinto1(self, b: WriteableBuffer) -> int: ...
|
|
def detach(self) -> io.RawIOBase: ...
|
|
|
|
def read(self, n: int = ..., /) -> AnyStr: ...
|
|
def readline(self, limit: int | None = ..., /) -> AnyStr: ... # type: ignore[override]
|
|
def readlines(self, hint: int = ..., /) -> list[AnyStr]: ... # type: ignore[override]
|
|
def seek(self, offset: int, whence: int = ...) -> int: ...
|
|
def tell(self) -> int: ...
|
|
if sys.version_info >= (3, 11):
|
|
def truncate(self, size: int | None = None) -> int: ...
|
|
else:
|
|
def truncate(self, size: int | None = None) -> None: ... # type: ignore[override]
|
|
|
|
@overload
|
|
def write(self: SpooledTemporaryFile[str], s: str) -> int: ...
|
|
@overload
|
|
def write(self: SpooledTemporaryFile[bytes], s: ReadableBuffer) -> int: ...
|
|
@overload
|
|
def write(self, s: AnyStr) -> int: ...
|
|
@overload
|
|
def writelines(self: SpooledTemporaryFile[str], iterable: Iterable[str]) -> None: ...
|
|
@overload
|
|
def writelines(self: SpooledTemporaryFile[bytes], iterable: Iterable[ReadableBuffer]) -> None: ...
|
|
@overload
|
|
def writelines(self, iterable: Iterable[AnyStr]) -> None: ...
|
|
def __iter__(self) -> Iterator[AnyStr]: ... # type: ignore[override]
|
|
# These exist at runtime only on 3.11+.
|
|
def readable(self) -> bool: ...
|
|
def seekable(self) -> bool: ...
|
|
def writable(self) -> bool: ...
|
|
def __next__(self) -> AnyStr: ... # type: ignore[override]
|
|
if sys.version_info >= (3, 9):
|
|
def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
|
|
|
|
class TemporaryDirectory(Generic[AnyStr]):
|
|
name: AnyStr
|
|
if sys.version_info >= (3, 12):
|
|
@overload
|
|
def __init__(
|
|
self: TemporaryDirectory[str],
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: StrPath | None = None,
|
|
ignore_cleanup_errors: bool = False,
|
|
*,
|
|
delete: bool = True,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: TemporaryDirectory[bytes],
|
|
suffix: bytes | None = None,
|
|
prefix: bytes | None = None,
|
|
dir: BytesPath | None = None,
|
|
ignore_cleanup_errors: bool = False,
|
|
*,
|
|
delete: bool = True,
|
|
) -> None: ...
|
|
elif sys.version_info >= (3, 10):
|
|
@overload
|
|
def __init__(
|
|
self: TemporaryDirectory[str],
|
|
suffix: str | None = None,
|
|
prefix: str | None = None,
|
|
dir: StrPath | None = None,
|
|
ignore_cleanup_errors: bool = False,
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: TemporaryDirectory[bytes],
|
|
suffix: bytes | None = None,
|
|
prefix: bytes | None = None,
|
|
dir: BytesPath | None = None,
|
|
ignore_cleanup_errors: bool = False,
|
|
) -> None: ...
|
|
else:
|
|
@overload
|
|
def __init__(
|
|
self: TemporaryDirectory[str], suffix: str | None = None, prefix: str | None = None, dir: StrPath | None = None
|
|
) -> None: ...
|
|
@overload
|
|
def __init__(
|
|
self: TemporaryDirectory[bytes],
|
|
suffix: bytes | None = None,
|
|
prefix: bytes | None = None,
|
|
dir: BytesPath | None = None,
|
|
) -> None: ...
|
|
|
|
def cleanup(self) -> None: ...
|
|
def __enter__(self) -> AnyStr: ...
|
|
def __exit__(self, exc: type[BaseException] | None, value: BaseException | None, tb: TracebackType | None) -> None: ...
|
|
if sys.version_info >= (3, 9):
|
|
def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
|
|
|
|
# The overloads overlap, but they should still work fine.
|
|
@overload
|
|
def mkstemp(
|
|
suffix: str | None = None, prefix: str | None = None, dir: StrPath | None = None, text: bool = False
|
|
) -> tuple[int, str]: ...
|
|
@overload
|
|
def mkstemp(
|
|
suffix: bytes | None = None, prefix: bytes | None = None, dir: BytesPath | None = None, text: bool = False
|
|
) -> tuple[int, bytes]: ...
|
|
|
|
# The overloads overlap, but they should still work fine.
|
|
@overload
|
|
def mkdtemp(suffix: str | None = None, prefix: str | None = None, dir: StrPath | None = None) -> str: ...
|
|
@overload
|
|
def mkdtemp(suffix: bytes | None = None, prefix: bytes | None = None, dir: BytesPath | None = None) -> bytes: ...
|
|
def mktemp(suffix: str = "", prefix: str = "tmp", dir: StrPath | None = None) -> str: ...
|
|
def gettempdirb() -> bytes: ...
|
|
def gettempprefixb() -> bytes: ...
|
|
def gettempdir() -> str: ...
|
|
def gettempprefix() -> str: ...
|