hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-27 09:45:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20038 from joefarebrother/python-qual-comparison

Browse Source 
Python: Modernize 3 quality queries for comparison methods
This commit is contained in:
Joe Farebrother
2025-08-28 09:37:20 +01:00
committed by GitHub
parent 028f1cb7b4 3a27758d85
commit bde143e4c1
49 changed files with 549 additions and 556 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
python/ql/test/2/query-tests/Classes/equals-hash/EqualsOrHash.expected
View File

@@ -1,2 +0,0 @@
| equals_hash.py:8:5:8:28 | Function Eq.__eq__ | Class $@ implements __eq__ but does not define __hash__. | equals_hash.py:3:1:3:17 | class Eq | Eq |
| equals_hash.py:24:5:24:23 | Function Hash.__hash__ | Class $@ implements __hash__ but does not define __eq__ or __cmp__. | equals_hash.py:19:1:19:19 | class Hash | Hash |

1
python/ql/test/2/query-tests/Classes/equals-hash/EqualsOrHash.qlref
View File

@@ -1 +0,0 @@
Classes/EqualsOrHash.ql

2
python/ql/test/2/query-tests/Classes/equals-hash/EqualsOrNotEquals.expected
View File

@@ -1,2 +0,0 @@
| equals_hash.py:8:5:8:28 | Function Eq.__eq__ | Class $@ implements __eq__ but does not implement __ne__. | equals_hash.py:3:1:3:17 | class Eq | Eq |
| equals_hash.py:16:5:16:28 | Function Ne.__ne__ | Class $@ implements __ne__ but does not implement __eq__. | equals_hash.py:11:1:11:17 | class Ne | Ne |

1
python/ql/test/2/query-tests/Classes/equals-hash/EqualsOrNotEquals.qlref
View File

@@ -1 +0,0 @@
Classes/EqualsOrNotEquals.ql

63
python/ql/test/2/query-tests/Classes/equals-hash/equals_hash.py
View File

@@ -1,63 +0,0 @@
#Equals and hash
class Eq(object):
def __init__(self, data):
self.data = data
def __eq__(self, other):
return self.data == other.data
class Ne(object):
def __init__(self, data):
self.data = data
def __ne__(self, other):
return self.data != other.data
class Hash(object):
def __init__(self, data):
self.data = data
def __hash__(self):
return hash(self.data)
class Unhashable1(object):
__hash__ = None
class EqOK1(Unhashable1):
def __eq__(self, other):
return False
def __ne__(self, other):
return True
class Unhashable2(object):
#Not the idiomatic way of doing it, but not uncommon either
def __hash__(self):
raise TypeError("unhashable object")
class EqOK2(Unhashable2):
def __eq__(self, other):
return False
def __ne__(self, other):
return True
class ReflectiveNotEquals(object):
def __ne__(self, other):
return not self == other
class EqOK3(ReflectiveNotEquals, Unhashable1):
def __eq__(self, other):
return self.data == other.data

1
python/ql/test/3/query-tests/Classes/equals-hash/EqualsOrHash.expected
View File

@@ -1 +0,0 @@
| equals_hash.py:24:5:24:23 | Function Hash.__hash__ | Class $@ implements __hash__ but does not define __eq__. | equals_hash.py:19:1:19:19 | class Hash | Hash |

1
python/ql/test/3/query-tests/Classes/equals-hash/EqualsOrHash.qlref
View File

@@ -1 +0,0 @@
Classes/EqualsOrHash.ql

63
python/ql/test/3/query-tests/Classes/equals-hash/equals_hash.py
View File

@@ -1,63 +0,0 @@
#Equals and hash
class Eq(object):
def __init__(self, data):
self.data = data
def __eq__(self, other):
return self.data == other.data
class Ne(object):
def __init__(self, data):
self.data = data
def __ne__(self, other):
return self.data != other.data
class Hash(object):
def __init__(self, data):
self.data = data
def __hash__(self):
return hash(self.data)
class Unhashable1(object):
__hash__ = None
class EqOK1(Unhashable1):
def __eq__(self, other):
return False
def __ne__(self, other):
return True
class Unhashable2(object):
#Not the idiomatic way of doing it, but not uncommon either
def __hash__(self):
raise TypeError("unhashable object")
class EqOK2(Unhashable2):
def __eq__(self, other):
return False
def __ne__(self, other):
return True
class ReflectiveNotEquals(object):
def __ne__(self, other):
return not self == other
class EqOK3(ReflectiveNotEquals, Unhashable1):
def __eq__(self, other):
return self.data == other.data

1
python/ql/test/3/query-tests/Classes/equals-ne/EqualsOrNotEquals.expected
View File

@@ -1 +0,0 @@
| test.py:9:5:9:28 | Function NotOK2.__ne__ | Class $@ implements __ne__ but does not implement __eq__. | test.py:7:1:7:13 | class NotOK2 | NotOK2 |

