mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 11:19:56 +00:00
Eduard van Valkenburg
51f5554b39
### Motivation and Context <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> Added comments about each of the rules to pyproject.toml Removed D101 from ignore list and fixed that, now docstrings at the class level are required. ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [x] The code builds clean without any errors or warnings - [x] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [x] All unit tests pass, and I have added new tests where possible - [x] I didn't break anyone 😄
Prompt Template Engine
The Semantic Kernel uses the following grammar to parse prompt templates:
# BNF parsed by TemplateTokenizer
[template] ::= "" | [block] | [block] [template]
[block] ::= [sk-block] | [text-block]
[sk-block] ::= "{{" [variable] "}}" | "{{" [value] "}}" | "{{" [function-call] "}}"
[text-block] ::= [any-char] | [any-char] [text-block]
[any-char] ::= any char
# BNF parsed by CodeTokenizer:
[template] ::= "" | [variable] " " [template] | [value] " " [template] | [function-call] " " [template]
[variable] ::= "$" [valid-name]
[value] ::= "'" [text] "'" | '"' [text] '"'
[function-call] ::= [function-id] | [function-id] [parameter]
[parameter] ::= [variable] | [value]
# BNF parsed by dedicated blocks
[function-id] ::= [valid-name] | [valid-name] "." [valid-name]
[valid-name] ::= [valid-symbol] | [valid-symbol] [valid-name]
[valid-symbol] ::= [letter] | [digit] | "_"
[letter] ::= "a" | "b" ... | "z" | "A" | "B" ... | "Z"
[digit] ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"