Refactor(users): use enum.Enum for GRADE_NUMBERS
#1625
Closed
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
Implemented a __contains__ to check if item is in enum test(preferences): remove unused import test: run scripts test(codacy): use f-string
|
Hi Aarush. Thanks for the PR! I understand (and agree) with you on the benefits of enums, but in this case, I think the current implementation is better. 2D arrays mesh much better with how django normally wants field choices organized (like in the grade_number field on photos, where you convert the enum to a 2D array anyways). Since User is such a core model in ion, this change would be hard to test, and may lead to unexpected behavior in other apps, for not much actual benefit in code quality. Because of that, we can't accept this change and encourage you to work on other issues you find instead — issues tagged with “good first issue” are a great place to start. |
|
Makes sense, I'll close this PR then! |
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.
Proposed changes
GRADE_NUMBERSinstead of a 2D arrayBrief description of rationale
Python enums are much more flexible and readable then a 2D array. You can read a nice answer about their benefits here
Comments
It is recommended that attributes of enums should be in all caps but in order to make the PR easier to review (smaller diff) I chose to make the attributes of the enum lowercase.