Refactor sqlquerybuilder for security and readability#1
Open
josesanch wants to merge 1 commit into
Open
Conversation
This commit introduces several improvements to the sqlquerybuilder library:
1. **Security:**
* Modified query construction (`Q`, `SQLCompiler`) to use parameterized queries (%s placeholders) and separate value lists. This is a critical change to prevent SQL injection vulnerabilities. The `SQLCompiler.sql` property and related methods now return a tuple of (sql_string, parameters_list).
* Updated all tests to reflect this new return type and verify correct parameter handling.
2. **Readability & Maintainability:**
* Applied PEP 8 styling throughout `sqlquerybuilder/__init__.py` for consistent formatting.
* Added comprehensive docstrings (module, class, method) and inline comments to `sqlquerybuilder/__init__.py` and `sqlquerybuilder/tests.py` to clarify functionality.
* Refactored the `Q._process` method by breaking down its logic into smaller, private helper methods for different lookup types. This makes the method shorter, easier to understand, and more extensible.
These changes significantly enhance the security, robustness, and maintainability of the library.
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.
This commit introduces several improvements to the sqlquerybuilder library:
Security:
Q,SQLCompiler) to use parameterized queries (%s placeholders) and separate value lists. This is a critical change to prevent SQL injection vulnerabilities. TheSQLCompiler.sqlproperty and related methods now return a tuple of (sql_string, parameters_list).Readability & Maintainability:
sqlquerybuilder/__init__.pyfor consistent formatting.sqlquerybuilder/__init__.pyandsqlquerybuilder/tests.pyto clarify functionality.Q._processmethod by breaking down its logic into smaller, private helper methods for different lookup types. This makes the method shorter, easier to understand, and more extensible.These changes significantly enhance the security, robustness, and maintainability of the library.