Update type hinting to follow PEP 585

Is your feature request related to a problem? Please describe.

I am getting the following warning

/Users/bpedigo/JHU_code/bilateral/.venv/lib/python3.9/site-packages/beartype/_util/hint/pep/utilpeptest.py:396: 
BeartypeDecorHintPepDeprecatedWarning: Type hint typing.List[scipy.sparse.csr.csr_matrix] deprecated by PEP 585. To 
resolve this, globally replace this hint by the equivalent PEP 585 type hint (e.g., "typing.List[int]" by "list[int]"). 
See also:
    https://www.python.org/dev/peps/pep-0585
  warn(warning_message, BeartypeDecorHintPepDeprecatedWarning)

Describe the solution you’d like

Should update anywhere in the code we use typing.List to be just list[], I think? That’s just what it sounds like from a cursory glance at https://www.python.org/dev/peps/pep-0585/ but I could be wrong.

[leycec]

While perambulating in an exhausted late-night stupor through this exciting project, I couldn’t help but notice this issue. As Mr. Beartype, I am the culprit responsible for everyone’s pain here. 😞

The core issue is that PEP 585 deprecates most of PEP 484. Specifically, most of the typing module (including typing.List) will be going away by 2024. You have two options here:

• Easy way. The easy way is, as @bdpedigo suggests, to just unilaterally squelch this warning with an ignore warning filter on BeartypeDecorHintPepDeprecatedWarning. Since this is currently the only type of deprecated type hint, this is a decent temporary solution. Of course, this solution will still fail sometime in 2024 with fiery explosions. Thanks alot, Guido! If that wasn’t easy enough, here are two even easier ways to do this with differing tradeoffs depending on who you want to suffer the most – you or your awesome userbase:

# Do it globally for everyone, whether they want you to or not!
# This is the "Make Users Suffer" option.
from beartype.roar import BeartypeDecorHintPepDeprecatedWarning
from warnings import filterwarnings
filterwarnings("ignore", category=BeartypeDecorHintPepDeprecatedWarning)
...

# Do it locally only for you! (Hope you like globally increasing your
# indentation level in every single package module.)
# This is the "Make Yourself Suffer" option.
from beartype.roar import BeartypeDecorHintPepDeprecatedWarning
from warnings import catch_warnings, filterwarnings
with catch_warnings():
    filterwarnings("ignore", category=BeartypeDecorHintPepDeprecatedWarning)
    ...

• Hard way. The hard way is to use type aliases to conditionally annotate callables with either PEP 484 or 585 type hints depending on the major version of the current Python interpreter. Since this is life, the hard way is also the best way – but it’s also hard. For example, you might define a new private graspologic._typing submodule resembling:

from sys import version_info

if version_info >= (3, 9):
    List = list
    Tuple = tuple
    ...
else:
    from typing import List, Tuple, ...

Then instead of importing List and Tuple from typing when annotating callables, you import List and Tuple from your private graspologic._typing submodule instead: e.g.,

# Instead of this...
from typing import List, Tuple

# ...just do this.
from graspologic._typing import List, Tuple

What could be simpler? ^{gagging sounds faintly heard}

And… I should just write this up as a FAQ entry already. May your pain be felt by no one else.

[leycec]

The Bear has landed.