Type hint for a file or file-like object?
Use either the typing.TextIO
or typing.BinaryIO
types, for files opened in text mode or binary mode respectively.
From the docs:
class
typing.IO
Wrapper namespace for I/O stream types.
This defines the generic type
IO[AnyStr]
and aliasesTextIO
andBinaryIO
for respectivelyIO[str]
andIO[bytes]
. These representing the types of I/O streams such as returned byopen()
.
The short answer:
- You need to be explicit. That is
from typing import TextIO
not justfrom typing import *
. - Use
IO
to mean a file without specifying what kind - Use
TextIO
orBinaryIO
if you know the type - You cannot currently specify it be opened for write or its encoding.
As an example:
from typing import BinaryIO
def binf(inf: BinaryIO):
pass
with open('x') as f:
binf(f)
gives an inspection error (in PyCharm) of Expected type 'BinaryIO', got 'TextIO' instead