[PY] feat: OAuth (microsoft#1517)

## Linked issues

closes: microsoft#1317 

## Details

OAuth feature implementation.

---------

Co-authored-by: Lily Du <[email protected]>

Author: aacebo

Diff for: python/packages/ai/.pylintrc

@@ -447,7 +447,8 @@ disable=raw-checker-failed,
         too-many-boolean-expressions,
         too-many-arguments,
         too-many-instance-attributes,
-        duplicate-code
+        duplicate-code,
+        redefined-outer-name
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

Diff for: python/packages/ai/poetry.lock

@@ -23,15 +23,17 @@ jsonschema = "^4.21.1"
 types-pyyaml = "^6.0.12.12"
 pyyaml = "^6.0.1"
 dataclasses-json = "^0.6.4"
-openai = "^1.11.1"
 azure-ai-contentsafety = "^1.0.0"
+msal = "^1.28.0"
+botbuilder-dialogs = "^4.14.8"
+openai = "^1.27.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.4.0"
-pylint = "^2.17.4"
-pytest-cov = "^4.1.0"
+pytest = "^8.1.1"
+pylint = "^3.1.0"
+pytest-cov = "^5.0.0"
 pytest-asyncio = "^0.21.1"
-black = ">=23.7,<25.0"
+black = "24.3.0"
 isort = "^5.12.0"
 mypy = "^1.5.0"
 httpx = "^0.26.0"
@@ -48,14 +50,16 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.black]
+preview = true
 line-length = 100
 target-version = ['py38']
+enable-unstable-feature = ['string_processing', 'multiline_string_handling']
 
 [tool.isort]
 profile = "black"
 
 [tool.pytest.ini_options]
-addopts = "-rx --cov-report html:coverage/html --cov-report lcov:coverage/lcov.info --cov=teams"
+addopts = "-rx --cov-report html:coverage/html --cov-report lcov:coverage/lcov.info --cov=teams --verbose"
 log_cli = true
 log_cli_level = "INFO"
 

Diff for: python/packages/ai/pyproject.toml

@@ -86,11 +86,12 @@ def __selector__(context: TurnContext) -> bool:
             return False
 
         def __call__(
-            func: Callable[[TurnContext, StateT, dict], Awaitable[Union[str, dict]]]
+            func: Callable[[TurnContext, StateT, dict], Awaitable[Union[str, dict]]],
         ) -> Callable[[TurnContext, StateT, dict], Awaitable[Union[str, dict]]]:
             async def __handler__(context: TurnContext, state: StateT) -> bool:
                 result = await func(context, state, context.activity.value["action"]["data"])
-                if context.turn_state.get(ActivityTypes.invoke_response) is None:
+
+                if context.turn_state.get(context._INVOKE_RESPONSE_KEY) is None:
                     if isinstance(result, str):
                         response = AdaptiveCardInvokeResponse(
                             status_code=200,
@@ -162,7 +163,7 @@ def __selector__(context: TurnContext) -> bool:
             return False
 
         def __call__(
-            func: Callable[[TurnContext, StateT, dict], Awaitable[None]]
+            func: Callable[[TurnContext, StateT, dict], Awaitable[None]],
         ) -> Callable[[TurnContext, StateT, dict], Awaitable[None]]:
             async def __handler__(context: TurnContext, state: StateT) -> bool:
                 await func(context, state, context.activity.value)
@@ -229,7 +230,7 @@ def __call__(
             func: Callable[
                 [TurnContext, StateT, Query[AdaptiveCardsSearchParams]],
                 Awaitable[List[AdaptiveCardsSearchResult]],
-            ]
+            ],
         ) -> Callable[
             [TurnContext, StateT, Query[AdaptiveCardsSearchParams]],
             Awaitable[List[AdaptiveCardsSearchResult]],
@@ -254,7 +255,7 @@ async def __handler__(context: TurnContext, state: StateT) -> bool:
                     ),
                 )
                 result = await func(context, state, query)
