now requires #type: ignore

Author: Lorenzo Curcio

dapr/actor/runtime/mock_actor.py

@@ -21,7 +21,6 @@
 from dapr.actor.runtime._timer_data import TIMER_CALLBACK, ActorTimerData
 from dapr.actor.runtime.actor import Actor
 from dapr.actor.runtime.mock_state_manager import MockStateManager
-from dapr.actor.runtime.state_manager import ActorStateManager
 
 
 class MockActor(Actor):
@@ -72,15 +71,15 @@ async def register_timer(
         """
         name = name or self.__get_new_timer_name()
         timer = ActorTimerData(name, callback, state, due_time, period, ttl)
-        self._state_manager._mock_timers[name] = timer
+        self._state_manager._mock_timers[name] = timer  # type: ignore
 
     async def unregister_timer(self, name: str) -> None:
         """Unregisters actor timer from self._state_manager._mock_timers.
 
         Args:
             name (str): the name of the timer to unregister.
         """
-        self._state_manager._mock_timers.pop(name, None)
+        self._state_manager._mock_timers.pop(name, None)  # type: ignore
 
     async def register_reminder(
         self,
@@ -102,15 +101,15 @@ async def register_reminder(
             ttl (datetime.timedelta): the time interval before the reminder stops firing
         """
         reminder = ActorReminderData(name, state, due_time, period, ttl)
-        self._state_manager._mock_reminders[name] = reminder
+        self._state_manager._mock_reminders[name] = reminder  # type: ignore
 
     async def unregister_reminder(self, name: str) -> None:
         """Unregisters actor reminder from self._state_manager._mock_reminders..
 
         Args:
             name (str): the name of the reminder to unregister.
         """
-        self._state_manager._mock_reminders.pop(name, None)
+        self._state_manager._mock_reminders.pop(name, None)  # type: ignore
 
 
 T = TypeVar('T', bound=Actor)

dapr/actor/runtime/state_manager.py

@@ -21,8 +21,6 @@
 from dapr.actor.runtime.state_change import ActorStateChange, StateChangeKind
 
 if TYPE_CHECKING:
-    from dapr.actor.runtime._reminder_data import ActorReminderData
-    from dapr.actor.runtime._timer_data import ActorTimerData
     from dapr.actor.runtime.actor import Actor
 
 T = TypeVar('T')
@@ -70,9 +68,6 @@ def __init__(self, actor: 'Actor'):
         self._type_name = actor.runtime_ctx.actor_type_info.type_name
 
         self._default_state_change_tracker: Dict[str, StateMetadata] = {}
-        self._mock_state: Dict[str, Any]
-        self._mock_timers: Dict[str, ActorTimerData]
-        self._mock_reminders: Dict[str, ActorReminderData]
 
     async def add_state(self, state_name: str, value: T) -> None:
         if not await self.try_add_state(state_name, value):

daprdocs/content/en/python-sdk-docs/python-actor.md

@@ -82,6 +82,9 @@ assert mockactor._state_manager._mock_state['mystate'] == 5 #True
 Mock actors are created by passing your actor class and an actor ID (a string) to the create_mock_actor function. This function returns an instance of the actor with many internal methods overridden. Instead of interacting with Dapr for tasks like saving state or managing timers, the mock actor uses in-memory state to simulate these behaviors.
 
 This state can be accessed through the following variables:
+
+**IMPORTANT NOTE: Due to type hinting issues as discussed further down, these variables will not be visible to type hinters/linters/etc, who will think they are invalid variables. You will need to use them with #type: ignore in order to satisfy any such systems.**
+
 - **_state_manager._mock_state()**  
 A `[str, object]` dict where all the actor state is stored. Any variable saved via `_state_manager.save_state(key, value)`, or any other statemanager method is stored in the dict as that key, value pair. Any value loaded via `try_get_state` or any other statemanager method is taken from this dict.
 

docs/clients/clients.grpc.rst

@@ -0,0 +1,31 @@
+clients.grpc package
+====================
+
+Submodules
+----------
+
+
+.. automodule:: clients.grpc.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: clients.grpc.interceptors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: clients.grpc.subscription
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: clients.grpc
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/proto/proto.runtime.rst

@@ -0,0 +1,18 @@
+proto.runtime package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   proto.runtime.v1
+
+Module contents
+---------------
+
+.. automodule:: proto.runtime
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/proto/proto.runtime.v1.rst

@@ -0,0 +1,37 @@
+proto.runtime.v1 package
+========================
+
+Submodules
+----------
+
+
+.. automodule:: proto.runtime.v1.appcallback_pb2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: proto.runtime.v1.appcallback_pb2_grpc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: proto.runtime.v1.dapr_pb2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: proto.runtime.v1.dapr_pb2_grpc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: proto.runtime.v1
+   :members:
+   :undoc-members:
+   :show-inheritance:

examples/demo_actor/demo_actor/test_demo_actor.py

@@ -12,7 +12,7 @@ def test_create_actor(self):
 
     async def test_get_data(self):
         mockactor = create_mock_actor(DemoActor, '1')
-        self.assertFalse(mockactor._state_manager._mock_state)
+        self.assertFalse(mockactor._state_manager._mock_state)  # type: ignore
         val = await mockactor.get_my_data()
         self.assertIsNone(val)
 
@@ -33,8 +33,8 @@ async def test_clear_data(self):
 
     async def test_reminder(self):
         mockactor = create_mock_actor(DemoActor, '1')
-        self.assertFalse(mockactor._state_manager._mock_reminders)
+        self.assertFalse(mockactor._state_manager._mock_reminders)  # type: ignore
         await mockactor.set_reminder(True)
-        self.assertTrue('demo_reminder' in mockactor._state_manager._mock_reminders)
+        self.assertTrue('demo_reminder' in mockactor._state_manager._mock_reminders)  # type: ignore
         await mockactor.set_reminder(False)
-        self.assertFalse(mockactor._state_manager._mock_reminders)
+        self.assertFalse(mockactor._state_manager._mock_reminders)  # type: ignore

tests/actor/test_mock_actor.py

@@ -150,14 +150,14 @@ def test_create_actor(self):
 
     async def test_inistate(self):
         mockactor = create_mock_actor(MockTestActor, '1', initstate={'state': 5})
-        self.assertTrue('state' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['state'], 5)
+        self.assertTrue('state' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['state'], 5)  # type: ignore
 
     async def test_on_activate(self):
         mockactor = create_mock_actor(MockTestActor, '1')
         await mockactor._on_activate()
-        self.assertTrue('state' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})
+        self.assertTrue('state' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})  # type: ignore
 
     async def test_get_data(self):
         mockactor = create_mock_actor(MockTestActor, '1')
