Merge pull request #2221 from tausbn/python-unreachable-catch-all-assert

Python: Do not report unreachable "catch-all" cases in `elif`-chains.

Author: RasmusWL

python/ql/src/Statements/UnreachableCode.ql

@@ -16,9 +16,7 @@ import python
 predicate typing_import(ImportingStmt is) {
     exists(Module m |
         is.getScope() = m and
-        exists(TypeHintComment tc |
-            tc.getLocation().getFile() = m.getFile()
-        )
+        exists(TypeHintComment tc | tc.getLocation().getFile() = m.getFile())
     )
 }
 
@@ -39,18 +37,26 @@ predicate suppression_in_scope(Stmt s) {
     )
 }
 
+/** Holds if `s` is a statement that raises an exception at the end of an if-elif-else chain. */
+predicate marks_an_impossible_else_branch(Stmt s) {
+    exists(If i | i.getOrelse().getItem(0) = s |
+        s.(Assert).getTest() instanceof False
+        or
+        s instanceof Raise
+    )
+}
+
 predicate reportable_unreachable(Stmt s) {
     s.isUnreachable() and
     not typing_import(s) and
     not suppression_in_scope(s) and
     not exists(Stmt other | other.isUnreachable() |
         other.contains(s)
         or
-        exists(StmtList l, int i, int j | 
-            l.getItem(i) = other and l.getItem(j) = s and i < j
-        )
+        exists(StmtList l, int i, int j | l.getItem(i) = other and l.getItem(j) = s and i < j)
     ) and
-    not unique_yield(s)
+    not unique_yield(s) and
+    not marks_an_impossible_else_branch(s)
 }
 
 from Stmt s

python/ql/test/query-tests/Statements/unreachable/test.py

@@ -120,3 +120,20 @@ def foo(x):
             print(x, "== 0")
 
 
+# Unreachable catch-all case
+
+def unreachable_catch_all_assert_false(x):
+    if x < 0:
+        return "negative"
+    elif x >= 0:
+        return "positive"
+    else:
+        assert False, x
+
+def unreachable_catch_all_raise(x):
+    if x < 0:
+        pass
+    elif x >= 0:
+        pass
+    else:
+        raise ValueError(x)