add handler-registering methods to BotContext

Author: stevengum

libraries/botbuilder-core/botbuilder/core/bot_context.py

@@ -10,36 +10,39 @@
 
 
 class BotContext(object):
- def __init__(self, adapter, request: Activity):
- self.adapter = adapter
- self.activity = request
- self.responses: List[Activity] = []
- self._services: dict = {}
- self._on_send_activities: Callable[[]] = []
- self._on_update_activity: Callable[[]] = []
- self._on_delete_activity: Callable[[]] = []
- self.__responded: bool = False
+ def __init__(self, adapter_or_context, request: Activity=None):
+ if isinstance(adapter_or_context, BotContext):
+ adapter_or_context.copy_to(self)
+ else:
+ self.adapter = adapter_or_context
+ self.activity = request
+ self.responses: List[Activity] = []
+ self._services: dict = {}
+ self._on_send_activities: Callable[[]] = []
+ self._on_update_activity: Callable[[]] = []
+ self._on_delete_activity: Callable[[]] = []
+ self._responded = {'responded': False}
 
  if self.adapter is None:
  raise TypeError('BotContext must be instantiated with an adapter.')
  if self.activity is None:
  raise TypeError('BotContext must be instantiated with a request parameter of type Activity.')
 
  def copy_to(self, context: 'BotContext') -> None:
- for attribute in ['adapter', 'activity', 'responded', '_services',
+ for attribute in ['adapter', 'activity', '_responded', '_services',
  '_on_send_activities', '_on_update_activity', '_on_delete_activity']:
  setattr(context, attribute, getattr(self, attribute))
 
  @property
  def responded(self):
-  return self.__responded
+ return self._responded['responded']
 
  @responded.setter
  def responded(self, value):
- if type(value) != bool or value is False:
+ if not value:
  raise ValueError('BotContext.responded(): cannot set BotContext.responded to False.')
  else:
- self.__responded = value
+ self._responded['responded'] = True
 
  def get(self, key: str) -> object:
  if not key or not isinstance(key, str):
@@ -92,6 +95,33 @@ async def update_activity(self, activity: Activity):
  async def delete_activity(self, reference: ConversationReference):
  return await self._emit(self._on_delete_activity, reference, self.adapter.delete_activity(self, reference))
 
+ def on_send_activities(self, handler) -> 'BotContext':
+ """
+ Registers a handler to be notified of and potentially intercept the sending of activities.
+ :param handler:
+ :return:
+ """
+ self._on_send_activities.append(handler)
+ return self
+
+ def on_update_activity(self, handler) -> 'BotContext':
+ """
+ Registers a handler to be notified of and potentially intercept an activity being updated.
+ :param handler:
+ :return:
+ """
+ self._on_update_activity.append(handler)
+ return self
+
+ def on_delete_activity(self, handler) -> 'BotContext':
+ """
+ Registers a handler to be notified of and potentially intercept an activity being deleted.
+ :param handler:
+ :return:
+ """
+ self._on_delete_activity.append(handler)
+ return self
+
  @staticmethod
  async def _emit(plugins, arg, logic):
  handlers = copy(plugins)

libraries/botbuilder-core/tests/test_bot_context.py

@@ -30,23 +30,41 @@ def test_should_not_create_context_without_adapter(self):
  except Exception as e:
  raise e
 
- def test_copy_to_should_copy_references(self):
+ def test_should_create_context_with_older_context(self):
+ context = BotContext(ADAPTER, ACTIVITY)
+ new_context = BotContext(context)
+
+ def test_copy_to_should_copy_all_references(self):
  old_adapter = TestAdapter(None)
  old_activity = Activity(id='2', type='message', text='test copy')
  old_context = BotContext(old_adapter, old_activity)
  old_context.responded = True
 
+ async def send_activities_handler(context, next_handler):
+ pass
+
+ old_context.on_send_activities(send_activities_handler)
+
  adapter = TestAdapter(None)
  new_context = BotContext(adapter, ACTIVITY)
  old_context.copy_to(new_context)
 
  assert new_context.adapter == old_adapter
  assert new_context.activity == old_activity
  assert new_context.responded is True
+ assert len(new_context._on_send_activities) == 1
+ assert len(new_context._on_update_activity) == 0
+ assert len(new_context._on_delete_activity) == 0
+
+ def test_responded_should_be_automatically_set_to_False(self):
+ context = BotContext(ADAPTER, ACTIVITY)
+ assert context.responded is False
 
- def test_should_not_be_able_to_set_responded_to_True(self):
+ def test_should_be_able_to_set_responded_to_True(self):
  context = BotContext(ADAPTER, ACTIVITY)
+ assert context.responded is False
  context.responded = True
+ assert context.responded
 
  def test_should_not_be_able_to_set_responded_to_False(self):
  context = BotContext(ADAPTER, ACTIVITY)