No longer require that the number of targets match requirements #234
Conversation
There was a problem hiding this comment.
Thank you for the PR! 👍🏻
This functionality has been talked about before, and I have hesitated because it changes the behavior of the program. But on the other hand, the current functionality seems to be confusing and hard to use. So it might be a good idea to improve it.
The important thing here is to ensure that Vermin still functions as it is supposed to with all its many use cases.
Please add unit tests of the new function, compare_requirements(), in tests/general.py for when:
- Target major version missing from requirements
- v2 and v3 are specified
- Only v3 is specified
- Only v2 is specified
- Nothing is specified
- Some invalid values are specified
- And other cases, if you can think of any
brenns10
force-pushed
the
fix_mismatched_requirements
branch
2 times, most recently
from
a7df19d
to
7493521
Compare
|
Thanks for taking a look! I added unit tests for I didn't update or add any tests regarding the |
|
@brenns10 would you mind rebasing on top of my |
In --violations mode, the CLI requires that the number of "--target" specified is the same as the number of requirements. Many users no longer care about Python 2, but may write a simple file which is compatible with Python 2 by chance. In that case, Vermin will return a Python 2.x compatibility entry, and --violations will fail unless a target is specified for Python 2. However, there's no way to specify a target of "I don't care about this version", so these users would be forced to run with something like "-t=2.7- -t=3.6-". Except this would fail on their normal code, which is incompatible with Python 2.x. To get around this, start comparing by the major version of Python. Only compare the versions which are in common between the requirements and target. If there are no versions in common, fail. If a target major version is missing from the requirements, fail. This allows users who only specify a "3.x-" target to know that Vermin will succeed on any code, even simple code which is 2.x compatible too. This fixes netromdk#230. Signed-off-by: Stephen Brennan <stephen@brennan.io>
The tests are divided into three categories: one for the case where the code is Python 2 and 3 compatible, and one each for the cases where the code is exclusively Python 2 or 3 compatible. We cover the basic cases of exercising exact and non-exact target versions. We also cover the issues that come about when the targets can be missing, or incorrect. Signed-off-by: Stephen Brennan <stephen@brennan.io>
brenns10
force-pushed
the
fix_mismatched_requirements
branch
from
7493521
to
0c8574c
Compare
|
Done! |
|
There we go. Merged 🎉 |
|
@netromdk Thank you so much! |
In --violations mode, the CLI requires that the number of "--target" specified is the same as the number of requirements. Many users no longer care about Python 2, but may write a simple file which is compatible with Python 2 by chance. In that case, Vermin will return a Python 2.x compatibility entry, and --violations will fail unless a target is specified for Python 2. However, there's no way to specify a target of "I don't care about this version", so these users would be forced to run with something like "-t=2.7- -t=3.6-". Except this would fail on their normal code, which is incompatible with Python 2.x.
To get around this, start comparing by the major version of Python. Only compare the versions which are in common between the requirements and target. If there are no versions in common, fail. If a target major version is missing from the requirements, fail.
This allows users who only specify a "3.x-" target to know that Vermin will succeed on any code, even simple code which is 2.x compatible too.
This fixes #230.