Refactor laundry.py to use NamedTuple, add tests
#189
Merged
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
Refactor laundry.py to store API output using NamedTuples rather than plain Python dicts. This makes the output more user-friendly, less error-prone, and easier to type hint. This refactoring also modifies the API behavior as follows: 1. JSON objects that don't qualify as a known laundry machine type (washer, dryer, or combo) will now be skipped, whereas previously they would be marked as "unknown". These objects should be skipped because they may represent things that aren't laundry machines, such as card readers. 2. The time_remaining field for laundry machines can now be None if the laundry machine is unavailable (either out of service or offline). Add unit tests for laundry.py to increase test coverage to 100%. The new tests use mocked data for Towers laundry machines, the vast majority of which are combo machines rather than standalone washers or dryers. Fix a heretofore unknown bug that was caught during the aforementioned unit testing: "washNdry" was misspelled as "washNDry", which was causing the API to mark all combo machines as "unknown". This typo hadn't been caught because there had been no unit tests that included data for combo machines.
tianyizheng02
force-pushed
the
refactor-laundry
branch
from
d958a06 to
39a4e14
Compare
RitwikGupta
requested changes
Aug 10, 2024
This comment has been minimized.
This comment has been minimized.
Replace mock JSON test data for Sutherland East with new mock JSON test data for Holland. Because this data was collected close to the start of the fall semester, when the laundry machines are actually being used, it contains instances of status_toggle = 1, which clears up the TODO of what that status value represented. The meaning of this value has now been documented. Rewrite the logic for parsing JSON objects for laundry machines. The logic now accurately parses combo machines and adds support for double machines, which are two washers or two dryers in a single machine. This resolves the two remaining TODOs about combo machines.
|
@RitwikGupta I've addressed the TODOs. I was able to figure out the TODO for |
|
Excellent work @tianyizheng02 and @jkruse7! |
RitwikGupta
approved these changes
Aug 24, 2024
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.
Refactor
laundry.pyto store API output usingNamedTuples rather than plain Pythondicts. This makes the output more user-friendly, less error-prone, and easier to type hint. This refactoring also modifies the API behavior as follows:time_remainingfield for laundry machines can now beNoneif the laundry machine is unavailable (either out of service or offline).namefield that stores the user-facing name of the machine (A1, B3, G10, etc).Add unit tests for
laundry.pyto increase test coverage to 95%. The new tests use mocked data for Towers laundry machines, the vast majority of which are combo machines rather than standalone washers or dryers.Fix a heretofore unknown bug that was caught during the aforementioned unit testing: "washNdry" was misspelled as "washNDry", which was causing the API to mark all combo machines as "unknown". This typo hadn't been caught because there had been no unit tests that included data for combo machines.