infer types

Выводные типы

Инструмент CLI для автоматического добавления аннотаций типа в код Python.

Основной сценарий использования инструмента - помочь вам с аннотированием большой и старой кодовой базы. Это не решит задачу для вас на 100%, но определенно вам очень поможет, потому что многие функции в реальном мире имеют довольно простые типы возврата, которые легко сделать автоматически.

Функции:

• 100% автоматизировано, получите кучу аннотаций типа без усилий.
• 100% статический, все типы выводятся без запуска кода.
• Много эвристики и умного вывода.
• Активно использует TypeShed, чтобы найти аннотации для нездоровых зависимостей.

Пример

Допустим, у вас есть следующий метод:

 class Database :
    def users_count ( self ):
        return len ( self . users )

Поскольку len всегда возвращает int , infer-types способны выводить тип возврата метода. Итак, после запуска инструмента код будет выглядеть так:

 class Database :
    def users_count ( self ) -> int :
        return len ( self . users )

Установка

python3 -m pip install infer-types

Использование

python3 -m infer_types ./example/

Инструмент добавит новые операторы импорта, которые могут быть дублированы и расположены не в верхней части файла. Чтобы исправить это, запустите Isort:

python3 -m isort ./example/

Инструмент «Вывод» использует новый фантастический синтаксис для аннотаций типа, представленных в Python 3.10. Таким образом, вместо Optional[str] это испускает str | None . Если ваш код должен работать на более старой версии Python, добавьте from __future__ import annotations в начале каждого файла. Это решит проблему, а также сделает запуск вашего приложения быстрее. Вы также можете сделать это с помощью Isort:

python3 -m isort --add-import ' from __future__ import annotations ' ./example/

Смотрите потрясающий питонный типинг для получения дополнительных инструментов, которые помогут вам с аннотированием вашего кода.

Как это работает

• Большинство эвристики живут в пакете Astypes. Проверьте это, узнайте больше о основной логике вывода.
• Если тот же метод определяется в базовом классе, скопируйте аннотации типа оттуда.
• Если нет возвратных операторов, возвращающих значение, тип возврата None является.
• Если есть оператор yield , тип возврата typing.Iterator .
• В некоторых случаях тип возврата можно догадаться от имени функции. Например, предполагается, что функция is_open возвращает bool потому что она начинается с is_ .

Вы можете запустить только определенную эвристику, используя --only флаг.