Conversation
- Add MAX_RESPONSE_SIZE constant (1 MB) to prevent unbounded buffer growth - Replace infinite loop with bounded loop: 'while len(response) < MAX_RESPONSE_SIZE' - Add warning log when response exceeds maximum size - Fix socket test mock setup to work with closing() context manager - Fix socket client initialization test to handle mock binding correctly Fixes unit tests hanging due to memory exhaustion or timeout issues. All 82 tests now pass in ~6 seconds instead of timing out.
Include pytest, pytest-cov, and defusedxml in dev extras to ensure tests can run properly and security-focused XML parsing is available.
Fix/unbounded socket buffer
- Add tests workflow that runs linting, type checking, security checks, and pytest with coverage - Add deploy-docs workflow to publish mkdocs documentation to GitHub Pages - Update mkdocs.yml repo URL to actual GitHub repository
- Remove unused imports from test files and source modules - Add return type annotations to CLI command functions in main.py - Fix type hints for optional CLI parameters (Optional[str] instead of str) - Add type: ignore comments for untyped typer decorators - Fix bare except clause in http.py client initialization - Add type: ignore for requests.json() return type - Rename 'list' function to avoid built-in shadowing (add noqa comment) All 82 tests pass, ruff and mypy checks now pass cleanly.
- Add mypy overrides for meter_reader.main module - Disable untyped-decorator and import-not-found errors for main.py - This allows using typer without type stubs while maintaining strict typing elsewhere - All tests (82), linting (ruff), and type checking (mypy) pass successfully
The expected XML parsing warnings from defusedxml usage are acceptable. Continue the workflow even if bandit finds issues, but still log them.
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
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.
Summary
This PR modernizes the Meter Reader project with significant improvements:
EagleHttpClientfor gateway communication via HTTPRecent Test Fixes
Key Changes
New Files
src/meter_reader/- Reorganized package structuresrc/meter_reader/clients/- Socket and HTTP client implementationssrc/meter_reader/models.py- Pydantic models for type safetysrc/meter_reader/utils.py- Utility functions for XML generationdocs/- API documentation with mkdocstests/- Comprehensive test suiteRemoved Files
meter_reader/- Old package structuresetup.py,setup.cfg- Replaced by pyproject.tomlREADME.rst- Replaced by README.mdConfiguration
pyproject.toml- Modern Python packaging config.editorconfig- Consistent coding styles.gitignore- Comprehensive ignore patternsBreaking Changes
mr -c commandtomr commandEagleSocketClientandEagleHttpClient