Update type hints in ORM package

[edan-bainglass]

This PR updates type hinting in the ORM module. Mostly, it's a matter of importing future annotations and updating to 3.10 standards. Self is added to aiida.common.typing, where sys is used to determine from where to import Self. Self is introduced to improve typing for entity collections, which in turn makes CollectionType redundant, which is removed.

Minimal formatting updates here and there.

Update

Self is introduced to improve typing for entity collections, which in turn makes CollectionType redundant, which is removed.

This proved to be more difficult. Reverting for now. I suspect there may be an issue with the @classproperty decorator that is interfering with mypy.

[edan-bainglass]

Oh boy. Misunderstood the function of from __future__ import annotations. Okay, this PR won't work in 3.9. Closing for now, but good to have as a reference, since we're considering dropping 3.9 support soon.

[edan-bainglass]

Reopening, as much of this can still hold. Just not | operations for Optional and Union, which is fine. I'll revert this (stash for later).

Update

Actually, | works for type hints. Just not for type definition, so no NewType = int | str allowed. Easy!

[codecov]

Codecov Report

❌ Patch coverage is 99.02200% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.26%. Comparing base (ebc9d4a) to head (bbd8a13).
⚠️ Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
src/aiida/cmdline/utils/common.py	71.43%	2 Missing ⚠️
src/aiida/common/typing.py	80.00%	1 Missing ⚠️
src/aiida/orm/entities.py	95.84%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7026      +/-   ##
==========================================
- Coverage   79.27%   79.26%   -0.00%     
==========================================
  Files         566      566              
  Lines       43779    43805      +26     
==========================================
+ Hits        34700    34717      +17     
- Misses       9079     9088       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[danielhollas]

@edan-bainglass great to see work on typing. :-)

It seems that this partly overlaps with my work in #7019 and #6704. Would be great if you could have a look and review. Especially #6704 should go in first because some of the files that you're modifying here are not actually type-checked in pre-commit.

[edan-bainglass]

@edan-bainglass great to see work on typing. :-)

It seems that this partly overlaps with my work in #7019 and #6704. Would be great if you could have a look and review. Especially #6704 should go in first because some of the files that you're modifying here are not actually type-checked in pre-commit.

Okay cool. I'll have a look this week.

[edan-bainglass]

@danielhollas honest opinion, is this PR required? I believe you stated this type of work can be automated by ruff, once some prelim work is done, which you're addressing in recent PRs. Is this accurate?

[danielhollas]

@danielhollas honest opinion, is this PR required?

Hah, thanks, I was going to write the same thing here but was procrastinating on it as I didn't want to be a PITA. 😅

I don't think we should merge this at this point: we should wait until we drop Python 3.9, and then convert everything over whole codebase at once with ruff. Then we'll add the resulting commit to .git-blame-ignore-revs to preserve git history.

[edan-bainglass]

Hah, thanks, I was going to write the same thing here but was procrastinating on it as I didn't want to be a PITA. 😅

Not at all. I rather close it and have the robots handle it cleanly.

I don't think we should merge this at this point: we should wait until we drop Python 3.9, and then convert everything over whole codebase at once with ruff. Then we'll add the resulting commit to .git-blame-ignore-revs to preserve git history.

Sounds like a plan 👍 We probably should look more seriously into doing 3.9 in AiiDAlab

[danielhollas]

We probably should look more seriously into doing 3.9 in AiiDAlab

Yep, see aiidalab/aiidalab-docker-stack#455 (comment)

[edan-bainglass]

Most of what is done here is already accomplished by a series of recent PRs by @danielhollas. As suggested above, once we drop support for Python 3.9, we will push one commit to update all type hints across the codebase. As such, this PR is no longer necessary. Closing...