Merge branch 'main' into joslat-process-framework-markdown-renderer

microsoft · Dec 12, 2024 · 90bdb09 · 90bdb09
2 parents 26ef5e5 + ed58607
commit 90bdb09
Show file tree

Hide file tree

Showing 163 changed files with 1,917 additions and 2,565 deletions.
diff --git a/.github/workflows/python-integration-tests.yml b/.github/workflows/python-integration-tests.yml
@@ -121,21 +121,6 @@ jobs:
       - name: Install dependencies
         run: |
           uv sync --all-extras --dev
-      - name: Install Ollama
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          curl -fsSL https://ollama.com/install.sh | sh
-          ollama serve &
-          sleep 5
-      - name: Pull model in Ollama
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          ollama pull ${{ vars.OLLAMA_CHAT_MODEL_ID }}
-          ollama pull ${{ vars.OLLAMA_CHAT_MODEL_ID_IMAGE }}
-          ollama pull ${{ vars.OLLAMA_CHAT_MODEL_ID_TOOL_CALL }}
-          ollama pull ${{ vars.OLLAMA_TEXT_MODEL_ID }}
-          ollama pull ${{ vars.OLLAMA_EMBEDDING_MODEL_ID }}
-          ollama list
       - name: Google auth
         uses: google-github-actions/auth@v2
         with:
@@ -158,10 +143,59 @@ jobs:
           subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
       - name: Run Integration Tests
         id: run_tests_ai_services
-        timeout-minutes: 25
         shell: bash
         run: |