1
python/ql/test/3/query-tests/Classes/equals-ne/EqualsOrNotEquals.qlref
View File

@@ -1 +0,0 @@
Classes/EqualsOrNotEquals.ql

10
python/ql/test/3/query-tests/Classes/equals-ne/test.py
View File

@@ -1,10 +0,0 @@
class OK:
def __eq__(self, other):
return False
class NotOK2:
def __ne__(self, other):
return True

1
python/ql/test/query-tests/Classes/equals-attr/DefineEqualsWhenAddingAttributes.expected
View File

@@ -0,0 +1 @@
| attr_eq_test.py:21:1:21:27 | class BadColorPoint | The class 'BadColorPoint' does not override $@, but adds the new attribute $@. | attr_eq_test.py:10:5:10:28 | Function Point.__eq__ | '__eq__' | attr_eq_test.py:25:9:25:19 | Attribute | _color |

0
python/ql/test/query-tests/Classes/equals-hash/attr_eq_test.py → python/ql/test/query-tests/Classes/equals-attr/attr_eq_test.py
View File

1
python/ql/test/query-tests/Classes/equals-hash/DefineEqualsWhenAddingFields.expected
View File

@@ -1 +0,0 @@
| attr_eq_test.py:21:1:21:27 | class BadColorPoint | The class 'BadColorPoint' does not override $@, but adds the new attribute $@. | attr_eq_test.py:10:5:10:28 | Function Point.__eq__ | '__eq__' | attr_eq_test.py:25:9:25:19 | Attribute | _color |

1
python/ql/test/query-tests/Classes/equals-hash/DefineEqualsWhenAddingFields.qlref
View File

@@ -1 +0,0 @@
Classes/DefineEqualsWhenAddingAttributes.ql

2
python/ql/test/query-tests/Classes/equals-hash/EqualsOrHash.expected Normal file
View File

@@ -0,0 +1,2 @@
| equalsHash.py:13:1:13:8 | Class C | This class implements $@, but does not implement __eq__. | equalsHash.py:14:5:14:23 | Function __hash__ | __hash__ |
| equalsHash.py:17:1:17:11 | Class D | This class implements $@, but does not implement __eq__. | equalsHash.py:18:5:18:23 | Function __hash__ | __hash__ |

2
python/ql/test/query-tests/Classes/equals-hash/EqualsOrHash.qlref Normal file
View File

@@ -0,0 +1,2 @@
query: Classes/Comparisons/EqualsOrHash.ql
postprocess: utils/test/InlineExpectationsTestQuery.ql

19
python/ql/test/query-tests/Classes/equals-hash/equalsHash.py Normal file
View File

@@ -0,0 +1,19 @@
class A:
def __eq__(self, other):
return True
def __hash__(self):
return 7
# B is automatically non-hashable - so eq without hash never needs to alert
class B:
def __eq__(self, other):
return True
class C: # $ Alert
def __hash__(self):
return 5
class D(A): # $ Alert
def __hash__(self):
return 4

2
python/ql/test/query-tests/Classes/equals-not-equals/EqualsOrNotEquals.expected Normal file
View File

@@ -0,0 +1,2 @@
| EqualsOrNotEquals.py:14:1:14:8 | Class B | This class implements $@, but does not implement __eq__. | EqualsOrNotEquals.py:19:5:19:28 | Function __ne__ | __ne__ |
| EqualsOrNotEquals.py:37:1:37:11 | Class D | This class implements $@, but does not implement __ne__. | EqualsOrNotEquals.py:43:5:43:28 | Function __eq__ | __eq__ |

147
python/ql/test/query-tests/Classes/equals-not-equals/EqualsOrNotEquals.py Normal file
View File

