Skip to content

[aiofiles] Narrow NamedTemporaryFile.name to str or bytes #16770

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

Open
sumit-2007-git wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[aiofiles] Narrow NamedTemporaryFile.name to str or bytes #16770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
264 changes: 240 additions & 24 deletions stubs/aiofiles/aiofiles/tempfile/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,42 @@ if sys.version_info >= (3, 12):
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper]: ...
) -> AiofilesContextManager[AsyncTextIOWrapper[str | bytes]]: ...

# Unbuffered binary: returns a FileIO
@overload
Expand All @@ -98,14 +126,42 @@ if sys.version_info >= (3, 12):
buffering: Literal[0],
encoding: None = None,
newline: None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryMode,
buffering: Literal[0],
encoding: None = None,
newline: None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryMode,
buffering: Literal[0],
encoding: None = None,
newline: None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO]: ...
) -> AiofilesContextManager[AsyncFileIO[str | bytes]]: ...

# Buffered binary reading/updating: AsyncBufferedReader
@overload
Expand All @@ -114,14 +170,42 @@ if sys.version_info >= (3, 12):
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeReading | OpenBinaryModeUpdating = "w+b",
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeReading | OpenBinaryModeUpdating = "w+b",
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader]: ...
) -> AiofilesContextManager[AsyncBufferedReader[str | bytes]]: ...

# Buffered binary writing: AsyncBufferedIOBase
@overload
Expand All @@ -130,14 +214,42 @@ if sys.version_info >= (3, 12):
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeWriting,
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeWriting,
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase]: ...
) -> AiofilesContextManager[AsyncBufferedIOBase[str | bytes]]: ...
else:
# Text mode: always returns AsyncTextIOWrapper
@overload
Expand All @@ -146,13 +258,39 @@ else:
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenTextMode,
buffering: int = -1,
encoding: str | None = None,
newline: str | None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper]: ...
) -> AiofilesContextManager[AsyncTextIOWrapper[str | bytes]]: ...

# Unbuffered binary: returns a FileIO
@overload
Expand All @@ -161,13 +299,39 @@ else:
buffering: Literal[0],
encoding: None = None,
newline: None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryMode,
buffering: Literal[0],
encoding: None = None,
newline: None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryMode,
buffering: Literal[0],
encoding: None = None,
newline: None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO]: ...
) -> AiofilesContextManager[AsyncFileIO[str | bytes]]: ...

# Buffered binary reading/updating: AsyncBufferedReader
@overload
Expand All @@ -176,13 +340,39 @@ else:
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeReading | OpenBinaryModeUpdating = "w+b",
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeReading | OpenBinaryModeUpdating = "w+b",
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader]: ...
) -> AiofilesContextManager[AsyncBufferedReader[str | bytes]]: ...

# Buffered binary writing: AsyncBufferedIOBase
@overload
Expand All @@ -191,13 +381,39 @@ else:
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: AnyStr | None = None,
prefix: AnyStr | None = None,
suffix: str | None = None,
prefix: str | None = None,
dir: StrPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase[str]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeWriting,
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: bytes | None = None,
prefix: bytes | None = None,
dir: BytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase[bytes]]: ...
@overload
def NamedTemporaryFile(
mode: OpenBinaryModeWriting,
buffering: Literal[-1, 1] = -1,
encoding: None = None,
newline: None = None,
suffix: str | bytes | None = None,
prefix: str | bytes | None = None,
dir: StrOrBytesPath | None = None,
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase]: ...
) -> AiofilesContextManager[AsyncBufferedIOBase[str | bytes]]: ...

# Text mode: always returns AsyncTextIOWrapper
@overload
Expand Down
Loading
Loading