Repository navigation
StrOrBytesPath | FileDescriptor alias #9297
Description
Opening an issue so we don't forget.
Original comment from @AlexWaygood :
We could actually consider adding this alias to
_typeshed; there's a bunch of functions inos/__init__.pyithat could use it.os/__init__.pyicurrently defines an_FdOrAnyPathalias. We don't need to add the alias to_typeshedin this PR, though.
There's a handful of _OpenFile aliases also defined in multiple stubs
There's also a lot of int | StrOrBytesPath, StrOrBytesPath | int and StrOrBytesPath | FileDescriptor which could be replaced by the alias.
Activity
Avasam commentedon Jan 6, 2023
With a new mypy release around the corner, adding helper types before mypy updates its vendored typeshed might be a good idea.
AlexWaygood commentedon Jan 7, 2023
There don't seem to be any objections :)
The only reservation I have is about the name.
OpenFileisn't very descriptive/accurate, since for theStrOrBytesPathhalf of the alias, the file hasn't actually been opened yet. Maybe something likeFileDescriptorOrPath?JelleZijlstra commentedon Jan 7, 2023
I would be okay with
PathOrFDsince "FD" for "file descriptor" is pretty commonly understood, but maybe it's still too obscure.hauntsaninja commentedon Jan 7, 2023
"fd" seems fine; it's commonly used as an identifier in the Python docs and e.g.
os.fdopenis a thingAlexWaygood commentedon Jan 7, 2023
I'd still lean towards
FileDescriptorOrPath, but happy with either!