@@ -173,48 +173,48 @@ async def test_get_data_initstate(self):
     async def test_set_data(self):
         mockactor = create_mock_actor(MockTestActor, '1')
         await mockactor._on_activate()
-        self.assertTrue('state' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})
+        self.assertTrue('state' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})  # type: ignore
         await mockactor.set_data({'test': 10})
-        self.assertTrue('state' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 10})
+        self.assertTrue('state' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 10})  # type: ignore
         out1 = await mockactor.get_data()
         self.assertEqual(out1, {'test': 10})
 
     async def test_clear_data(self):
         mockactor = create_mock_actor(MockTestActor, '1')
         await mockactor._on_activate()
-        self.assertTrue('state' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})
+        self.assertTrue('state' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})  # type: ignore
         await mockactor.clear_data()
-        self.assertFalse('state' in mockactor._state_manager._mock_state)
-        self.assertIsNone(mockactor._state_manager._mock_state.get('state'))
+        self.assertFalse('state' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertIsNone(mockactor._state_manager._mock_state.get('state'))  # type: ignore
         out1 = await mockactor.get_data()
         self.assertIsNone(out1)
 
     async def test_toggle_reminder(self):
         mockactor = create_mock_actor(MockTestActor, '1')
         await mockactor._on_activate()
-        self.assertEqual(len(mockactor._state_manager._mock_reminders), 0)
+        self.assertEqual(len(mockactor._state_manager._mock_reminders), 0)  # type: ignore
         await mockactor.toggle_reminder('test', True)
-        self.assertEqual(len(mockactor._state_manager._mock_reminders), 1)
-        self.assertTrue('test' in mockactor._state_manager._mock_reminders)
-        reminderstate = mockactor._state_manager._mock_reminders['test']
+        self.assertEqual(len(mockactor._state_manager._mock_reminders), 1)  # type: ignore
+        self.assertTrue('test' in mockactor._state_manager._mock_reminders)  # type: ignore
+        reminderstate = mockactor._state_manager._mock_reminders['test']  # type: ignore
         self.assertTrue(reminderstate.reminder_name, 'test')
         await mockactor.toggle_reminder('test', False)
-        self.assertEqual(len(mockactor._state_manager._mock_reminders), 0)
+        self.assertEqual(len(mockactor._state_manager._mock_reminders), 0)  # type: ignore
 
     async def test_toggle_timer(self):
         mockactor = create_mock_actor(MockTestActor, '1')
         await mockactor._on_activate()
-        self.assertEqual(len(mockactor._state_manager._mock_timers), 0)
+        self.assertEqual(len(mockactor._state_manager._mock_timers), 0)  # type: ignore
         await mockactor.toggle_timer('test', True)
-        self.assertEqual(len(mockactor._state_manager._mock_timers), 1)
-        self.assertTrue('test' in mockactor._state_manager._mock_timers)
-        timerstate = mockactor._state_manager._mock_timers['test']
+        self.assertEqual(len(mockactor._state_manager._mock_timers), 1)  # type: ignore
+        self.assertTrue('test' in mockactor._state_manager._mock_timers)  # type: ignore
+        timerstate = mockactor._state_manager._mock_timers['test']  # type: ignore
         self.assertTrue(timerstate.timer_name, 'test')
         await mockactor.toggle_timer('test', False)
-        self.assertEqual(len(mockactor._state_manager._mock_timers), 0)
+        self.assertEqual(len(mockactor._state_manager._mock_timers), 0)  # type: ignore
 
     async def test_activate_reminder(self):
         mockactor = create_mock_actor(MockTestActor, '1')
@@ -225,7 +225,7 @@ async def test_activate_reminder(self):
             datetime.timedelta(days=1),
             datetime.timedelta(days=1),
         )
