Merge pull request #83 from auscompgeek/magicbot-injection-tests

Add more tests for variable annotation injection

Author: virtuald

README.rst

@@ -44,4 +44,5 @@ Authors
 
 - Dustin Spicuzza (dustin@virtualroadside.com)
 - Tim Winters (twinters@wpi.edu)
+- David Vo (@auscompgeek)
 - Insert your name here!

magicbot/magicrobot.py

@@ -456,16 +456,17 @@ def _create_components(self):
                 # raise an error. No double declaring types, e.g foo: type = type
                 if isinstance(attr, type) and not isinstance(attr, property):
                     raise ValueError("%s.%s has two type declarations" % (cls.__name__, m))
+                # Otherwise, skip this set class variable
                 continue
 
-            # If the class variable has been assigned in __init__, skip it
+            # If the variable has been assigned in __init__ or createObjects, skip it
             if hasattr(self, m):
                 continue
 
             # If the type is not actually a type, give a meaningful error
             if not isinstance(ctyp, type):
-                raise TypeError('%s has a non-type annotation on %s (%s); lone non-injection variable annotations are disallowed, did you want to assign a static variable?' %
-                                (cls.__name__, m, ctyp))
+                raise TypeError('%s has a non-type annotation on %s (%r); lone non-injection variable annotations are disallowed, did you want to assign a static variable?'
+                                % (cls.__name__, m, ctyp))
 
             component = self._create_component(m, ctyp)
 
@@ -531,7 +532,7 @@ def _create_component(self, name, ctyp):
 
         # Ensure that mandatory methods are there
         if not callable(getattr(component, 'execute', None)):
-            raise ValueError("Component %s (%s) must have a method named 'execute'" % (name, component))
+            raise ValueError("Component %s (%r) must have a method named 'execute'" % (name, component))
 
         # Automatically inject a logger object
         component.logger = logging.getLogger(name)
@@ -560,16 +561,17 @@ def _setup_vars(self, cname, component):
                 # raise an error. No double declaring types, e.g foo: type = type
                 if isinstance(attr, type) and not isinstance(attr, property):
                     raise ValueError("%s.%s has two type declarations" % (component_type.__name__, n))
+                # Otherwise, skip this set class variable
                 continue
 
-            # If the class variable has been assigned in __init__, skip it
+            # If the variable has been assigned in __init__, skip it
             if hasattr(component, n):
                 continue
 
             # If the type is not actually a type, give a meaningful error
             if not isinstance(inject_type, type):
-                raise TypeError('Component %s has a non-type annotation on %s (%s); lone non-injection variable annotations are disallowed, did you want to assign a static variable?' %
-                                (cname, n, inject_type))
+                raise TypeError('Component %s has a non-type annotation on %s (%r); lone non-injection variable annotations are disallowed, did you want to assign a static variable?'
+                                % (cname, n, inject_type))
 
             self._inject(n, inject_type, cname, component)
 

tests/magicbot_annotation_tester.py

@@ -98,23 +98,31 @@ class InheritedBot(BotBase):
 
 class TypeHintedBot(magicbot.MagicRobot):
     some_int: int = 1
+    some_float: float
 
     component: DumbComponent
 
     def createObjects(self):
-        pass
+        self.some_float = 0.5
 
 
 class TypeHintedComponent:
     injectable: Injectable
 
     some_int: int = 1
+    maybe_float: float = None
+    calculated_num: float
+
+    def __init__(self):
+        self.calculated_num = 1 - self.some_int
 
     def execute(self):
         pass
 
 
 class TypeHintsBot(magicbot.MagicRobot):
+    injectable: Injectable
+
     component: TypeHintedComponent
 
     def createObjects(self):

tests/test_magicbot_injection.py

@@ -182,6 +182,7 @@ def test_typehintedbot():
 
         assert isinstance(bot.component, DumbComponent)
         assert bot.some_int == 1
+        assert bot.some_float == 0.5
 
     def test_typehints_inject():
         from magicbot_annotation_tester import TypeHintsBot, TypeHintedComponent, Injectable