Remove incorrect use of identity (is) comparisons #3061
Merged
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.
Details
While triaging your project, our bug-fixing tool generated the following message(s)-
In this first case, the line 58 of the file convert.py, method: convert_problem is as follows:
In this second case, the line 263 of the file shellcmd.py, method: _apply_solver is as follows:
In this third case, the line 53 of the file NEOS.py, method: create_command_line is as follows:
In python, the
is
operator checks for identity, not equality. This means that theis
operator checks whether the two operands refer to the same object or not. In the mentioned cases,[None]
is a list with None element and[]
is an empty list. However, the[None]
is a new object and is not the same as thesource_ptype
variable being compared with. Similarly,[]
is not the same as theself._problem_files
variable. As a result, theis
operator will always evaluate to False, andis not
will always evaluate to True. We can test this scenerio by running the following code in python:Here, the
is
operator evaluates the expression to returnFalse
. However, it should have returnedTrue
.Changes
is
operator is replaced with==
operator. Similarly, in the line 263 of the file shellcmd.py, method: _apply_solver and the line 53 of the file NEOS.py, method: create_command_line, theis not
operators are replaced with!=
operators.Suggestions related to these changes are welcomed.
CLA Requirements
This section is only relevant if your project requires contributors to sign a Contributor License Agreement (CLA) for external contributions.
All contributed commits are already automatically signed off.
The meaning of a signoff depends on the project, but it typically certifies that committer has the rights to submit this work under the same license and agrees to a Developer Certificate of Origin (see https://developercertificate.org/ for more information).
Git Commit SignOff documentation
Sponsorship and Support
This work is done by the security researchers from OpenRefactory and is supported by the Open Source Security Foundation (OpenSSF): Project Alpha-Omega. Alpha-Omega is a project partnering with open source software project maintainers to systematically find new, as-yet-undiscovered vulnerabilities in open source code - and get them fixed – to improve global software supply chain security.
The bug is found by running the Intelligent Code Repair (iCR) tool by OpenRefactory and then manually triaging the results.
Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: