Python: Pythonic Design Principle in docs
Motivation and Context
Adds the main design principle that we will use for Semantic Kernel, this will allow Python developers and dotnet developers to better understand where and why designs are changed.
Description
Contribution Checklist
- [x] The code builds clean without any errors or warnings
- [x] The PR follows the SK Contribution Guidelines and the pre-submission formatting script raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone :smile:
Python Test Coverage Report
File Stmts Miss Cover Missing semantic_kernel kernel.py 157 7 96% 146, 157, 161, 311–314, 423 semantic_kernel/agents/open_ai open_ai_assistant_base.py 385 2 99% 301–302 semantic_kernel/connectors/ai/azure_ai_inference/services azure_ai_inference_chat_completion.py 149 4 97% 169, 312, 416, 430 semantic_kernel/connectors/ai/embeddings embedding_generator_base.py 8 1 88% 50 semantic_kernel/connectors/ai/google shared_utils.py 39 2 95% 100, 122 semantic_kernel/connectors/ai/google/google_ai/services google_ai_chat_completion.py 145 3 98% 149, 251, 287 utils.py 62 3 95% 138, 156–161 semantic_kernel/connectors/ai/google/vertex_ai/services utils.py 64 3 95% 140, 158–163 vertex_ai_chat_completion.py 145 3 98% 143, 244, 280 semantic_kernel/connectors/ai/hugging_face/services hf_text_completion.py 54 3 94% 97, 105, 136 hf_text_embedding.py 32 5 84% 79–83 semantic_kernel/connectors/openapi_plugin openapi_manager.py 58 2 97% 110–111 openapi_parser.py 88 1 99% 127 openapi_runner.py 105 2 98% 181–182 semantic_kernel/connectors/openapi_plugin/models rest_api_operation.py 129 1 99% 242 semantic_kernel/contents function_call_content.py 97 1 99% 201 semantic_kernel/functions kernel_function_decorator.py 98 1 99% 102 kernel_function_from_method.py 96 1 99% 153 kernel_function_from_prompt.py 154 7 95% 165–166, 180, 201, 219, 239, 322 kernel_plugin.py 187 2 99% 472, 475 semantic_kernel/planners plan.py 234 45 81% 54, 163–165, 197, 214–227, 264, 269, 277–278, 288–291, 308, 313, 329, 332–337, 355, 360, 363, 365, 372, 386–388, 393–397 semantic_kernel/planners/function_calling_stepwise_planner function_calling_stepwise_planner.py 116 4 97% 145, 189–190, 198 semantic_kernel/planners/sequential_planner sequential_planner.py 64 6 91% 71, 75, 109, 125, 134–135 sequential_planner_extensions.py 50 9 82% 31–32, 56, 110–124 sequential_planner_parser.py 77 12 84% 66–74, 93, 117–120 semantic_kernel/schema kernel_json_schema_builder.py 119 5 96% 50, 84, 206, 210–211 semantic_kernel/template_engine/blocks code_block.py 77 1 99% 119 named_arg_block.py 43 1 98% 98 semantic_kernel/utils/telemetry decorators.py 113 4 96% 232, 240, 243, 252 user_agent.py 16 2 88% 18–19 TOTAL 8648 143 98%
Python Unit Test Overview
| Tests | Skipped | Failures | Errors | Time |
|---|---|---|---|---|
| 2106 | 1 :zzz: | 0 :x: | 0 :fire: | 53.676s :stopwatch: |
Thanks for putting this together. Looks great!
Please re-open if/when we want to get this information into main.