Supress some protected-access warnings when django-simple-history is installed. #423
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
|
I know this is missing a test. I would first like to bring it up for discussion/feedback before adding one. I am working on a codebase that has 24 cases (and counting) where the specific warning is suppressed for |
…installed. django-simple-hisory is a fairly popular [1] package for keeping track of changes in django objects. Setting the `_change_reason` property of an object is the officially documented way to provide a value for the `history_change_reason` field of historical objects [2]. When django-simple-hisory is installed, protected-access warnings for setting `_change_reason` is most likely a false positive, and should be supressed. Because of inherent limitations of pylint, this may lead to some false negatives if `_change_reason` is used elsewhere. [1] https://pypistats.org/packages/django-simple-history [2] https://django-simple-history.readthedocs.io/en/latest/historical_model.html#change-reason
m000
force-pushed
the
simple_history_change_reason
branch
from
655ebf2
to
438151f
Compare
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.
django-simple-hisory is a fairly popular [1] package for keeping track of changes in django objects. Setting the
_change_reasonproperty of an object is the officially documented way to provide a value for thehistory_change_reasonfield of historical objects [2].When django-simple-hisory is installed, protected-access warnings for setting
_change_reasonis most likely a false positive, and should be supressed.Because of inherent limitations of pylint, this may lead to some false negatives if
_change_reasonis used elsewhere.[1] https://pypistats.org/packages/django-simple-history
[2] https://django-simple-history.readthedocs.io/en/latest/historical_model.html#change-reason