-        self.assertEqual(mockactor._state_manager._mock_state['test'], True)
+        self.assertEqual(mockactor._state_manager._mock_state['test'], True)  # type: ignore
 
     async def test_test_data(self):
         mockactor = create_mock_actor(MockTestActor, '1')
@@ -246,27 +246,27 @@ async def test_test_data(self):
 
     async def test_add_state(self):
         mockactor = create_mock_actor(MockTestActor, '1')
-        self.assertFalse(mockactor._state_manager._mock_state)
+        self.assertFalse(mockactor._state_manager._mock_state)  # type: ignore
         await mockactor.add_state('test', 5)
-        self.assertTrue('test' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['test'], 5)
+        self.assertTrue('test' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['test'], 5)  # type: ignore
         await mockactor.add_state('test2', 10)
-        self.assertTrue('test2' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['test2'], 10)
-        self.assertEqual(len(mockactor._state_manager._mock_state), 2)
+        self.assertTrue('test2' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['test2'], 10)  # type: ignore
+        self.assertEqual(len(mockactor._state_manager._mock_state), 2)  # type: ignore
         with self.assertRaises(ValueError):
             await mockactor.add_state('test', 10)
 
     async def test_update_state(self):
         mockactor = create_mock_actor(MockTestActor, '1')
-        self.assertFalse(mockactor._state_manager._mock_state)
+        self.assertFalse(mockactor._state_manager._mock_state)  # type: ignore
         await mockactor.update_state('test', 10)
-        self.assertTrue('test' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['test'], 10)
+        self.assertTrue('test' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['test'], 10)  # type: ignore
         await mockactor.update_state('test', 10)
-        self.assertTrue('test' in mockactor._state_manager._mock_state)
-        self.assertEqual(mockactor._state_manager._mock_state['test'], 20)
-        self.assertEqual(len(mockactor._state_manager._mock_state), 1)
+        self.assertTrue('test' in mockactor._state_manager._mock_state)  # type: ignore
+        self.assertEqual(mockactor._state_manager._mock_state['test'], 20)  # type: ignore
+        self.assertEqual(len(mockactor._state_manager._mock_state), 1)  # type: ignore
 
     async def test_state_change_tracker(self):
         mockactor = create_mock_actor(MockTestActor, '1')
@@ -281,7 +281,7 @@ async def test_state_change_tracker(self):
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].value, {'test': 5}
         )
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 5})  # type: ignore
         await mockactor.remove_data_no_save()
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].change_kind,
@@ -290,10 +290,10 @@ async def test_state_change_tracker(self):
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].value, {'test': 5}
         )
-        self.assertTrue('state' not in mockactor._state_manager._mock_state)
+        self.assertTrue('state' not in mockactor._state_manager._mock_state)  # type: ignore
         await mockactor.save_state()
         self.assertEqual(len(mockactor._state_manager._default_state_change_tracker), 0)
-        self.assertTrue('state' not in mockactor._state_manager._mock_state)
+        self.assertTrue('state' not in mockactor._state_manager._mock_state)  # type: ignore
         await mockactor.add_data_no_save({'test': 6})
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].change_kind,
@@ -302,7 +302,7 @@ async def test_state_change_tracker(self):
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].value, {'test': 6}
         )
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 6})
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 6})  # type: ignore
         await mockactor.save_state()
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].change_kind,
@@ -311,4 +311,4 @@ async def test_state_change_tracker(self):
         self.assertEqual(
             mockactor._state_manager._default_state_change_tracker['state'].value, {'test': 6}
         )
-        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 6})
+        self.assertEqual(mockactor._state_manager._mock_state['state'], {'test': 6})  # type: ignore