edit-user: unify reset behavior, **kwargs for editable fields
#535
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
Problem: The edit_user() function is clunky and could stand to undergo some improvements. Namely: - the reset behavior for editable fields is inconsistent. For example, an association's "projects" list can be reset with -1, but their "queues" list is reset with an empty string. - the function parameters define every editable field in the signature when it really could just use **kwargs. - The function allows "bank" to be edited for an association, which should not be allowed since associations, once created, are not deleted because they can continue to contribute to a bank's fair-share (up to the job usage reset period). Change the function's signature to use **kwargs for the editable fields. Remove "bank" as an editable field for an association. Unify the reset behavior for any of the editable fields by making -1 the keyword to reset the field to its default value. Add a function docstring description.
cmoussa1
force-pushed
the
edit-user.refactor
branch
from
81ad38d
to
ce952ec
Compare
jameshcorbett
approved these changes
Nov 22, 2024
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.
Problem
The
edit_user()function is clunky and could stand to undergo some improvements. Namely:projectslist can be reset with-1, but theirqueueslist is reset with an empty string.**kwargs.bankto be edited for an association, which should not be allowed since associations, once created, are not deleted because they can continue to contribute to a bank's fair-share (up to the job usage reset period).This PR changes the function's signature to use
**kwargsfor the editable fields and removes "bank" as an editable field for an association. It also unifies the reset behavior for any of the editable fields by making-1the keyword to reset the field to its default value.Finally, I've added a function docstring description.