Skip to content

Fix aiofiles NamedTemporaryFile name type #15970

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

Closed
ishaanlabs-gg wants to merge 1 commit into from
Closed

Fix aiofiles NamedTemporaryFile name type #15970

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
13 changes: 13 additions & 0 deletions stubs/aiofiles/@tests/test_cases/check_tempfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
from __future__ import annotations

from typing_extensions import assert_type

from aiofiles.tempfile import NamedTemporaryFile


async def check_named_temporary_file_name() -> None:
async with NamedTemporaryFile() as binary_file:
assert_type(binary_file.name, str)

async with NamedTemporaryFile(mode="w+") as text_file:
assert_type(text_file.name, str)
38 changes: 29 additions & 9 deletions stubs/aiofiles/aiofiles/tempfile/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,32 @@ from _typeshed import (
)
from asyncio import AbstractEventLoop
from concurrent.futures import Executor
from typing import AnyStr, Literal, overload
from typing import AnyStr, Literal, overload, type_check_only

from ..base import AiofilesContextManager
from ..threadpool.binary import AsyncBufferedIOBase, AsyncBufferedReader, AsyncFileIO
from ..threadpool.text import AsyncTextIOWrapper

@type_check_only
class _NamedAsyncTextIOWrapper(AsyncTextIOWrapper):
@property
def name(self) -> str: ...

@type_check_only
class _NamedAsyncFileIO(AsyncFileIO):
@property
def name(self) -> str: ...

@type_check_only
class _NamedAsyncBufferedReader(AsyncBufferedReader):
@property
def name(self) -> str: ...

@type_check_only
class _NamedAsyncBufferedIOBase(AsyncBufferedIOBase):
@property
def name(self) -> str: ...

# Text mode: always returns AsyncTextIOWrapper
@overload
def TemporaryFile(
Expand Down Expand Up @@ -89,7 +109,7 @@ if sys.version_info >= (3, 12):
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper]: ...
) -> AiofilesContextManager[_NamedAsyncTextIOWrapper]: ...

# Unbuffered binary: returns a FileIO
@overload
Expand All @@ -105,7 +125,7 @@ if sys.version_info >= (3, 12):
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO]: ...
) -> AiofilesContextManager[_NamedAsyncFileIO]: ...

# Buffered binary reading/updating: AsyncBufferedReader
@overload
Expand All @@ -121,7 +141,7 @@ if sys.version_info >= (3, 12):
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader]: ...
) -> AiofilesContextManager[_NamedAsyncBufferedReader]: ...

# Buffered binary writing: AsyncBufferedIOBase
@overload
Expand All @@ -137,7 +157,7 @@ if sys.version_info >= (3, 12):
delete_on_close: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase]: ...
) -> AiofilesContextManager[_NamedAsyncBufferedIOBase]: ...
else:
# Text mode: always returns AsyncTextIOWrapper
@overload
Expand All @@ -152,7 +172,7 @@ else:
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncTextIOWrapper]: ...
) -> AiofilesContextManager[_NamedAsyncTextIOWrapper]: ...

# Unbuffered binary: returns a FileIO
@overload
Expand All @@ -167,7 +187,7 @@ else:
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncFileIO]: ...
) -> AiofilesContextManager[_NamedAsyncFileIO]: ...

# Buffered binary reading/updating: AsyncBufferedReader
@overload
Expand All @@ -182,7 +202,7 @@ else:
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedReader]: ...
) -> AiofilesContextManager[_NamedAsyncBufferedReader]: ...

# Buffered binary writing: AsyncBufferedIOBase
@overload
Expand All @@ -197,7 +217,7 @@ else:
delete: bool = True,
loop: AbstractEventLoop | None = None,
executor: Executor | None = None,
) -> AiofilesContextManager[AsyncBufferedIOBase]: ...
) -> AiofilesContextManager[_NamedAsyncBufferedIOBase]: ...

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