8000 Merge pull request #92 from Microsoft/v-stgum/TurnContext · Bpowers4/botbuilder-python@07dfa4a · GitHub
[go: up one dir, main page]
Skip to content

Commit 07dfa4a

Browse files
stevengumstevengum
authored
Merge pull request microsoft#92 from Microsoft/v-stgum/TurnContext
rename BotContext to TurnContext
2 parents cdda8ae + fab1d12 commit 07dfa4a

File tree

20 files changed

+120
-120
lines changed

20 files changed

+120
-120
lines changed

‎Generator/generator-botbuilder-python/generators/app/templates/main.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
from aiohttp import web
55
from botbuilder.schema import (Activity, ActivityTypes)
6-
from botbuilder.core import (BotFrameworkAdapter, BotFrameworkAdapterSettings, BotContext)
6+
from botbuilder.core import (BotFrameworkAdapter, BotFrameworkAdapterSettings, TurnContext)
77

88
APP_ID = ''
99
APP_PASSWORD = ''
@@ -23,13 +23,13 @@ async def create_reply_activity(request_activity, text) -> Activity:
2323
service_url=request_activity.service_url)
2424

2525

26-
async def handle_message(context: BotContext) -> web.Response:
26+
async def handle_message(context: TurnContext) -> web.Response:
2727
response = await create_reply_activity(context.request, 'You said %s.' % context.request.text)
2828
await context.send_activity(response)
2929
return web.Response(status=202)
3030

3131

32-
async def handle_conversation_update(context: BotContext) -> web.Response:
32+
async def handle_conversation_update(context: TurnContext) -> web.Response:
3333
if context.request.members_added[0].id != context.request.recipient.id:
3434
response = await create_reply_activity(context.request, 'Welcome to the Echo Adapter Bot!')
3535
await context.send_activity(response)
@@ -40,7 +40,7 @@ async def unhandled_activity() -> web.Response:
4040
return web.Response(status=404)
4141

4242

43-
async def request_handler(context: BotContext) -> web.Response:
43+
async def request_handler(context: TurnContext) -> web.Response:
4444
if context.request.type == 'message':
4545
return await handle_message(context)
4646
elif context.request.type == 'conversationUpdate':
@@ -65,4 +65,4 @@ async def messages(req: web.web_request) -> web.Response:
6565
try:
6666
web.run_app(app, host='localhost', port=PORT)
6767
except Exception as e:
68-
raise e
68+
raise e

‎libraries/botbuilder-core/botbuilder/core/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
from .bot_adapter import BotAdapter
1111
from .bot_framework_adapter import BotFrameworkAdapter, BotFrameworkAdapterSettings
12-
from .bot_context import BotContext
12+
from .turn_context import TurnContext
1313
from .bot_state import BotState
1414
from .card_factory import CardFactory
1515
from .conversation_state import ConversationState
@@ -22,7 +22,7 @@
2222

