Pygithub: Добавить анонтации типов для mypy (и т. Д.)

Если сопровождающие согласны с этой идеей, я бы не прочь поработать над ней.

Я согласен с этим, но это не потребует небольших усилий. Возможно, перед этим мы должны обновить проект до Python 3 (поскольку Python2 скоро уйдет), чтобы мы могли везде использовать аннотации типов в стиле Python3.

Можно использовать такие инструменты, как https://github.com/Instagram/MonkeyType, для применения аннотаций типов, встроенных из файла-заглушки. Таким образом, потенциально мы могли бы начать работу над написанием заглушек, а затем применять их в оперативном режиме после отказа от поддержки Py2.

Хорошо, я действительно начал работать над идеей @trickeydan . Я сгенерировал файлы-заглушки, запустив MonkeyType против unittest и записал их в файлы .piy рядом с файлами .py. Это потребует проверки всех заглушек вручную, потому что MonkeyType, к сожалению, упустил некоторые детали здесь и там (так что это может занять некоторое время).

Я думаю, что также потребуется экспортировать более или менее каждый тип, который есть в модуле __init__.py чтобы люди включали тип PyGithub в свои проверки типов.

Если кому-то интересно, вы можете проверить прогресс здесь: https://github.com/zer0tonin/PyGithub/tree/agg/type_stubs

Единственная проблема, которую я заметил до сих пор, заключается в том, что urllib3, похоже, не имеет доступной информации для ввода, и, к сожалению, мы используем некоторые из их типов.

@ zer0tonin Давайте продолжим. Почему бы не открыть PR от вашего филиала, чтобы мы могли его рассмотреть.

urllib3 используется только для функции Retry, которая недавно появилась в # 1002. Давайте посмотрим, как мы можем добавить заглушку в urllib3 позже.

Закрылся в №1231
Применение CI будет добавлено в # 1442.