refactor: add typing for workflow record function #2479
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BClappe
force-pushed
the
refactor/typing_workflow_record
branch
from
3a360d7 to
cfc74ac
Compare
PProfizi
reviewed
Jul 28, 2025
PProfizi
reviewed
Jul 28, 2025
PProfizi
reviewed
Jul 28, 2025
PProfizi
reviewed
Jul 28, 2025
PProfizi
reviewed
Jul 28, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2479 +/- ##
==========================================
+ Coverage 84.12% 84.15% +0.02%
==========================================
Files 91 91
Lines 10703 10704 +1
==========================================
+ Hits 9004 9008 +4
+ Misses 1699 1696 -3 |
PProfizi
reviewed
Jul 28, 2025
BClappe
force-pushed
the
refactor/typing_workflow_record
branch
from
cfc74ac to
466c945
Compare
BClappe
force-pushed
the
refactor/typing_workflow_record
branch
from
62405d0 to
4ab8c8f
Compare
PProfizi
reviewed
Aug 5, 2025
src/ansys/dpf/core/workflow.py
Outdated
| @@ -624,17 +631,19 @@ def record(self, identifier="", transfer_ownership=True): | |||
| return self._api.work_flow_record_instance(self, identifier, transfer_ownership) | |||
|
|
|||
| @staticmethod | |||
| def get_recorded_workflow(id, server=None): | |||
| def get_recorded_workflow(id: int, server: AnyServerType | None = None) -> Workflow: | |||
There was a problem hiding this comment.
I do not think the union with None is mandatory. I think it knows from the default value that the parameter is optional and defaults to None.
There was a problem hiding this comment.
From experience, it doesn't always infers this. Maybe it does. Though, type checkers tend to error or warn about that, so I usually specify it may explicitly be None.
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: Paul Profizi <[email protected]>
PProfizi
approved these changes
Aug 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.