-                if context.turn_state.get(ActivityTypes.invoke_response) is None:
+                if context.turn_state.get(context._INVOKE_RESPONSE_KEY) is None:
                     # Format invoke response
                     response = {
                         "type": "application/vnd.microsoft.search.searchResponse",

Diff for: python/packages/ai/teams/adaptive_cards/adaptive_cards.py

@@ -110,12 +110,10 @@ def __call__(func: ActionHandler[StateT]) -> ActionHandler[StateT]:
             existing = self._actions.get(action_name)
 
             if existing and not existing.allow_overrides:
-                raise ApplicationError(
-                    f"""
+                raise ApplicationError(f"""
                     The AI.action() method was called with a previously 
                     registered action named \"{action_name}\".
-                    """
-                )
+                    """)
 
             self._actions[action_name] = ActionEntry[StateT](action_name, allow_overrides, func)
             return func
@@ -228,10 +226,8 @@ async def _on_http_error(
         status = _context.data.get("status")
         message = _context.data.get("message")
         raise ApplicationError(
-            (
-                "An AI request failed because an http error occurred. "
-                f"Status code:{status}. Message:{message}"
-            )
+            "An AI request failed because an http error occurred. "
+            f"Status code:{status}. Message:{message}"
         )
 
     async def _on_plan_ready(

Diff for: python/packages/ai/teams/ai/ai.py

@@ -143,11 +143,22 @@ def __init__(self, actions: List[ChatCompletionAction]) -> None:
             call_to_action="\n".join(
                 [
                     "Return a JSON object with your thoughts and the next action to perform.",
-                    "Only respond with the JSON format below and base your plan on the actions above.",
-                    "If you're not sure what to do, you can always say something by returning a SAY action.",
+                    (
+                        "Only respond with the JSON format below and base your plan on the actions"
+                        " above."
+                    ),
+                    (
+                        "If you're not sure what to do, you can always say something by returning a"
+                        " SAY action."
+                    ),
                     "If you're told your JSON response has errors, do your best to fix them.",
                     "Response Format:",
-                    '{"thoughts":{"thought":"<your current thought>","reasoning":"<self reflect on why you made this decision>","plan":"- short bulleted\\n- list that conveys\\n- long-term plan"},"action":{"name":"<action name>","parameters":{"<name>":"<value>"}}}',
+                    (
+                        '{"thoughts":{"thought":"<your current thought>","reasoning":"<self reflect'
+                        ' on why you made this decision>","plan":"- short bulleted\\n- list that'
+                        ' conveys\\n- long-term plan"},"action":{"name":"<action'
+                        ' name>","parameters":{"<name>":"<value>"}}}'
+                    ),
                 ]
             ),
         )

Diff for: python/packages/ai/teams/ai/augmentations/monologue_augmentation.py

@@ -52,12 +52,10 @@ def __init__(self, options: AzureOpenAIEmbeddingsOptions, log=Logger("teams.ai")
             endpoint = endpoint[0 : (len(endpoint) - 1)]
 
         if not endpoint.lower().startswith("https://"):
-            raise ValueError(
-                f"""
+            raise ValueError(f"""
                 Client created with an invalid endpoint of \"{endpoint}\".
                 The endpoint must be a valid HTTPS url.
-                """
-            )
+                """)
 
         self.options.azure_endpoint = endpoint
 

Diff for: python/packages/ai/teams/ai/embeddings/azure_openai_embeddings.py

@@ -226,10 +226,8 @@ def add_prompt(self, prompt: PromptTemplate) -> "PromptManager":
         """
         if prompt.name in self._prompts:
             raise ApplicationError(
-                (
-                    "The PromptManager.add_prompt() method was called with a "
-                    f"previously registered prompt named '{prompt.name}'."
-                )
+                "The PromptManager.add_prompt() method was called with a "
+                f"previously registered prompt named '{prompt.name}'."
             )
 
         # Clone and cache prompt
@@ -268,10 +266,8 @@ async def get_prompt(self, name: str) -> PromptTemplate:
                     template_config = PromptTemplateConfig.from_dict(json.load(file))
             except Exception as e:
                 raise ApplicationError(
-                    (
-                        "PromptManager.get_prompt(): an error occurred while loading "
-                        f"'{config_file}'. The file is either invalid or missing."
-                    )
+                    "PromptManager.get_prompt(): an error occurred while loading "
+                    f"'{config_file}'. The file is either invalid or missing."
                 ) from e
 
             # Load prompt text
@@ -282,10 +278,8 @@ async def get_prompt(self, name: str) -> PromptTemplate:
                     sections.append(TemplateSection(prompt, self._options.role))
             except Exception as e:
                 raise ApplicationError(
-                    (
-                        "PromptManager.get_prompt(): an error occurred while loading "
-                        f"'{prompt_file}'. The file is either invalid or missing."
-                    )
+                    "PromptManager.get_prompt(): an error occurred while loading "
+                    f"'{prompt_file}'. The file is either invalid or missing."
                 ) from e
 
             # Load optional actions

Diff for: python/packages/ai/teams/ai/prompts/prompt_manager.py

@@ -94,8 +94,9 @@ async def validate_response(
 
             return Validation(
                 valid=False,
-                feedback=f"No {self._noun} was specified. "
-                f"Call a {self._noun} with valid arguments.",
+                feedback=(
+                    f"No {self._noun} was specified. Call a {self._noun} with valid arguments."
+                ),
             )
 
         if func.name is None:
@@ -107,8 +108,9 @@ async def validate_response(
         if not func.name in self._actions:
             return Validation(
                 valid=False,
-                feedback=f'Unknown {self._noun} named "{func.name}". '
-                f"Specify a valid {self._noun} name.",
+                feedback=(
+                    f'Unknown {self._noun} named "{func.name}". Specify a valid {self._noun} name.'
+                ),
             )
 
         params: Dict[str, Any] = {}
@@ -117,11 +119,15 @@ async def validate_response(
         if action.parameters is not None:
             validator = JSONResponseValidator(
                 schema=action.parameters,
-                missing_json_feedback=f"No arguments were sent with called {self._noun}. "
-                f'Call the "{func.name}" {self._noun} with required '
-                f"arguments as a valid JSON object.",
-                error_feedback=f"The {self._noun} arguments had errors. "
-                f'Apply these fixes and call "{func.name}" {self._noun} again:',
+                missing_json_feedback=(
+                    f"No arguments were sent with called {self._noun}. "
+                    f'Call the "{func.name}" {self._noun} with required '
+                    "arguments as a valid JSON object."
+                ),
+                error_feedback=(
+                    f"The {self._noun} arguments had errors. "
+                    f'Apply these fixes and call "{func.name}" {self._noun} again:'
+                ),
             )
 
             res = await validator.validate_response(