@@ -0,0 +1,147 @@
class A:
def __init__(self, a):
self.a = a
# OK: __ne__ if not defined delegates to eq automatically
def __eq__(self, other):
return self.a == other.a
assert (A(1) == A(1))
assert not (A(1) == A(2))
assert not (A(1) != A(1))
assert (A(1) != A(2))
class B: # $ Alert
def __init__(self, b):
self.b = b
# BAD: eq defaults to `is`
def __ne__(self, other):
return self.b != other.b
assert not (B(1) == B(1)) # potentially unexpected
assert not (B(2) == B(2))
assert not (B(1) != B(1))
assert (B(1) != B(2))
class C:
def __init__(self, c):
self.c = c
def __eq__(self, other):
return self.c == other.c
def __ne__(self, other):
return self.c != other.c
class D(C): # $ Alert
def __init__(self, c, d):
super().__init__(c)
self.d = d
# BAD: ne is not defined, but the superclass ne is used instead of delegating, which may be incorrect
def __eq__(self, other):
return self.c == other.c and self.d == other.d
assert (D(1,2) == D(1,2))
assert not (D(1,2) == D(1,3))
assert (D(1,2) != D(3,2))
assert not (D(1,2) != D(1,3)) # Potentially unexpected
class E:
def __init__(self, e):
self.e = e
def __eq__(self, other):
return self.e == other.e
def __ne__(self, other):
return not self.__eq__(other)
class F(E):
def __init__(self, e, f):
super().__init__(e)
self.f = f
# OK: superclass ne delegates to eq
def __eq__(self, other):
return self.e == other.e and self.f == other.f
assert (F(1,2) == F(1,2))
assert not (F(1,2) == F(1,3))
assert (F(1,2) != F(3,2))
assert (F(1,2) != F(1,3))
# Variations
class E2:
def __init__(self, e):
self.e = e
def __eq__(self, other):
return self.e == other.e
def __ne__(self, other):
return not self == other
class F2(E2):
def __init__(self, e, f):
super().__init__(e)
self.f = f
# OK: superclass ne delegates to eq
def __eq__(self, other):
return self.e == other.e and self.f == other.f
assert (F2(1,2) == F2(1,2))
assert not (F2(1,2) == F2(1,3))
assert (F2(1,2) != F2(3,2))
assert (F2(1,2) != F2(1,3))
class E3:
def __init__(self, e):
self.e = e
def __eq__(self, other):
return self.e == other.e
def __ne__(self, other):
return not other.__eq__(self)
class F3(E3):
def __init__(self, e, f):
super().__init__(e)
self.f = f
# OK: superclass ne delegates to eq
def __eq__(self, other):
return self.e == other.e and self.f == other.f
assert (F3(1,2) == F3(1,2))
assert not (F3(1,2) == F3(1,3))
assert (F3(1,2) != F3(3,2))
assert (F3(1,2) != F3(1,3))
class E4:
def __init__(self, e):
self.e = e
def __eq__(self, other):
return self.e == other.e
def __ne__(self, other):
return not other == self
class F4(E4):
def __init__(self, e, f):
super().__init__(e)
self.f = f
# OK: superclass ne delegates to eq
def __eq__(self, other):
return self.e == other.e and self.f == other.f
assert (F4(1,2) == F4(1,2))
assert not (F4(1,2) == F4(1,3))
assert (F4(1,2) != F4(3,2))
assert (F4(1,2) != F4(1,3))

2
python/ql/test/query-tests/Classes/equals-not-equals/EqualsOrNotEquals.qlref Normal file
View File

@@ -0,0 +1,2 @@
query: Classes/Comparisons/EqualsOrNotEquals.ql
postprocess: utils/test/InlineExpectationsTestQuery.ql

3
python/ql/test/query-tests/Classes/incomplete-ordering/IncompleteOrdering.expected
View File

@@ -1 +1,2 @@
| incomplete_ordering.py:3:1:3:26 | class PartOrdered | Class PartOrdered implements $@, but does not implement __le__ or __gt__ or __ge__. | incomplete_ordering.py:13:5:13:28 | Function PartOrdered.__lt__ | __lt__ |
| incomplete_ordering.py:3:1:3:26 | Class LtWithoutLe | This class implements $@, but does not implement __le__ or __ge__. | incomplete_ordering.py:13:5:13:28 | Function __lt__ | __lt__ |
| incomplete_ordering.py:28:1:28:17 | Class LendGeNoLt | This class implements $@, but does not implement __lt__ or __gt__. | incomplete_ordering.py:29:5:29:28 | Function __le__ | __le__ |

3
python/ql/test/query-tests/Classes/incomplete-ordering/IncompleteOrdering.qlref
View File

@@ -1 +1,2 @@
Classes/IncompleteOrdering.ql
query: Classes/Comparisons/IncompleteOrdering.ql
postprocess: utils/test/InlineExpectationsTestQuery.ql

30
python/ql/test/query-tests/Classes/incomplete-ordering/incomplete_ordering.py
View File

@@ -1,6 +1,6 @@
#Incomplete ordering
class PartOrdered(object):
class LtWithoutLe(object): # $ Alert
def __eq__(self, other):
return self is other
@@ -13,6 +13,28 @@ class PartOrdered(object):
def __lt__(self, other):
return False
#Don't blame a sub-class for super-class's sins.
class DerivedPartOrdered(PartOrdered):
pass
# Don't alert on subclass
class LtWithoutLeSub(LtWithoutLe):
pass
class LeSub(LtWithoutLe):
def __le__(self, other):
return self < other or self == other
class GeSub(LtWithoutLe):
def __ge__(self, other):
return self > other or self == other
class LendGeNoLt: # $ Alert
def __le__(self, other):
return True
def __ge__(self, other):
return other <= self
from functools import total_ordering
@total_ordering
class Total:
def __le__(self, other):
return True