8000 Tighten tempfile() return types by srittau · Pull Request #10232 · python/typeshed · GitHub
[go: up one dir, main page]
Skip to content

Tighten tempfile() return types #10232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 8, 2023
Merged

Tighten tempfile() return types #10232

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
19da99c
Tighten tempfile() return types
srittau May 30, 2023
3aefbe5
Use mode type aliases from _typeshed
srittau May 31, 2023
2e54629
Make tempfile overloads match open()
srittau May 31, 2023
48177f6
Fix return type
srittau May 31, 2023
a163aad
Fix defaults
srittau May 31, 2023
67ebbcc
Merge branch 'main' into tempfile-ret
srittau Jun 7, 2023
2b80949
Remove unnecessary type alias
srittau Jun 7, 2023
1091571
Python 3.12 updates
srittau Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 120 additions & 45 deletions stdlib/tempfile.pyi
View file
Open in desktop
< 8000 td id="diff-bf60a71a3fa9df541641785671566f47cb913107df93cf1d96dff83036faa194R9" data-line-number="9" class="blob-num blob-num-addition js-linkable-line-number js-blob-rnum">
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
import io
import sys
from _typeshed import BytesPath, GenericPath, ReadableBuffer, StrPath, WriteableBuffer
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, overload
from typing_extensions import Literal, Self, TypeAlias
from typing_extensions import Literal, Self

if sys.version_info >= (3, 9):
from types import GenericAlias
Expand All @@ -30,13 +41,10 @@ TMP_MAX: int
tempdir: str | None
template: str

_StrMode: TypeAlias = Literal["r", "w", "a", "x", "r+", "w+", "a+", "x+", "rt", "wt", "at", "xt", "r+t", "w+t", "a+t", "x+t"]
_BytesMode: TypeAlias = Literal["rb", "wb", "ab", "xb", "r+b", "w+b", "a+b", "x+b"]

if sys.version_info >= (3, 12):
@overload
def NamedTemporaryFile(
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -50,7 +58,7 @@ if sys.version_info >= (3, 12):
) -> _TemporaryFileWrapper[str]: ...
@overload
def NamedTemporaryFile(
mode: _BytesMode = "w+b",
mode: OpenBinaryMode = "w+b",
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand Down Expand Up @@ -80,7 +88,7 @@ if sys.version_info >= (3, 12):
elif sys.version_info >= (3, 8):
@overload
def NamedTemporaryFile(
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -93,7 +101,7 @@ elif sys.version_info >= (3, 8):
) -> _TemporaryFileWrapper[str]: ...
@overload
def NamedTemporaryFile(
mode: _BytesMode = "w+b",
mode: OpenBinaryMode = "w+b",
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand Down Expand Up @@ -121,7 +129,7 @@ elif sys.version_info >= (3, 8):
else:
@overload
def NamedTemporaryFile(
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -132,7 +140,7 @@ else:
) -> _TemporaryFileWrapper[str]: ...
@overload
def NamedTemporaryFile(
mode: _BytesMode = "w+b",
mode: OpenBinaryMode = "w+b",
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -156,10 +164,11 @@ else:
if sys.platform == "win32":
TemporaryFile = NamedTemporaryFile
else:
# See the comments for builtins.open() for an explanation of the overloads.
if sys.version_info >= (3, 8):
@overload
def TemporaryFile(
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -168,19 +177,55 @@ else:
dir: GenericPath[AnyStr] | None = None,
*,
errors: str | None = None,
) -> IO[str]: ...
) -> io.TextIOWrapper: ...
@overload
def TemporaryFile(
mode: _BytesMode = "w+b",
buffering: int = -1,
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(
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[bytes]: ...
) -> 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",
Expand All @@ -196,33 +241,63 @@ else:
else:
@overload
def TemporaryFile(
mode: _StrMode,
buffering: int = ...,
encoding: str | None = ...,
newline: str | None = ...,
suffix: AnyStr | None = ...,
prefix: AnyStr | None = ...,
dir: GenericPath[AnyStr] | None = ...,
) -> IO[str]: ...
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,
) -> 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,
) -> io.FileIO: ...
@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,
) -> io.BufferedRandom: ...
@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,
) -> io.BufferedWriter: ...
@overload
def TemporaryFile(
mode: _BytesMode = ...,
buffering: int = ...,
encoding: str | None = ...,
newline: str | None = ...,
suffix: AnyStr | None = ...,
prefix: AnyStr | None = ...,
dir: GenericPath[AnyStr] | None = ...,
) -> IO[bytes]: ...
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,
) -> io.BufferedReader: ...
@overload
def TemporaryFile(
mode: str = ...,
buffering: int = ...,
encoding: str | None = ...,
newline: str | None = ...,
suffix: AnyStr | None = ...,
prefix: AnyStr | None = ...,
dir: GenericPath[AnyStr] | None = ...,
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,
) -> IO[Any]: ...

class _TemporaryFileWrapper(Generic[AnyStr], IO[AnyStr]):
Expand Down Expand Up @@ -294,7 +369,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
def __init__(
self: SpooledTemporaryFile[bytes],
max_size: int = 0,
8000 mode: _BytesMode = "w+b",
mode: OpenBinaryMode = "w+b",
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -308,7 +383,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
def __init__(
self: SpooledTemporaryFile[str],
max_size: int,
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -323,7 +398,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
self: SpooledTemporaryFile[str],
max_size: int = 0,
*,
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand Down Expand Up @@ -367,7 +442,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
def __init__(
self: SpooledTemporaryFile[bytes],
max_size: int = 0,
mode: _BytesMode = "w+b",
mode: OpenBinaryMode = "w+b",
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -379,7 +454,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
def __init__(
self: SpooledTemporaryFile[str],
max_size: int,
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand All @@ -392,7 +467,7 @@ class SpooledTemporaryFile(IO[AnyStr], _SpooledTemporaryFileBase):
self: SpooledTemporaryFile[str],
max_size: int = 0,
*,
mode: _StrMode,
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
Expand Down
0