refactor: Improve platform module code quality and documentation #97
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
Member
privateip
commented
Dec 12, 2025
privateip
commented
- Fix incorrect exception attribute access (exc.message -> exc)
- Rename authenticate_user() to authenticate_basicauth() for consistency
- Replace non-Pythonic boolean check (is True -> truthiness)
- Update platform_factory return type from Any to Platform | AsyncPlatform
- Convert simple helper functions to module constants (_OAUTH_PATH, etc.)
- Remove redundant docstring sections (Args: None, Raises: None)
- Add comprehensive Google-style docstrings for all classes and methods
- Fix missing token extraction in AsyncAuthMixin.authenticate_oauth()
- Update all tests to match renamed methods and new exception handling
- Fix import sorting in test file
- Fix incorrect exception attribute access (exc.message -> exc) - Rename authenticate_user() to authenticate_basicauth() for consistency - Replace non-Pythonic boolean check (is True -> truthiness) - Update platform_factory return type from Any to Platform | AsyncPlatform - Convert simple helper functions to module constants (_OAUTH_PATH, etc.) - Remove redundant docstring sections (Args: None, Raises: None) - Add comprehensive Google-style docstrings for all classes and methods - Fix missing token extraction in AsyncAuthMixin.authenticate_oauth() - Update all tests to match renamed methods and new exception handling - Fix import sorting in test file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.