Filter out pip freeze output starting w/ "[notice]" #508
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.
Intent
The std output executed from the command of
pip freezeis used to generate a project'srequirements.txtfile. As part ofpip's standard functionality, checks for new version availability are executed "intermittently". When new versions are detected, the std output line starts with[notice]. For example:Since every line from the std output that does not contain
reconnectis written into requirements.txt, the scenario where an upgrade is detected will cause the generatedrequirements.txtfile to be invalid.Resolves #270
Type of Change
Approach
Added filter to suppress the std output lines, which start with the text
[notice].Refactored filtering to allow testability.
Added test for filtering std output which contains and doesn't contain a line starting with `[notice]'
Automated Tests
The new unit tests should cover validation.
Directions for Reviewers
It is challenging to force the pip upgrade notices to occur. The best approach for validation is probably continuous no-harm validation.
Checklist