Refactor Result class #51
Draft
Conversation
This file contains 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
I plan to add "timed out" case to the union later.
|
@loganek do you have any early feedback about the api? |
I left a few comments. It looks ok to me in general, although I'm not really sure if we should have yet another type in the |
loganek
requested changes
Feb 3, 2023
| @@ -14,14 +14,16 @@ class Failure(NamedTuple): | |||
| message: str | |||
|
|
|||
|
|
|||
| class Result(NamedTuple): | |||
| class Executed(NamedTuple): | |||
There was a problem hiding this comment.
Suggested change
| class Executed(NamedTuple): | |
| class ExecutedResult(NamedTuple): |
| def failed(self) -> bool: | ||
| return len(self.failures) > 0 | ||
|
|
||
| class Skipped(NamedTuple): |
There was a problem hiding this comment.
Suggested change
| class Skipped(NamedTuple): | |
| class SkippedResult(NamedTuple): |
| reason: str | ||
|
|
||
|
|
||
| Result = Union[Executed, Skipped] |
There was a problem hiding this comment.
Suggested change
| Result = Union[Executed, Skipped] | |
| Result = Union[ExecutedResult, SkippedResult] |
| failures: List[Failure] | ||
|
|
||
| @property | ||
| def failed(self) -> bool: |
There was a problem hiding this comment.
I'd keep that property for the Executed class as it abstracts the implementation detail.
Executed -> ExecutedResult Skipped -> SkippedResult
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.
I plan to add "timed out" case to the union later.
todo: