Code Cleanup #8
Merged
Code Cleanup #8
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
There was the possibllity of falling through to an unset variable previously.
Type hints should be added whenever possible. This fixes missing return value hints for two methods.
Deleting the parameter when no users are present may cause dependent tools to fail instead of performing a no-op because it is empty.
Sorting the users that are turned into a comma delimited list makes it easier for manual interaction in the AWS console. The tool should be preferred, but we should still consider other interactions.
The ManageOperators.add_user() and ManageOperators.remove_user() methods were needlessly complicated about the return value. This simplifies them since the method they are relying on for functionality returns the same type of value.
Replace all of the f-strings with the substitution based log messaging that is preferred.
Single character variable names are generally discouraged for Python.
Simply of an over-complicated check in Schema validation. Remove an unnecessary else return usage.
mcdonnnj
added
bug
jsf9k
approved these changes
Feb 19, 2021
dav3r
approved these changes
Feb 19, 2021
| try: | ||
| # The SSM response on success currently only contains a version | ||
| # number and the parameter tier. | ||
| # Neither are useful to us at this time, so we don't store them.. |
There was a problem hiding this comment.
Is the double-period intentional here? I saw another one elsewhere.
Suggested change
| # Neither are useful to us at this time, so we don't store them.. | |
| # Neither are useful to us at this time, so we don't store them. |
There was a problem hiding this comment.
Nope, nice catch. Fixed both instances in 5b1711c.
It was pointed out in review that I had some unintentional double periods, so I have fixed them.
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.
🗣 Description
This PR is mostly just some housekeeping for this project. There is a bug fixed in 93798d3, and a potential side-effect is removed in 28c9247, but the bulk is some general polish. The logging has also been adjusted to
printfstyle that is preferred because oflogginglibrary internals.💭 Motivation and context
The bug I mentioned is a problem for anyone else trying to use this code in production. While I was fixing the aforementioned bug, I wanted to do some general housekeeping since this project was created before we moved to an "Initial Pull Request" model as talked about in the development guide.
🧪 Testing
Automated testing passes and some basic checks I ran locally gave expected results.
✅ Checklist