2323
__all__ = ['AnonymousReceiveMiddleware',
2424
'BotAdapter',
25-
'BotContext',
25+
'TurnContext',
2626
'BotFrameworkAdapter',
2727
'BotFrameworkAdapterSettings',
2828
'BotState',

‎libraries/botbuilder-core/botbuilder/core/bot_adapter.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from typing import List, Callable
66
from botbuilder.schema import Activity, ConversationReference
77

8-
from .bot_context import BotContext
8+
from .turn_context import TurnContext
99
from .middleware_set import MiddlewareSet
1010

1111

@@ -14,7 +14,7 @@ def __init__(self):
1414
self._middleware = MiddlewareSet()
1515

1616
@abstractmethod
17-
async def send_activities(self, context: BotContext, activities: List[Activity]):
17+
async def send_activities(self, context: TurnContext, activities: List[Activity]):
1818
"""
1919
Sends a set of activities to the user. An array of responses from the server will be returned.
2020
:param activities:
@@ -23,7 +23,7 @@ async def send_activities(self, context: BotContext, activities: List[Activity])
2323
raise NotImplementedError()
2424

2525
@abstractmethod
26-
async def update_activity(self, context: BotContext, activity: Activity):
26+
async def update_activity(self, context: TurnContext, activity: Activity):
2727
"""
2828
Replaces an existing activity.
2929
:param activity:
@@ -32,7 +32,7 @@ async def update_activity(self, context: BotContext, activity: Activity):
3232
raise NotImplementedError()
3333

3434
@abstractmethod
35-
async def delete_activity(self, context: BotContext, reference: ConversationReference):
35+
async def delete_activity(self, context: TurnContext, reference: ConversationReference):
3636
"""
3737
Deletes an existing activity.
3838
:param reference:
@@ -48,7 +48,7 @@ def use(self, middleware):
4848
"""
4949
self._middleware.use(middleware)
5050

51-
async def run_middleware(self, context: BotContext, callback: Callable=None):
51+
async def run_middleware(self, context: TurnContext, callback: Callable=None):
5252
"""
5353
Called by the parent class to run the adapters middleware set and calls the passed in `callback()` handler at
5454
the end of the chain.

‎libraries/botbuilder-core/botbuilder/core/bot_framework_adapter.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
from . import __version__
1515
from .bot_adapter import BotAdapter
16-
from .bot_context import BotContext
16+
from .turn_context import TurnContext
1717

1818
USER_AGENT = f"Microsoft-BotFramework/3.1 (BotBuilder Python/{__version__})"
1919

@@ -42,7 +42,7 @@ async def continue_conversation(self, reference: ConversationReference, logic):
4242
:param logic:
4343
:return:
4444
"""
45-
request = BotContext.apply_conversation_reference(Activity(), reference, is_incoming=True)
45+
request = TurnContext.apply_conversation_reference(Activity(), reference, is_incoming=True)
4646
context = self.create_context(request)
4747
return await self.run_middleware(context, logic)
4848

@@ -63,7 +63,7 @@ async def create_conversation(self, reference: ConversationReference, logic):
6363
client = self.create_connector_client(reference.service_url)
6464

6565
resource_response = await client.conversations.create_conversation_async(parameters)
66-
request = BotContext.apply_conversation_reference(Activity(), reference, is_incoming=True)
66+
request = TurnContext.apply_conversation_reference(Activity(), reference, is_incoming=True)
6767
request.conversation = ConversationAccount(id=resource_response.id)
6868
if resource_response.service_url:
6969
request.service_url = resource_response.service_url
@@ -107,7 +107,7 @@ def create_context(self, activity):
107107
:param activity:
108108
:return:
109109
"""
110-
return BotContext(self, activity)
110+
return TurnContext(self, activity)
111111

112112
@staticmethod
113113
async def parse_request(req):
@@ -148,7 +148,7 @@ async def validate_activity(activity: Activity):
148148
if is_valid_activity:
149149
return req
150150

151-
async def update_activity(self, context: BotContext, activity: Activity):
151+
async def update_activity(self, context: TurnContext, activity: Activity):
152152
"""
153153
Replaces an activity that was previously sent to a channel. It should be noted that not all
154154
channels support this feature.
@@ -165,7 +165,7 @@ async def update_activity(self, context: BotContext, activity: Activity):
165165
except Exception as e:
166166
raise e
167167

168-
async def delete_activity(self, context: BotContext, conversation_reference: ConversationReference):
168+
async def delete_activity(self, context: TurnContext, conversation_reference: ConversationReference):
169169
"""
170170
Deletes an activity that was previously sent to a channel. It should be noted that not all
171171
channels support this feature.
@@ -180,7 +180,7 @@ async def delete_activity(self, context: BotContext, conversation_reference: Con
180180
except Exception as e:
181181
raise e
182182

183-
async def send_activities(self, context: BotContext, activities: List[Activity]):
183+
async def send_activities(self, context: TurnContext, activities: List[Activity]):
184184
try:
185185
for activity in activities:
186186
if activity.type == 'delay':
@@ -198,7 +198,7 @@ async def send_activities(self, context: BotContext, activities: List[Activity])
198198
except Exception as e:
199199
raise e
200200

201-
async def delete_conversation_member(self, context: BotContext, member_id: str) -> None:
201+
async def delete_conversation_member(self, context: TurnContext, member_id: str) -> None:
202202
"""
203203
Deletes a member from the current conversation.
204204
:param context:
@@ -220,7 +220,7 @@ async def delete_conversation_member(self, context: BotContext, member_id: str)
220220
except Exception as e:
221221
raise e
222222

223-
async def get_activity_members(self, context: BotContext, activity_id: str):
223+
async def get_activity_members(self, context: TurnContext, activity_id: str):
224224
"""
225225
Lists the members of a given activity.
226226
:param context:
@@ -244,7 +244,7 @@ async def get_activity_members(self, context: BotContext, activity_id: str):
244244
except Exception as e:
245245
raise e
246246

247-
async def get_conversation_members(self, context: BotContext):
247+
async def get_conversation_members(self, context: TurnContext):
248248
"""
249249
Lists the members of a current conversation.
250250
:param context:

‎libraries/botbuilder-core/botbuilder/core/bot_state.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright (c) Microsoft Corporation. All rights reserved.
22
# Licensed under the MIT License.
33

4-
from .bot_context import BotContext
4+
from .turn_context import TurnContext
55
from .middleware_set import Middleware
66
from .storage import calculate_change_hash, StoreItem, StorageKeyFactory, Storage
77

@@ -27,7 +27,7 @@ async def on_process_request(self, context, next_middleware):
2727
await self.write(context)
2828
return logic_results
2929

30-
async def read(self, context: BotContext, force: bool=False):
30+
async def read(self, context: TurnContext, force: bool=False):
3131
"""
3232
Reads in and caches the current state object for a turn.
3333
:param context:
@@ -47,7 +47,7 @@ async def read(self, context: BotContext, force: bool=False):
4747

4848
return cached['state']
4949

50-
async def write(self, context: BotContext, force: bool=False):
50+
async def write(self, context: TurnContext, force: bool=False):
5151
"""
5252
Saves the cached state object if it's been changed.
5353
:param context:
@@ -67,7 +67,7 @@ async def write(self, context: BotContext, force: bool=False):
6767
cached['hash'] = calculate_change_hash(cached['state'])
6868
context.services[self.state_key] = cached
6969

70-
async def clear(self, context: BotContext):
70+
async def clear(self, context: TurnContext):
7171
"""
7272
Clears the current state object for a turn.
7373
:param context:
@@ -78,7 +78,7 @@ async def clear(self, context: BotContext):
7878
cached['state'] = StoreItem()
7979
context.services[self.state_key] = cached
8080

81-
async def get(self, context: BotContext):
81+
async def get(self, context: TurnContext):
8282
"""
8383
Returns a cached state object or undefined if not cached.
8484
:param context:

‎libraries/botbuilder-core/botbuilder/core/conversation_state.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright (c) Microsoft Corporation. All rights reserved.
22
# Licensed under the MIT License.
33

4-
from .bot_context import BotContext
4+
from .turn_context import TurnContext
55
from .bot_state import BotState
66
from .storage import Storage
77

@@ -30,7 +30,7 @@ def call_get_storage_key(context):
3030
super(ConversationState, self).__init__(storage, call_get_storage_key)
3131
self.namespace = namespace
3232

33-
def get_storage_key(self, context: BotContext):
33+
def get_storage_key(self, context: TurnContext):
3434
activity = context.activity
3535
channel_id = getattr(activity, 'channel_id', None)
3636
conversation_id = getattr(activity.conversation, 'id', None) if hasattr(activity, 'conversation') else None

‎libraries/botbuilder-core/botbuilder/core/middleware_set.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
from asyncio import iscoroutinefunction
55
from abc import ABC, abstractmethod
66

7-
from .bot_context import BotContext
7+
from .turn_context import TurnContext
88

99

1010
class Middleware(ABC):
1111
@abstractmethod
12-
def on_process_request(self, context: BotContext, next): pass
12+
def on_process_request(self, context: TurnContext, next): pass
1313

1414

1515
class AnonymousReceiveMiddleware(Middleware):
@@ -18,7 +18,7 @@ def __init__(self, anonymous_handler):
1818
raise TypeError('AnonymousReceiveMiddleware must be instantiated with a valid coroutine function.')
1919
self._to_call = anonymous_handler
2020

21-
def on_process_request(self, context: BotContext, next):
21+
def on_process_request(self, context: TurnContext, next):
2222
return self._to_call(context, next)
2323

2424

@@ -45,14 +45,14 @@ def use(self, *middleware: Middleware):
4545
else:
4646
raise TypeError('MiddlewareSet.use(): invalid middleware at index "%s" being added.' % idx)
4747

48-
async def receive_activity(self, context: BotContext):
48+
async def receive_activity(self, context: TurnContext):
4949
await self.receive_activity_internal(context, None)
5050

5151
async def on_process_request(self, context, logic):
5252
await self.receive_activity_internal(context, None)
5353
await logic()
5454

55-
async def receive_activity_with_status(self, context: BotContext, callback):
55+
async def receive_activity_with_status(self, context: TurnContext, callback):
5656
return await self.receive_activity_internal(context, callback)
5757

5858
async def receive_activity_internal(self, context, callback, next_middleware_index=0):

‎libraries/botbuilder-core/botbuilder/core/storage.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from abc import ABC, abstractmethod
66
from typing import Callable, List
77

8-
from .bot_context import BotContext
8+
from .turn_context import TurnContext
99

1010

1111
class Storage(ABC):
@@ -54,7 +54,7 @@ def __str__(self):
5454
return output
5555

5656

57-
StorageKeyFactory = Callable[[BotContext], str]
57+
StorageKeyFactory = Callable[[TurnContext], str]
5858

5959

6060
def calculate_change_hash(item: StoreItem) -> str:

‎libraries/botbuilder-core/botbuilder/core/test_adapter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from datetime import datetime
77
from typing import Coroutine, List
88
from copy import copy
9-
from botbuilder.core import BotAdapter, BotContext
9+
from botbuilder.core import BotAdapter, TurnContext
1010
from botbuilder.schema import (ActivityTypes, Activity, ConversationAccount,
1111
ConversationReference, ChannelAccount, ResourceResponse)
1212

@@ -109,7 +109,7 @@ async def receive_activity(self, activity):
109109
request.id = str(self._next_id)
110110

111111
# Create context object and run middleware
112-
context = BotContext(self, request)
112+
context = TurnContext(self, request)
113113
return await self.run_middleware(context, self.logic)
114114

115115
async def send(self, user_says):

0 commit comments

Comments
 (0)
0