Python: Fix 'unused import' to no longer give alerts for imported modules used in typehints.

markshannon · markshannon · commit 547b3eb973bd · 2019-01-22T17:38:09.000Z
diff --git a/change-notes/1.20/analysis-python.md b/change-notes/1.20/analysis-python.md
@@ -17,6 +17,7 @@
  | **Query**                  | **Expected impact**    | **Change**                                                       |
 |----------------------------|------------------------|------------------------------------------------------------------|
 | Unused import (`py/unused-import`) | Fewer false positive results | Results where the imported module is used in a `doctest` string are no longer reported. |
+| Unused import (`py/unused-import`) | Fewer false positive results | Results where the imported module is used in a type-hint comment are no longer reported. |
 
  ## Changes to code extraction
 
diff --git a/python/ql/src/Imports/UnusedImport.ql b/python/ql/src/Imports/UnusedImport.ql
@@ -57,6 +57,21 @@ predicate imported_module_used_in_doctest(Import imp) {
     )
 }
 
+predicate imported_module_used_in_typehint(Import imp) {
+    exists(string modname |
+        ((Name)imp.getAName().getAsname()).getId() = modname
+        and
+        /* Look for typehints containing the patterns:
+         * # type: …name…
+         */
+        exists(Comment tyephint |
+            tyephint.getLocation().getFile() = imp.getScope().(Module).getFile() and
+            tyephint.getText().regexpMatch("# type:.*" + modname + ".*")
+        )
+    )
+}
+
+
 predicate unused_import(Import imp, Variable name) {
     ((Name)imp.getAName().getAsname()).getVariable() = name
     and
@@ -83,6 +98,8 @@ predicate unused_import(Import imp, Variable name) {
     not all_not_understood(imp.getEnclosingModule())
     and
     not imported_module_used_in_doctest(imp)
+    and
+    not imported_module_used_in_typehint(imp)
 }
 
 
diff --git a/python/ql/test/query-tests/Imports/unused/imports_test.py b/python/ql/test/query-tests/Imports/unused/imports_test.py
@@ -70,3 +70,9 @@ def f():
     True
     '''
     return 5
+
+#Used in Python2 type hint
+import typing
+
+foo = None # type: typing.Optional[int]
+
