Merge all changes on Dev branch to Main for release 0.2.5 #6
Conversation
…and development setup
There was a problem hiding this comment.
Pull Request Overview
This PR bumps the version from 0.2.4 to 0.2.5 and introduces a new --output feature for the CLI that allows saving command outputs to files in various formats (JSON, XML, plain text), while also cleaning up unused exports and fixing string formatting issues.
Key changes:
- Added
--outputCLI argument to save command results to JSON, XML, or plain text files with automatic format detection - Removed
ONVIFOperatorfrom the public API exports in__init__.py - Fixed f-string usage where f-strings were unnecessary (changed to regular strings)
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Version bump to 0.2.5 |
| onvif/cli/main.py | Added --output feature with format detection, new helper functions for serialization, and validation logic |
| onvif/cli/interactive.py | Updated version string in ASCII art banner |
| onvif/init.py | Removed ONVIFOperator from public exports |
| examples/logger.py | Fixed unnecessary f-string usage |
| examples/error_handling.py | Fixed unnecessary f-string usage in multiple locations |
| examples/add_media_profile.py | Fixed unnecessary f-string usage |
| README_ID.md | Updated version badges, improved library philosophy section, added output examples |
| README.md | Updated version badges, improved library philosophy section, added output examples |
| CONTRIBUTING.md | Updated contribution guidelines to target dev branch and improved setup instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Save output to file if specified | ||
| if args.output: | ||
| # Auto-enable debug mode for XML output | ||
| effective_debug = args.debug or args.output.lower().endswith(".xml") |
There was a problem hiding this comment.
The debug mode calculation is duplicated here and at line 281-283 (as auto_debug). Consider using the auto_debug variable directly instead of recalculating effective_debug to avoid code duplication. You could pass auto_debug to the function instead of recalculating.
| effective_debug = args.debug or args.output.lower().endswith(".xml") | |
| effective_debug = auto_debug |
There was a problem hiding this comment.
No need, because debugging is needed because the desired output file is XML.
onvif/cli/main.py
Outdated
| output_data = {} | ||
|
|
||
| if ext == ".json": |
There was a problem hiding this comment.
The output_data dictionary is initialized but only used in the JSON branch (line 392-405). Move this initialization inside the if ext == \".json\": block to improve code clarity and avoid unnecessary variable initialization.
| output_data = {} | |
| if ext == ".json": | |
| if ext == ".json": | |
| output_data = {} |
There was a problem hiding this comment.
Ok, let's use this change.
…ying exception types
No description provided.