Merge pull request github#5582 from RasmusWL/all-tuple

Python: Add support for `__all__` assigned to tuple

Author: tausbn

python/ql/src/semmle/python/Module.qll

@@ -129,7 +129,11 @@ class Module extends Module_, Scope, AstNode {
       a.defines(all) and
       a.getScope() = this and
       all.getId() = "__all__" and
-      a.getValue().(List).getAnElt().(StrConst).getText() = name
+      (
+        a.getValue().(List).getAnElt().(StrConst).getText() = name
+        or
+        a.getValue().(Tuple).getAnElt().(StrConst).getText() = name
+      )
     )
   }
 

python/ql/test/library-tests/modules/__all__/DeclaredInAll.expected

@@ -0,0 +1,5 @@
+| all_dynamic.py:0:0:0:0 | Module all_dynamic | foo |
+| all_list.py:0:0:0:0 | Module all_list | bar |
+| all_list.py:0:0:0:0 | Module all_list | foo |
+| all_tuple.py:0:0:0:0 | Module all_tuple | bar |
+| all_tuple.py:0:0:0:0 | Module all_tuple | foo |

python/ql/test/library-tests/modules/__all__/DeclaredInAll.ql

@@ -0,0 +1,5 @@
+import python
+
+from Module mod, string name
+where mod.declaredInAll(name)
+select mod, name

python/ql/test/library-tests/modules/__all__/all_dynamic.py

@@ -0,0 +1,8 @@
+foo = "foo"
+bar = "bar"
+baz = "baz"
+
+
+__all__ = ["foo"]
+
+__all__ += ["bar"]

python/ql/test/library-tests/modules/__all__/all_indirect.py

@@ -0,0 +1,9 @@
+# I (@RasmusWL) have not seen anyone use this pattern in real code,
+# so this example is only included for completeness.
+foo = "foo"
+bar = "bar"
+baz = "baz"
+
+
+temp = ["foo", "bar"]
+__all__ = temp

python/ql/test/library-tests/modules/__all__/all_list.py

@@ -0,0 +1,6 @@
+foo = "foo"
+bar = "bar"
+baz = "baz"
+
+
+__all__ = ["foo", "bar"]

python/ql/test/library-tests/modules/__all__/all_set.py

@@ -0,0 +1,6 @@
+foo = "foo"
+bar = "bar"
+baz = "baz"
+
+
+__all__ = {"foo", "bar"}

python/ql/test/library-tests/modules/__all__/all_tuple.py

@@ -0,0 +1,6 @@
+foo = "foo"
+bar = "bar"
+baz = "baz"
+
+
+__all__ = ("foo", "bar")

python/ql/test/library-tests/modules/__all__/main.py

@@ -0,0 +1,90 @@
+# This file showcases how imports work with `__all__`.
+#
+# TL;DR; in `from <module> import *`, if `__all__` is defined in `<module>`, then only
+# the names in `__all__` will be imported -- otherwise all names that doesn't begin with
+# an underscore will be imported.
+#
+# If `__all__` is defined, `__all__` must be a sequence for `from <module> import *` to work.
+#
+# https://docs.python.org/3/reference/simple_stmts.html#the-import-statement
+# https://docs.python.org/3/glossary.html#term-sequence
+
+print("import *")
+print("---")
+
+from no_all import *
+print("no_all.py")
+print("  foo={!r}".format(foo))
+print("  bar={!r}".format(bar))
+print("  baz={!r}".format(baz))
+try:
+    print("  _qux={!r}".format(_qux))
+except NameError:
+    print("  _qux not imported")
+del foo, bar, baz
+
+from all_list import *
+print("all_list.py")
+print("  foo={!r}".format(foo))
+print("  bar={!r}".format(bar))
+try:
+    print("  baz={!r}".format(baz))
+except NameError:
+    print("  baz not imported")
+del foo, bar
+
+from all_tuple import *
+print("all_tuple.py")
+print("  foo={!r}".format(foo))
+print("  bar={!r}".format(bar))
+try:
+    print("  baz={!r}".format(baz))
+except NameError:
+    print("  baz not imported")
+del foo, bar
+
+from all_dynamic import *
+print("all_dynamic.py")
+print("  foo={!r}".format(foo))
+print("  bar={!r}".format(bar))
+try:
+    print("  baz={!r}".format(baz))
+except NameError:
+    print("  baz not imported")
+del foo, bar
+
+from all_indirect import *
+print("all_indirect.py")
+print("  foo={!r}".format(foo))
+print("  bar={!r}".format(bar))
+try:
+    print("  baz={!r}".format(baz))
+except NameError:
+    print("  baz not imported")
+del foo, bar
+
+# Example of wrong definition of `__all__`, where it is not a sequence.
+try:
+    from all_set import *
+except TypeError as e:
+    assert str(e) == "'set' object does not support indexing"
+    print("from all_set import * could not be imported:", e)
+
+print("")
+print("Direct reference on module")
+print("---")
+# Direct reference always works, no matter how `__all__` is set.
+import no_all
+import all_list
+import all_tuple
+import all_dynamic
+import all_indirect
+import all_set
+
+for mod in [no_all, all_list, all_tuple, all_dynamic, all_indirect, all_set]:
+    print("{}.py".format(mod.__name__))
+    print("  foo={!r}".format(mod.foo))
+    print("  bar={!r}".format(mod.bar))
+    print("  baz={!r}".format(mod.baz))
+
+print("\nspecial: no_all._qux={!r}".format(no_all._qux))

python/ql/test/library-tests/modules/__all__/no_all.py

@@ -0,0 +1,5 @@
+foo = "foo"
+bar = "bar"
+baz = "baz"
+# When `__all__` is not defined, names starting with underscore is not imported with `from <module> import *`
+_qux = "qux"