Правильный способ аннотировать «тип файла» в Python

Question

В современных версиях Ppython можно провести анализ статического типа с использованием аннотаций функций в соответствии с PEP 484. Это облегчается с помощью модуля ввода.

Теперь мне интересно, как бы я дал «тип намека» на «filestream».

def myfunction(file: FILETYPE): 
    pass 

with open(fname) as file: 
    myfunction(file) 

Что бы вставить как FILETYPE?

Использование print(type(file)) возвращает <class '_io.TextIOWrapper'>, что совсем неясно.

Не существует ли общий тип файлов?

Answer 1

Я думаю, что вы хотите io.IOBase, «[t] он абстрактный базовый класс для всех классов ввода-вывода, действующий на потоки байтов».

Обратите внимание, что это включает также потоки в памяти, такие как io.StringIO и io.BytesIO. Прочтите документацию по адресу module io.

Answer 2

Вы можете использовать typing.IO, typing.TextIO и typing.BinaryIO для представления различных типов потоков ввода-вывода. Цитирую documentation:

класса печатать. И.О.

        Упаковочный пространство имен для типов потоков ввода/вывода.

        Это определяет общий тип IO[AnyStr] и псевдонимы TextIO и BinaryIO для
        соответственно IO[str] и IO[bytes]. Они представляют собой типы потоков ввода-вывода , таких как
        как получено open().

        Эти типы также доступны непосредственно в typing.IO, typing.TextIO и
        typing.BinaryIO.

Answer 3

Либо это:

from typing import TextIO # or IO or BinaryIO 

def myfunction(file: TextIO): 
    pass 

ИЛИ это

from typing import TYPE_CHECKING 
if TYPE_CHECKING: 
    from typing import TextIO # or IO or BinaryIO 

def myfunction(file: 'TextIO'): 
    pass 

Второй подход позволит избежать импортировать класс во время выполнения.Хотя python все равно должен был бы импортировать TYPE_CHECKING во время выполнения, рекомендуется избегать импорта классов только для намека типа: (1) не выполняется (просто анализируется) и (2) он мог избежать циклического импорта.