python / python/typeshed

[aiofiles] `aiofiles.tempfile.NamedTemporaryFile.name` should probably be a `str`

Open Beginner friendly
#13,551 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stubs: false positive
Dominant language
Python
Stars
5.1k
Forks
2.1k
Avg merge
1d 19h
Merged PRs (30d)
82

Description

When using aiofiles like this:

from aiofiles.tempfile import NamedTemporaryFile


async def main():
    async with NamedTemporaryFile() as f:
        print(f.name)

f.name is reported to be a FileDescriptorOrPath. It should probably be a str instead because that's how it is for the stdlib's tempfile.NamedTemporaryFile and that's the whole point of a named temporary file.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the aiofiles.tempfile.NamedTemporaryFile entry point and compare its name annotation with the standard library tempfile.NamedTemporaryFile behavior. Update the reported type so f.name is a str, then verify that the example no longer reports FileDescriptorOrPath.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.