Remove or Explain Manual Testing Check Disables #60
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
Switch to the file line reading version of extracting the version from https://packaging.python.org/guides/single-sourcing-package-version/ instead of the exec method on the same page. The exec method required us to use a "# nosec" to manually disable Bandit checking on that line. Although that method is more straightforward, I do not feel that it is worth using an exec in the codebase when another option is available.
mcdonnnj
requested review from
dav3r,
felddy,
hillaryj and
jsf9k
as code owners
|
This pull request introduces 1 alert when merging 40b3b80 into 0f6efe0 - view on LGTM.com new alerts:
|
mcdonnnj
changed the title
cisagovbot
pushed a commit
that referenced
this pull request
Nov 18, 2020
Organize and Sort pre-commit Hooks
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 changes the code in
setup.pyused to get version information and adds a comment explaining why a Flake8 check is disabled. This closes #58 .💭 Motivation and Context
This project had two check disabling comments with no explanation: one each for Bandit and Flake8. The lines of code in question needed to either be changed to remove the need for disabling a check, or to have a comment explaining why the check disable was required. I felt it was better to refactor the code to remove the need for the Bandit check to be disabled. However the piece of code that needs a Flake8 check disabled is the most straightforward way to handle how we implement a Single Source of Truth for package versioning.
🧪 Testing
Automated tests pass.
✅ Checklist