Skip to content

Commit

Permalink
Merge pull request #8 from nifadyev/feature/#4/add-recommendation-abo…
Browse files Browse the repository at this point in the history
…ut-type-annotations

#4: Add recommendation about type annotations
  • Loading branch information
soltanoff authored Sep 19, 2024
2 parents c965f61 + 8985851 commit 4975114
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,13 @@ We recommend adding docstrings to functions, methods, and classes.
Code is read much more than it is written.


### Type Annotations

Annotating new code is strongly encouraged. Existing codebase is recommended to annotate gradually. It is also advised to use `static type checker` on `pre-commit` or `CI` stage but allow proceeding with invalid annotations because sometimes it takes a lot of effort to debug and annotate code.

**Why?** Typed code is better self-documented. There is no need to guess the object's type or use `isinstance`, modern IDEs work perfectly with annotated object types. Moreover, annotations reduce error rate. Warnings and errors are shown by `static type checker` during coding instead of catching errors on running project. Unit testing is also much easier if you know what types are expected.


## About Pull Requests

### Creating Pull Requests
Expand Down
7 changes: 7 additions & 0 deletions RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,13 @@ from some.absolute.path import foo, bar
Код читается намного больше, чем пишется.


### Аннотации типов

Крайне рекомендуется типизировать новый код. Существующую кодовую базу следует типизировать постепенно. Не будет лишним использовать `статический анализатор типов` на стадии `pre-commit` и/или `CI` с возможностью пропустить проверку, так как зачастую требуется много времени для типизирования и отладки кода.

**Почему?** Типизированный код является актуальной "документацией". Не нужно угадывать тип объекта или использовать `isinstance`, современные IDE прекрасно считывают тип аннотированных объектов. К тому же типизированный код снижает число ошибок. Предупреждения и ошибки о неправильном типе возникают при запуске `статического анализатора типов` во время написания кода, а не в процессе взаимодействия с запущенным проектом. Юнит тесты писать гораздо проще, если знать, какие типы данных ожидаемы.


## Про Pull Request

### Создание Pull Request
Expand Down

0 comments on commit 4975114

Please sign in to comment.