Add checker for relationship backref usage #36
Merged
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.
Related to #25
This pull request introduces a new checker to the flake8-sqlalchemy plugin that detects the use of
backref
in SQLAlchemyrelationship()
calls and recommends usingback_populates
instead. This change aims to encourage best practices in SQLAlchemy relationship definitions.RelationshipBackrefChecker
inflake8_sqlalchemy/checkers/relationship_backref_checker.py
to scan forrelationship()
calls that usebackref
and suggestback_populates
.flake8_sqlalchemy/checkers/__init__.py
andflake8_sqlalchemy/plugin.py
to include the newRelationshipBackrefChecker
in the list of checkers and in the visitor's checker dictionary, respectively.tests/checkers/test_relationship_backref_checker.py
to verify that the checker accurately identifiesrelationship()
calls withbackref
and does not raise false positives for those usingback_populates
.For more details, open the Copilot Workspace session.