fix: use a lifx lib logger instead of root and suppress #822
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
WalkthroughThe changes focus on standardizing logging practices in the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (4)
- ledfx/main.py (1 hunks)
- ledfx/libraries/lifxdev/init.py (1 hunks)
- ledfx/libraries/lifxdev/devices/device_manager.py (4 hunks)
- ledfx/libraries/lifxdev/messages/packet.py (5 hunks)
Additional comments: 9
ledfx/libraries/lifxdev/__init__.py (1)
- 5-6: The implementation of
get_library_loggercorrectly establishes a dedicated logger for thelifxdevlibrary, aligning with best practices for logging in Python.ledfx/__main__.py (1)
- 99-99: Setting the logging level for "lifxdev" to WARNING within the
setup_loggingfunction is a strategic decision that aligns with the PR objectives to reduce verbosity. This change is correctly implemented.ledfx/libraries/lifxdev/devices/device_manager.py (1)
- 18-20: The introduction of a logger instance using
get_library_logger()and the replacement of direct logging calls with this instance are correctly implemented, aligning with the PR objectives to standardize logging across thelifxdevlibrary.ledfx/libraries/lifxdev/messages/packet.py (6)
- 16-16: The import statement for
get_library_loggeris correctly added to obtain the logger instance for thelifxdevlibrary. This aligns with the PR objectives to standardize logging through a dedicated logger.- 22-22: The instantiation of the logger using
get_library_logger()is correctly placed outside of any class or function, ensuring it is available globally within this module. This is a good practice for logging, as it allows for consistent use of the logger throughout the module.- 682-682: The assignment of
self._log_funcbased on theverboseflag is a clever way to dynamically switch between logging levels (infoanddebug). This approach enhances the flexibility of logging, allowing for more or less verbosity as needed without changing the logging configuration.- 905-905: The use of
log_funcwithin thesendmethod to conditionally log messages at either theinfoordebuglevel, depending on theverboseflag, is consistent with the approach taken in thePacketCommconstructor. This consistency in handling verbosity across methods is commendable.- 925-925: Similarly, the use of
log_funcwithin therecvmethod to conditionally log messages at the appropriate level based on theverboseflag demonstrates a consistent and flexible approach to logging throughout thePacketCommclass.- 16-16: While the import of
get_library_loggeris correctly placed, it's important to ensure that theledfx.libraries.lifxdevmodule indeed contains this function. This is a critical dependency for the logging changes to work as intended.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (3)
- ledfx/libraries/lifxdev/init.py (1 hunks)
- ledfx/libraries/lifxdev/devices/device_manager.py (3 hunks)
- ledfx/libraries/lifxdev/messages/packet.py (5 hunks)
Files skipped from review as they are similar to previous changes (3)
- ledfx/libraries/lifxdev/init.py
- ledfx/libraries/lifxdev/devices/device_manager.py
- ledfx/libraries/lifxdev/messages/packet.py
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.
with -vv lifxdex lib is pumping out message debug each frame.
Existing lib which is carried in our source ( not sure of the history here, not keen on it ) uses the root logger
These changes establish a lifxdev logger in line with the lib naming, and then suppresses to warning by default in ledfx main
Summary by CodeRabbit