-          uv run pytest -v -n logical --dist loadfile --dist worksteal ./tests/integration/completions ./tests/integration/embeddings ./tests/samples ./tests/integration/cross_language
+          uv run pytest -v --log-cli-level=INFO --durations=20 -n logical --dist loadfile --dist worksteal -m "not ollama" ./tests/integration/completions ./tests/integration/embeddings ./tests/samples ./tests/integration/cross_language
+
+  python-merge-gate-ollama:
+    name: Python Pre-Merge Integration Tests - Ollama
+    needs: paths-filter
+    if: github.event_name != 'pull_request' && github.event_name != 'schedule' && needs.paths-filter.outputs.pythonChanges == 'true'
+    strategy:
+      max-parallel: 1
+      fail-fast: false
+      matrix:
+        python-version: ["3.11"]
+        os: [ubuntu-latest]
+    defaults:
+      run:
+        working-directory: python
+    runs-on: ${{ matrix.os }}
+    environment: "integration"
+    env:
+      UV_PYTHON: ${{ matrix.python-version }}
+      COMPLETIONS_CONCEPT_SAMPLE: "true"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "0.5.x"
+          enable-cache: true
+          cache-suffix: ${{ runner.os }}-${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras --dev
+      - name: Install Ollama
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          curl -fsSL https://ollama.com/install.sh | sh
+          ollama serve &
+          sleep 5
+      - name: Pull model in Ollama
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          ollama pull ${{ vars.OLLAMA_CHAT_MODEL_ID }}
+          ollama pull ${{ vars.OLLAMA_CHAT_MODEL_ID_IMAGE }}
+          ollama pull ${{ vars.OLLAMA_CHAT_MODEL_ID_TOOL_CALL }}
+          ollama pull ${{ vars.OLLAMA_TEXT_MODEL_ID }}
+          ollama pull ${{ vars.OLLAMA_EMBEDDING_MODEL_ID }}
+          ollama list
+      - name: Run Integration Tests
+        id: run_tests_ai_services
+        shell: bash
+        run: |
+          uv run pytest -v --log-cli-level=INFO --durations=0 -n logical --dist loadfile --dist worksteal -m ollama --timeout=300 ./tests/integration/completions ./tests/integration/embeddings
 
   python-merge-gate-memory:
     name: Python Pre-Merge Integration Tests - Memory (incl samples using those)
@@ -215,10 +249,10 @@ jobs:
           subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
       - name: Run Integration Tests
         id: run_tests_memory
-        timeout-minutes: 10
+        timeout-minutes: 15
         shell: bash
         run: |
-          uv run pytest -v -n logical --dist loadfile --dist worksteal ./tests/integration/memory ./tests/samples
+          uv run pytest -v --log-cli-level=INFO --durations=20 -n logical --dist loadfile --dist worksteal ./tests/integration/memory ./tests/samples
 
   python-integration-tests:
     name: Python Integration Tests - Scheduled run
@@ -352,6 +386,7 @@ jobs:
     needs:
       [
         python-merge-gate-ai-services,
+        python-merge-gate-ollama,
         python-merge-gate-memory,
         python-integration-tests,
       ]

diff --git a/.github/workflows/python-test-coverage-report.yml b/.github/workflows/python-test-coverage-report.yml
@@ -0,0 +1,38 @@
+name: Python Test Coverage Report
+
+on:
+  workflow_run:
+    workflows: ["Python Test Coverage"]
+    types:
+      - completed
+
+jobs:
+  python-test-coverage-report:
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.conclusion == 'success'
+    continue-on-error: false
+    defaults:
+      run:
+        working-directory: python
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download coverage report
+        uses: actions/download-artifact@v4
+        with:
+          github-token: ${{ secrets.GH_ACTIONS_PR_WRITE }}
+          run-id: ${{ github.event.workflow_run.id }}
+          path: ./python
+          merge-multiple: true
+      - name: Display structure of downloaded files
+        run: ls
+      - name: Pytest coverage comment
+        id: coverageComment
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: python/python-coverage.txt
+          title: "Python Test Coverage Report"
+          badge-title: "Python Test Coverage"
+          junitxml-title: "Python Unit Test Overview"
+          junitxml-path: python/pytest.xml
+          default-branch: "main"
+          report-only-changed-files: true
diff --git a/.github/workflows/python-test-coverage.yml b/.github/workflows/python-test-coverage.yml
@@ -10,11 +10,6 @@ env:
   # Configure a constant location for the uv cache
   UV_CACHE_DIR: /tmp/.uv-cache
 
-permissions:
-  contents: write
-  checks: write
-  pull-requests: write
-
 jobs:
   python-tests-coverage:
     runs-on: ubuntu-latest
@@ -26,8 +21,6 @@ jobs:
       UV_PYTHON: "3.10"
     steps:
       - uses: actions/checkout@v4
-      - name: Setup filename variables
-        run: echo "FILE_ID=${{ github.event.number }}" >> $GITHUB_ENV
       - name: Set up uv
         uses: astral-sh/setup-uv@v4
         with:
@@ -38,16 +31,12 @@ jobs:
         run: uv sync --all-extras --dev
       - name: Test with pytest
         run: uv run --frozen pytest -q --junitxml=pytest.xml --cov=semantic_kernel --cov-report=term-missing:skip-covered ./tests/unit | tee python-coverage.txt
-      - name: Pytest coverage comment
-        id: coverageComment
-        uses: MishaKav/pytest-coverage-comment@main
-        continue-on-error: false
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
         with:
-          pytest-coverage-path: python/python-coverage.txt
-          coverage-path-prefix: "python/"
-          title: "Python Test Coverage Report"
-          badge-title: "Python Test Coverage"
-          junitxml-title: "Python Unit Test Overview"
-          junitxml-path: python/pytest.xml
-          default-branch: "main"
-          report-only-changed-files: true
+          path: |
+            python/python-coverage.txt
+            python/pytest.xml
+          overwrite: true
+          retention-days: 1
+          if-no-files-found: error
diff --git a/.github/workflows/python-unit-tests.yml b/.github/workflows/python-unit-tests.yml
@@ -48,7 +48,7 @@ jobs:
           enable-cache: true
           cache-suffix: ${{ runner.os }}-${{ matrix.python-version }}
       - name: Install the project
-        run: uv sync --all-extras --dev
+        run: uv sync --all-extras --dev -U --prerelease=if-necessary-or-explicit
       - name: Test with pytest
         env:
           PYTHON_GIL: ${{ matrix.gil }}

diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -25,7 +25,7 @@ classifiers = [
 dependencies = [
     "aiohttp ~= 3.8",
     "cloudevents ~=1.0",
-    "pydantic >=2.0,<2.10",
+    "pydantic >=2.0,<2.11,!=2.10.0,!=2.10.1,!=2.10.2,!=2.10.3",
     "pydantic-settings ~= 2.0",
     "defusedxml ~= 0.7",
     # azure identity
@@ -133,11 +133,12 @@ dev-dependencies = [
     "pytest ~= 8.2",
     "pytest-xdist[psutil] ~= 3.6",
     "pytest-cov >= 5.0",
-    "pytest-asyncio ~= 0.23",
+    "pytest-asyncio ~= 0.24",
+    "pytest-timeout>=2.3.1",
     "snoop ~= 0.4",
     "mypy >= 1.10",
     "types-PyYAML ~= 6.0.12.20240311",
-    "ruff ~= 0.7"
+    "ruff ~= 0.7",
 ]
 environments = [
     "sys_platform == 'darwin'",
@@ -148,10 +149,15 @@ environments = [
 [tool.pytest.ini_options]
 testpaths = 'tests'
 addopts = "-ra -q -r fEX"
+asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
 filterwarnings = [
     'ignore:.*FunctionChoiceBehavior.*:DeprecationWarning'
 ]
+timeout = 120
+markers = [
+    "ollama: mark a test as requiring the Ollama service (use \"not ollama\" to skip those tests)"
+]
 
 [tool.ruff]
 line-length = 120

diff --git a/python/samples/learn_resources/plugin.py b/python/samples/learn_resources/plugin.py
@@ -3,7 +3,6 @@
 import asyncio
 from typing import Annotated
 
-from samples.sk_service_configurator import add_service
 from semantic_kernel import Kernel
 from semantic_kernel.functions import kernel_function
 
@@ -41,10 +40,6 @@ async def main():
     # Initialize the kernel
     kernel = Kernel()
 
-    # Add the service to the kernel
-    # use_chat: True to use chat completion, False to use text completion
-    kernel = add_service(kernel=kernel, use_chat=True)
-
     light_plugin = kernel.add_plugin(
         LightPlugin(),
         plugin_name="LightPlugin",

diff --git a/python/semantic_kernel/functions/kernel_function.py b/python/semantic_kernel/functions/kernel_function.py
@@ -3,7 +3,7 @@
 import logging
 import time
 from abc import abstractmethod
-from collections.abc import AsyncGenerator, Callable
+from collections.abc import AsyncGenerator, Callable, Mapping, Sequence
 from copy import copy, deepcopy
 from inspect import isasyncgen, isgenerator
 from typing import TYPE_CHECKING, Any
@@ -108,7 +108,7 @@ def from_prompt(
         prompt_template: "PromptTemplateBase | None " = None,
         prompt_template_config: "PromptTemplateConfig | None" = None,
         prompt_execution_settings: (
-            "PromptExecutionSettings | list[PromptExecutionSettings] | dict[str, PromptExecutionSettings] | None"
+            "PromptExecutionSettings | Sequence[PromptExecutionSettings] | Mapping[str, PromptExecutionSettings] | None"
         ) = None,
     ) -> "KernelFunctionFromPrompt":
         """Create a new instance of the KernelFunctionFromPrompt class."""

diff --git a/python/semantic_kernel/functions/kernel_function_extension.py b/python/semantic_kernel/functions/kernel_function_extension.py
@@ -2,6 +2,7 @@
 
 import logging
 from abc import ABC
+from collections.abc import Mapping, Sequence
 from functools import singledispatchmethod
 from typing import TYPE_CHECKING, Any, Literal
 
@@ -126,7 +127,7 @@ def add_function(
         prompt: str | None = None,
         prompt_template_config: PromptTemplateConfig | None = None,
         prompt_execution_settings: (
-            PromptExecutionSettings | list[PromptExecutionSettings] | dict[str, PromptExecutionSettings] | None
+            PromptExecutionSettings | Sequence[PromptExecutionSettings] | Mapping[str, PromptExecutionSettings] | None
         ) = None,
         template_format: TEMPLATE_FORMAT_TYPES = KERNEL_TEMPLATE_FORMAT_NAME,
         prompt_template: PromptTemplateBase | None = None,

diff --git a/python/semantic_kernel/functions/kernel_function_from_prompt.py b/python/semantic_kernel/functions/kernel_function_from_prompt.py
@@ -2,7 +2,7 @@
 
 import logging
 import os
-from collections.abc import AsyncGenerator
+from collections.abc import AsyncGenerator, Mapping, Sequence
 from html import unescape
 from typing import TYPE_CHECKING, Any
 
@@ -64,8 +64,8 @@ def __init__(
         prompt_template: PromptTemplateBase | None = None,
         prompt_template_config: PromptTemplateConfig | None = None,
         prompt_execution_settings: PromptExecutionSettings
-        | list[PromptExecutionSettings]
-        | dict[str, PromptExecutionSettings]
+        | Sequence[PromptExecutionSettings]
+        | Mapping[str, PromptExecutionSettings]
         | None = None,
     ) -> None:
         """Initializes a new instance of the KernelFunctionFromPrompt class.
@@ -154,7 +154,7 @@ def rewrite_execution_settings(
             data["prompt_execution_settings"] = {
                 prompt_execution_settings.service_id or DEFAULT_SERVICE_NAME: prompt_execution_settings
             }
-        if isinstance(prompt_execution_settings, list):
+        if isinstance(prompt_execution_settings, Sequence):
             data["prompt_execution_settings"] = {
                 s.service_id or DEFAULT_SERVICE_NAME: s for s in prompt_execution_settings
             }

diff --git a/python/semantic_kernel/kernel_pydantic.py b/python/semantic_kernel/kernel_pydantic.py
@@ -4,10 +4,10 @@
 from typing import Annotated, Any, ClassVar, TypeVar
 
 from pydantic import BaseModel, ConfigDict, Field, UrlConstraints
-from pydantic.networks import Url
+from pydantic.networks import AnyUrl
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
-HttpsUrl = Annotated[Url, UrlConstraints(max_length=2083, allowed_schemes=["https"])]
+HttpsUrl = Annotated[AnyUrl, UrlConstraints(max_length=2083, allowed_schemes=["https"])]
 
 
 class KernelBaseModel(BaseModel):

diff --git a/python/semantic_kernel/prompt_template/prompt_template_config.py b/python/semantic_kernel/prompt_template/prompt_template_config.py
@@ -1,5 +1,6 @@
 # Copyright (c) Microsoft. All rights reserved.
 import logging
+from collections.abc import Mapping, Sequence
 from typing import TypeVar
 
 from pydantic import Field, field_validator, model_validator
@@ -52,14 +53,17 @@ def check_input_variables(self):
     @classmethod
     def rewrite_execution_settings(
         cls,
-        settings: PromptExecutionSettings | list[PromptExecutionSettings] | dict[str, PromptExecutionSettings] | None,
-    ) -> dict[str, PromptExecutionSettings]:
+        settings: PromptExecutionSettings
+        | Sequence[PromptExecutionSettings]
+        | Mapping[str, PromptExecutionSettings]
+        | None,
+    ) -> Mapping[str, PromptExecutionSettings]:
         """Rewrite execution settings to a dictionary."""
         if not settings:
             return {}
         if isinstance(settings, PromptExecutionSettings):
             return {settings.service_id or DEFAULT_SERVICE_NAME: settings}
-        if isinstance(settings, list):
+        if isinstance(settings, Sequence):
             return {s.service_id or DEFAULT_SERVICE_NAME: s for s in settings}
         return settings
 
@@ -70,7 +74,7 @@ def add_execution_settings(self, settings: PromptExecutionSettings, overwrite: b
         self.execution_settings[settings.service_id or DEFAULT_SERVICE_NAME] = settings
         logger.warning("Execution settings already exist and overwrite is set to False")
 
-    def get_kernel_parameter_metadata(self) -> list[KernelParameterMetadata]:
+    def get_kernel_parameter_metadata(self) -> Sequence[KernelParameterMetadata]:
         """Get the kernel parameter metadata for the input variables."""
         return [
             KernelParameterMetadata(
@@ -103,8 +107,8 @@ def restore(
         description: str,
         template: str,
         template_format: TEMPLATE_FORMAT_TYPES = KERNEL_TEMPLATE_FORMAT_NAME,
-        input_variables: list[InputVariable] = [],
-        execution_settings: dict[str, PromptExecutionSettings] = {},
+        input_variables: Sequence[InputVariable] = [],
+        execution_settings: Mapping[str, PromptExecutionSettings] = {},
         allow_dangerously_set_content: bool = False,
     ) -> "PromptTemplateConfig":
         """Restore a PromptTemplateConfig instance from the specified parameters.

diff --git a/python/tests/integration/audio_to_text/test_audio_to_text.py b/python/tests/integration/audio_to_text/test_audio_to_text.py
@@ -28,11 +28,9 @@
 )
 
 
-@pytest.mark.asyncio(scope="module")
 class TestAudioToText(AudioToTextTestBase):
     """Test audio-to-text services."""
 
-    @pytest.mark.asyncio
     async def test_audio_to_text(
         self,
         services: dict[str, AudioToTextClientBase],