remove inspect.stack() from @rule parsing to fix import time regression in py3

src/python/pants/engine/rules.py

@@ -9,6 +9,7 @@
 import inspect
 import itertools
 import logging
+import sys
 from abc import abstractproperty
 from builtins import bytes, str
 from types import GeneratorType
@@ -34,14 +35,13 @@
 class _RuleVisitor(ast.NodeVisitor):
   """Pull `Get` calls out of an @rule body and validate `yield` statements."""
 
-  def __init__(self, func, func_node, func_source, orig_indent, frame, parents_table):
+  def __init__(self, func, func_node, func_source, orig_indent, parents_table):
     super(_RuleVisitor, self).__init__()
     self._gets = []
     self._func = func
     self._func_node = func_node
     self._func_source = func_source
     self._orig_indent = orig_indent
-    self._frame = frame
     self._parents_table = parents_table
     self._yields_in_assignments = set()
 
@@ -51,7 +51,8 @@ def gets(self):
 
   def _generate_ast_error_message(self, node, msg):
     # This is the location info of the start of the decorated @rule.
-    filename, line_number, _, context_lines, _ = inspect.getframeinfo(self._frame, context=4)
+    filename = inspect.getsourcefile(self._func)
+    source_lines, line_number = inspect.getsourcelines(self._func)
 
     # The asttokens library is able to keep track of line numbers and column offsets for us -- the
     # stdlib ast library only provides these relative to each parent node.
@@ -82,14 +83,14 @@ def _generate_ast_error_message(self, node, msg):
 
 The rule defined by function `{func_name}` begins at:
 {filename}:{line_number}:{orig_indent}
-{context_lines}
+{source_lines}
 """.format(func_name=self._func.__name__, msg=msg,
            filename=filename, line_number=line_number, orig_indent=self._orig_indent,
            node_line_number=node_file_line,
            node_col=fully_indented_node_col,
            node_text=indented_node_text,
            # Strip any leading or trailing newlines from the start of the rule body.
-           context_lines=''.join(context_lines).strip('\n')))
+           source_lines=''.join(source_lines).strip('\n')))
 
   class YieldVisitError(Exception): pass
 
@@ -242,17 +243,21 @@ def wrapper(func):
     if not inspect.isfunction(func):
       raise ValueError('The @rule decorator must be applied innermost of all decorators.')
 
-    caller_frame = inspect.stack()[1][0]
+    owning_module = sys.modules[func.__module__]
     source = inspect.getsource(func)
     beginning_indent = _get_starting_indent(source)
     if beginning_indent:
       source = "\n".join(line[beginning_indent:] for line in source.split("\n"))
     module_ast = ast.parse(source)
 
     def resolve_type(name):
-      resolved = caller_frame.f_globals.get(name) or caller_frame.f_builtins.get(name)
-      if not isinstance(resolved, type):
-        raise ValueError('Expected a `type` constructor, but got: {}'.format(name))
+      resolved = getattr(owning_module, name, None) or owning_module.__builtins__.get(name, None)
+      if resolved is None:
+        raise ValueError('Could not resolve type `{}` in top level of module {}'
+                         .format(name, owning_module.__name__))
+      elif not isinstance(resolved, type):
+        raise ValueError('Expected a `type` constructor for `{}`, but got: {} (type `{}`)'
+                         .format(name, resolved, type(resolved).__name__))
       return resolved
 
     gets = OrderedSet()
@@ -270,7 +275,6 @@ def resolve_type(name):
       func_node=rule_func_node,
       func_source=source,
       orig_indent=beginning_indent,
-      frame=caller_frame,
       parents_table=parents_table,
     )
     rule_visitor.visit(rule_func_node)

tests/python/pants_test/engine/test_rules.py

@@ -60,6 +60,9 @@ def __repr__(self):
 _suba_root_rules = [RootRule(SubA)]
 
 
+_this_is_not_a_type = 3
+
+
 @console_rule('example', [Select(Console)])
 def a_console_rule_generator(console):
   a = yield Get(A, str('a str!'))
@@ -81,7 +84,7 @@ def test_creation_fails_with_bad_declaration_type(self):
       RuleIndex.create([A()])
 
 
-class RuleGraphTest(unittest.TestCase):
+class RuleGraphTest(TestBase):
   def test_ruleset_with_missing_product_type(self):
     @rule(A, [Select(B)])
     def a_from_b_noop(b):
@@ -694,7 +697,24 @@ def b_from_d(d):
                      }""").strip(),
                                     subgraph)
 
-  def test_validate_yield_statements(self):
+  def test_invalid_get_arguments(self):
+    with self.assertRaisesWithMessage(ValueError, """\
+Could not resolve type `XXX` in top level of module pants_test.engine.test_rules"""):
+      class XXX(object): pass
+      @rule(A, [])
+      def f():
+        a = yield Get(A, XXX, 3)
+        yield a
+
+    # This fails because the argument is defined in this file's module, but it is not a type.
+    with self.assertRaisesWithMessage(ValueError, """\
+Expected a `type` constructor for `_this_is_not_a_type`, but got: 3 (type `int`)"""):
+      @rule(A, [])
+      def g():
+        a = yield Get(A, _this_is_not_a_type, 3)
+        yield a
+
+  def test_validate_yield_statements_in_rule_body(self):
     with self.assertRaisesRegexp(_RuleVisitor.YieldVisitError, re.escape('yield A()')):
       @rule(A, [])
       def f():
@@ -737,12 +757,14 @@ def g():
 
 The rule defined by function `g` begins at:
 test_rules.py:{rule_lineno}:{rule_col}
-    with self.assertRaises(_RuleVisitor.YieldVisitError) as cm:
       @rule(A, [])
       def g():
-""".format(lineno=(sys._getframe().f_lineno - 20),
+        # This is a yield statement without an assignment, and not at the end.
+        yield Get(B, D, D())
+        yield A()
+""".format(lineno=(sys._getframe().f_lineno - 22),
            col=8,
-           rule_lineno=(sys._getframe().f_lineno - 25),
+           rule_lineno=(sys._getframe().f_lineno - 27),
            rule_col=6))
 
   def create_full_graph(self, rules, validate=True):