Add last_clean_details to return information from the last clean #395
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
This involves also refactoring clean_details() to return the results unwrapped. For the time being the default behavior will remain the same as it was (wrapped), but a deprecation warning will be raised. I'm expecting that we can flip the toggle after a while, and remove the warning at that point, too.
houndci-bot
reviewed
Oct 17, 2018
miio/vacuum.py
Outdated
| def clean_details(self, id_: int) -> List[CleaningDetails]: | ||
| def clean_details(self, id_: int, return_list=True) -> Union[ | ||
| List[CleaningDetails], | ||
| Optional[CleaningDetails]]: |
There was a problem hiding this comment.
continuation line with same indent as next logical line
… when return_list=True
8 tasks
1 similar comment
Merged
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Reasoning: sometimes it is useful to get information from the last clean up (e.g. its start time for UIs). Furthermore, as far as I know one is getting always details for a single cleaning, so there's no need to keep it wrapped in a list, simplifying the downstream usage. In case there are multiple details, a warning is printed out so we can adjust this if need to be.
This involves also refactoring clean_details() to return the results unwrapped.
For the time being the default behavior will remain the same as it was (wrapped),
but a deprecation warning will be raised.
I'm expecting that we can flip the toggle after a while, and remove the warning
at that point, too.