Implement Type Hints

[martinvonk]

Short Description

This pull request implements Type Hints into Pastas. Python does not enforce function and variable type annotations. However they can be used by third party tools such as type checkers, IDEs, linters, etc. This helps the Pastas users and developers to write better code.

Checklist before PR can be merged:

• closes issue [ENHANCEMENT] Implement Type Hints into Pastas #389
• is documented
• PEP8 compliant code
• tests added / passed

[martinvonk]

I spent a lot of time in public transport this Christmas so this is the end result 🎁. I did not implement the type annotation in the read functions since they will be deprecated in the future.

[martinvonk]

The read the docs test fails because it uses a numpy version > 1.23 and numba does not support it yet.
From numba/numba#8615 :

For devs who are trying to fix their environments
The problem occurs in the latest version of numpy. Installing a lower version of numpy (<1.24) fixed the problem for us.

It is being worked on:
numba/numba#8620

For now I'll try and fix it in the requirements by forcing numpy < 1.24

[martinvonk]

This can be merged into the dev branch after a new version of Pastas is released (at the latest next Tuesday) by @raoulcollenteur.

Maybe @dbrakenhoff can check this PR?

[raoulcollenteur]

The read the docs test fails because it uses a numpy version > 1.23 and numba does not support it yet. From numba/numba#8615 :

For devs who are trying to fix their environments
The problem occurs in the latest version of numpy. Installing a lower version of numpy (<1.24) fixed the problem for us.

It is being worked on: numba/numba#8620

For now I'll try and fix it in the requirements by forcing numpy < 1.24

Nice catch. Should we not directly change this in the dev-version, rather than in every single PR?

[martinvonk]

Nice catch. Should we not directly change this in the dev-version, rather than in every single PR?

I don't have permission to write directly to the dev branch :), so I'd just merge the #420 PR to the dev and everything will be solved. I'll remove the change from this PR #441 afterwards.

I only fixed the same bug in #420 because it can't be merged otherwise.

[dbrakenhoff]

Looking much better already. Nice move with the quoted annotations in typing.py and the mypy trick.

I think we should replace Tminmax with a normal Timestamp (or Union[str, Timestamp]), because those are functionally the same types.

Also nitpicking, but perhaps rename Array_Like to ArrayLike (more in line with Python class naming conventions)?

I agree on the black formatting style for functions with lots of input parameters. Whether we should apply it to the whole code base is a separate discussion maybe.

[martinvonk]

How about formatting this pull request with Black? I feel like methods and functions with type hinting become much more readable with Black.

I was crazy enough to format the functions and methods by hand. Leaving the rest of the code (and thus git blame) intact which is one the arguments @dbrakenhoff raises in #448

[raoulcollenteur]

Don't know how to rerun all GH action jobs without 3.11.

All changes were made by @martinvonk