Improve incorrect base class checker #72
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
snaselj
commented
Jan 29, 2024
Kircheneer
approved these changes
Feb 6, 2024
whitej6
reviewed
Feb 9, 2024
| _CLASS_MAPPING = ( | ||
| { | ||
| "incorrect": "django_filters.filters.FilterSet", | ||
| "correct": "django_filters.filters.BaseFilterSet", |
There was a problem hiding this comment.
Suggested change
| "correct": "django_filters.filters.BaseFilterSet", | |
| "correct": "nautobot.apps.filters.NautobotFilterSet", |
whitej6
reviewed
Feb 9, 2024
| }, | ||
| { | ||
| "incorrect": "django.db.models.base.Model", | ||
| "correct": "nautobot.core.models.BaseModel", |
There was a problem hiding this comment.
Not sure if we support OR but Primary should always be the preferred and base is only used for custom through tables and a few other scenarios.
Suggested change
| "correct": "nautobot.core.models.BaseModel", | |
| "correct": ["nautobot.apps.models.PrimaryModel","nautobot.apps.models.BaseModel"] |
There was a problem hiding this comment.
PrimaryModel is a BaseModel descendant. If we want to allow BaseModel to be used, it covers PrimaryModel as well.
One simple option is to enforce PrimaryModel, instead of BaseModel. In such case, using BaseModel only would have to be disabled by # pylint: disable=nb-incorrect-base-class macro.
There was a problem hiding this comment.
PrimaryModel is enforced now.
…into u/snaselj-incorrect-base-class
|
All comments has been addressed, this pull request is ready for review. |
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.
Closes NaN
What's Changed
ModelFormto incorrect classes checker.