Skip to content

Python: __bool__ does not raise TypeError by default #3460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 15, 2020
Merged

Python: __bool__ does not raise TypeError by default #3460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6a35c6b
Test: __bool__ does not raise TypeError by default
RasmusSemmle May 12, 2020
d9d86e1
Make test pass
RasmusSemmle May 13, 2020
e5eadf9
Update python/ql/test/query-tests/Functions/general/protocols.py
yoff May 14, 2020
7b004c3
Python: Add test for wrong exception type
yoff May 14, 2020
1817d2a
Make test for wrong bool type pass
yoff May 14, 2020
21d1ea5
Merge branch 'boolDefault' of github.com:yoff/codeql into boolDefault
yoff May 14, 2020
1b0687e
Python: update expectations correctly
yoff May 15, 2020
60d5ba2
Python: Move test into appropriate class.
yoff May 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions python/ql/src/Functions/IncorrectRaiseInSpecialMethod.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,6 @@ private predicate ordering_method(string name) {
private predicate cast_method(string name) {
name = "__nonzero__" and major_version() = 2
or
name = "__bool__"
or
name = "__int__"
or
name = "__float__"
Expand Down Expand Up @@ -118,6 +116,8 @@ predicate preferred_raise(string name, ClassObject ex) {
ordering_method(name) and ex = theTypeErrorType()
or
arithmetic_method(name) and ex = Object::builtin("ArithmeticError")
or
name = "__bool__" and ex = theTypeErrorType()
}

predicate no_need_to_raise(string name, string message) {
Expand Down
1 change: 1 addition & 0 deletions python/ql/test/query-tests/Functions/general/IncorrectRaiseInSpecialMethod.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
| protocols.py:98:5:98:33 | Function __getitem__ | Function always raises $@; raise LookupError instead | file://:Compiled Code:0:0:0:0 | builtin-class ZeroDivisionError | builtin-class ZeroDivisionError |
| protocols.py:101:5:101:26 | Function __getattr__ | Function always raises $@; raise AttributeError instead | file://:Compiled Code:0:0:0:0 | builtin-class ZeroDivisionError | builtin-class ZeroDivisionError |
| protocols.py:104:5:104:23 | Function __bool__ | Function always raises $@; raise TypeError instead | file://:Compiled Code:0:0:0:0 | builtin-class ZeroDivisionError | builtin-class ZeroDivisionError |
4 changes: 2 additions & 2 deletions python/ql/test/query-tests/Functions/general/SignatureSpecialMethods.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
| om_test.py:71:5:71:19 | Function WrongSpecials.__repr__ | Too few parameters for special method __repr__, which has no parameters, but should have 1, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
| om_test.py:74:5:74:46 | Function WrongSpecials.__add__ | 1 default values(s) will never be used for special method __add__, in class $@. | om_test.py:57:1:57:28 | class WrongSpecials | WrongSpecials |
| om_test.py:97:15:97:34 | Function NotOKSpecials.lambda | Too few parameters for special method __sub__, which has 1 parameter, but should have 2, in class $@. | om_test.py:95:1:95:28 | class NotOKSpecials | NotOKSpecials |
| protocols.py:104:1:104:12 | Function f | Too few parameters for special method __add__, which has 1 parameter, but should have 2, in class $@. | protocols.py:107:1:107:29 | class MissingMethods | MissingMethods |
| protocols.py:104:1:104:12 | Function f | Too few parameters for special method __set__, which has 1 parameter, but should have 3, in class $@. | protocols.py:107:1:107:29 | class MissingMethods | MissingMethods |
| protocols.py:107:1:107:12 | Function f | Too few parameters for special method __add__, which has 1 parameter, but should have 2, in class $@. | protocols.py:110:1:110:29 | class MissingMethods | MissingMethods |
| protocols.py:107:1:107:12 | Function f | Too few parameters for special method __set__, which has 1 parameter, but should have 3, in class $@. | protocols.py:110:1:110:29 | class MissingMethods | MissingMethods |
8 changes: 8 additions & 0 deletions python/ql/test/query-tests/Functions/general/protocols.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ def __getitem__(self, index):
def __getattr__(self):
raise ZeroDivisionError()

def __bool__(self):
raise ZeroDivisionError()

def f(self):
pass

Expand All @@ -116,3 +119,8 @@ class OK(object):
def __call__(self):
yield 0
raise StopIteration

# __bool__ returns `True` by default, so raising `TypeError` should not give an alert
# FP reported in https://github.com/github/codeql/issues/2388
def __bool__(self):
raise TypeError