4148 Enhance engine iteration logic and the typehints

[Nic-Ma]

Fixes #4148 .

Description

This PR enhanced the engine iteration logic and the typehints.

Status

Ready

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• Breaking change (fix or new feature that would cause existing functionality to change).
• New tests added to cover the changes.
• Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
• Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

[Nic-Ma]

/black

[Nic-Ma]

/build

[Nic-Ma]

/build

[rijobro]

Is the future annotations necessary or purely aesthetic? I would leave it if it's the latter. Even though I find a | None more intuitive than Optional[a], we probably don't want to be doing this piecemeal in the codebase.

[Nic-Ma]

Hi @ericspod ,

I updated the engines in this PR, and I checked all the handlers don't have dependency on Workflow, so keep them with ignite Engine.
Seems pre-commit-ci also automatically changed several typehints, I saw @rijobro also used similar thing in MetaTensor:
https://github.com/Project-MONAI/MONAI/blob/dev/monai/data/meta_tensor.py
Maybe this is the right way to go? We may need to automatically update all the typehints in the codebase with the pre-commit-ci tool later (I don't know how to trigger it..).
Could you please help the PR?

Thanks in advance.

[rijobro]

So you imported from __future__ import annotations so that you could use SupervisedEvaluator as type hint for engine in _iteration?

And then from there, the pre-commit-ci made the other type hint changes (a | None)? If that's the case, this is all OK with me.

[Nic-Ma]

So you imported from __future__ import annotations so that you could use SupervisedEvaluator as type hint for engine in _iteration?

And then from there, the pre-commit-ci made the other type hint changes (a | None)? If that's the case, this is all OK with me.

Hi @rijobro ,

Yes, I imported the annotations to make current class is available for typehints.

Thanks.

[Nic-Ma]

/build

[Nic-Ma]

Hi @rijobro ,

The initial discussion about this PR is here: #4132 (comment).

Thanks.

[Nic-Ma]

I executed the integration test test_integration_workflows.py locally and it passed OK.

Thanks.

[ericspod]

I'm good with the changes, this way of defining optional values should be compatible with the versions of Python we're supporting now.