Don't allow bindings to shadow builtins until reached

Author: bwhmather

Diff for: src/ssort/_builtins.py

@@ -1,3 +1,186 @@
+MODULE_BUILTINS = {
+    "_",
+    "__annotations__",
+    "__build_class__",
+    "__builtins__",
+    "__cached__",
+    "__debug__",
+    "__doc__",
+    "__file__",
+    "__import__",
+    "__loader__",
+    "__name__",
+    "__package__",
+    "__path__",
+    "__spec__",
+    "ArithmeticError",
+    "AssertionError",
+    "AttributeError",
+    "BaseException",
+    "BaseExceptionGroup",
+    "BlockingIOError",
+    "BrokenPipeError",
+    "BufferError",
+    "BytesWarning",
+    "ChildProcessError",
+    "ConnectionAbortedError",
+    "ConnectionError",
+    "ConnectionRefusedError",
+    "ConnectionResetError",
+    "DeprecationWarning",
+    "Ellipsis",
+    "EncodingWarning",
+    "EnvironmentError",
+    "EOFError",
+    "Exception",
+    "ExceptionGroup",
+    "False",
+    "FileExistsError",
+    "FileNotFoundError",
+    "FloatingPointError",
+    "FutureWarning",
+    "GeneratorExit",
+    "ImportError",
+    "ImportWarning",
+    "IndentationError",
+    "IndexError",
+    "InterruptedError",
+    "IOError",
+    "IsADirectoryError",
+    "KeyboardInterrupt",
+    "KeyError",
+    "LookupError",
+    "MemoryError",
+    "ModuleNotFoundError",
+    "NameError",
+    "None",
+    "NotADirectoryError",
+    "NotImplemented",
+    "NotImplementedError",
+    "OSError",
+    "OverflowError",
+    "PendingDeprecationWarning",
+    "PermissionError",
+    "ProcessLookupError",
+    "RecursionError",
+    "ReferenceError",
+    "ResourceWarning",
+    "RuntimeError",
+    "RuntimeWarning",
+    "StandardError",
+    "StopAsyncIteration",
+    "StopIteration",
+    "SyntaxError",
+    "SyntaxWarning",
+    "SystemError",
+    "SystemExit",
+    "TabError",
+    "TimeoutError",
+    "True",
+    "TypeError",
+    "UnboundLocalError",
+    "UnicodeDecodeError",
+    "UnicodeEncodeError",
+    "UnicodeError",
+    "UnicodeTranslateError",
+    "UnicodeWarning",
+    "UserWarning",
+    "ValueError",
+    "Warning",
+    "WindowsError",
+    "ZeroDivisionError",
+    "abs",
+    "aiter",
+    "all",
+    "anext",
+    "any",
+    "apply",
+    "ascii",
+    "basestring",
+    "bin",
+    "bool",
+    "breakpoint",
+    "buffer",
+    "bytearray",
+    "bytes",
+    "callable",
+    "chr",
+    "classmethod",
+    "cmp",
+    "coerce",
+    "compile",
+    "complex",
+    "copyright",
+    "credits",
+    "delattr",
+    "dict",
+    "dir",
+    "divmod",
+    "enumerate",
+    "eval",
+    "exec",
+    "execfile",
+    "exit",
+    "file",
+    "filter",
+    "float",
+    "format",
+    "frozenset",
+    "getattr",
+    "globals",
+    "hasattr",
+    "hash",
+    "help",
+    "hex",
+    "id",
+    "input",
+    "int",
+    "intern",
+    "isinstance",
+    "issubclass",
+    "iter",
+    "len",
+    "license",
+    "list",
+    "locals",
+    "long",
+    "map",
+    "max",
+    "memoryview",
+    "min",
+    "next",
+    "object",
+    "oct",
+    "open",
+    "ord",
+    "pow",
+    "print",
+    "property",
+    "quit",
+    "range",
+    "raw_input",
+    "reduce",
+    "reload",
+    "repr",
+    "reversed",
+    "round",
+    "set",
+    "setattr",
+    "slice",
+    "sorted",
+    "staticmethod",
+    "str",
+    "sum",
+    "super",
+    "tuple",
+    "type",
+    "unichr",
+    "unicode",
+    "vars",
+    "xrange",
+    "zip",
+}
+
 CLASS_BUILTINS = {
     "__module__",
     "__qualname__",

Diff for: src/ssort/_dependencies.py

@@ -1,3 +1,4 @@
+from ssort._builtins import MODULE_BUILTINS
 from ssort._graphs import Graph
 
 
@@ -26,6 +27,11 @@ def module_statements_graph(statements):
 
             if requirement.name in scope:
                 resolved[requirement] = scope[requirement.name]
+                continue
+
+            if requirement.name in MODULE_BUILTINS:
+                resolved[requirement] = None
+                continue
 
         for name in statement.bindings():
             scope[name] = statement
@@ -46,7 +52,7 @@ def module_statements_graph(statements):
 
     for statement in statements:
         for requirement in statement.requirements():
-            if requirement in resolved:
+            if resolved.get(requirement) is not None:
                 graph.add_dependency(statement, resolved[requirement])
 
     # Add links between statements that overwrite the same binding to make sure

Diff for: tests/test_builtins.py

@@ -1,4 +1,13 @@
-from ssort._builtins import CLASS_BUILTINS
+import ast
+import builtins
+import os.path
+import subprocess
+
+from ssort._builtins import CLASS_BUILTINS, MODULE_BUILTINS
+
+
+def _get_builtins():
+    return set(dir(builtins))
 
 
 def _get_class_builtins():
@@ -8,6 +17,54 @@ class Cls:
     return set(Cls.builtins)
 
 
+def _get_init_builtins():
+    import _builtins
+
+    return set(dir(_builtins))
+
+
+def _get_main_builtins():
+    return set(
+        ast.literal_eval(
+            subprocess.run(
+                ["python3", "_builtins"],
+                capture_output=True,
+                check=True,
+                cwd=os.path.dirname(__file__),
+                encoding="utf-8",
+            ).stdout
+        )
+    )
+
+
+def _get_module_builtins():
+    from _builtins import module
+
+    return set(dir(module))
+
+
+def test_no_new_builtins():
+    # Checks that python hasn't introduced any new builtins that aren't in our
+    # list.
+    missing = _get_builtins() - MODULE_BUILTINS
+    assert not missing
+
+
 def test_no_new_class_builtins():
     missing = _get_class_builtins() - {"builtins", *CLASS_BUILTINS}
     assert not missing
+
+
+def test_no_new_init_builtins():
+    missing = _get_init_builtins() - MODULE_BUILTINS
+    assert not missing
+
+
+def test_no_new_main_builtins():
+    missing = _get_main_builtins() - MODULE_BUILTINS
+    assert not missing
+
+
+def test_no_new_module_builtins():
+    missing = _get_module_builtins() - MODULE_BUILTINS
+    assert not missing

Diff for: tests/test_ssort.py

@@ -653,3 +653,18 @@ def f():
 
     actual = ssort(original)
     assert actual == expected
+
+
+def test_shadow_builtin():
+    original = _clean(
+        """
+        print("Hello, World!")
+
+        def print(message):
+            pass
+        """
+    )
+    expected = original
+
+    actual = ssort(original)
+    assert actual == expected