Refactor for initial public release #5
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
- Remove logging.basicConfig() calls. Must be done by client. - Make logging instances private. - Move entity creation log statement to base class.
- best effort in broadcast_ws_event - add more type information - add docstrings
The client may only listen to events, but not take control over the event emitter or know about the internals.
Add a command handler on the Entity. This will simplify the client command handling significantly: - configured entity is passed as argument - basic error checking is done in the library - websocket stays hidden - command acknowledgment is implemented in the library
Don't expose websocket or request ids. Setup flow is controlled by new data classes: - Return object is the next step in the setup flow. - The client should not have to know or call driver_setup_error, request_driver_setup_user_input, etc.
Use ENV var UC_CONFIG_HOME for configuration directory, fallback to HOME directory or local path.
- exclude fixme tags - don't allow any issues anymore besides disabled ones
martonborzak
approved these changes
Oct 30, 2023
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.
This PR is a major refactoring for v0.1.0 to make this library a bit more Pythonic and follow the official Python style guides.
Fixed
UC_MDNS_LOCAL_HOSTNAMEallows to override the local hostname.UC_INTEGRATION_INTERFACEandUC_INTEGRATION_HTTP_PORTare optionalChanged
Prepare project for public release:
Closes #1
Fixes #2
Fixes #3