Remove __str__ methods from models #234
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
When comparing model objects, Django will compare only the ID of the models. As we are moving away from using models in templates, we should compare against something more sensible: the module name.
Before this change, we relied on a string representation of the ProjectVersion model in each of these places, but display logic should not belong on models. We now build the required display information outside of the ProjectVersion model.
Before this change, we relied on a string representation of the Module model, but display logic should not belong on models. We only needed to get the module name in one place, and use it in two. We now pass a string to the template instead of a whole model.
Before this change, we relied on a string representation of the Klass model, but display logic should not belong on models. We now use the required field directly in templates instead.
We don't ever rely on these representations directly in the UI.
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.
Before this change, we relied on a string representation of the models in the UI, but display logic should not belong on models.
We now build the display information outside the models as required.
These methods might still be useful for debugging, but as we're on a journey to remove the models altogether, I don't think they're worth keeping.