Consider to use Python Typing

rhardouin commented 3 years ago

Hi, To avoid type errors as much as possible I suggest to start using Python Typing capabilities

Mypy (a static type checker). The ROI is:
a more reliable code
avoid issues like https://github.com/thelastpickle/cassandra-medusa/pull/320
ensure that nullable objects are checked (using Optional[])
...
a more maintainable code (more context when making changes)
a more pleasant code to work with (IDE autocomplete is more powerful)
a more readable code (types are part of the documentation)

If it sounds good to you I can start to work on it and make multiple PRs (to avoid a massive PR to review).

In the beginning we would have to run mypy locally to fix warnings but in the long run such checks should also be triggered on each PR.

┆Issue is synchronized with this Jira Story by Unito

rhardouin commented 3 years ago

Other type checkers to consider:

Google Pytype
Facebook Pyre
Microsoft Pyright

jeffbanks commented 3 years ago

@rhardouin @adejanovski mentioned this one to me recently and sounds like a great idea. It would help out in many areas as you described. I'll take some time to investigate a few of these mentioned to see if we can throw around some pros and cons of each.

thelastpickle / cassandra-medusa

Consider to use Python Typing #322