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 😄
155 lines
4.0 KiB
Python
155 lines
4.0 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
|
|
from semantic_kernel.exceptions.kernel_exceptions import KernelException
|
|
|
|
|
|
class BlockException(KernelException):
|
|
"""Base class for all block exceptions."""
|
|
|
|
pass
|
|
|
|
|
|
class BlockSyntaxError(BlockException):
|
|
"""A invalid block syntax was found."""
|
|
|
|
pass
|
|
|
|
|
|
class BlockRenderException(BlockException):
|
|
"""An error occurred while rendering a block."""
|
|
|
|
pass
|
|
|
|
|
|
class VarBlockSyntaxError(BlockSyntaxError):
|
|
"""A invalid VarBlock syntax was found."""
|
|
|
|
def __init__(self, content: str) -> None:
|
|
"""Adds the context of the error to the generic message."""
|
|
super().__init__(
|
|
f"A VarBlock starts with a '$' followed by at least one letter, \
|
|
number or underscore, anything else is invalid. \
|
|
The content provided was: {content}",
|
|
)
|
|
|
|
|
|
class VarBlockRenderError(BlockRenderException):
|
|
"""An error occurred while rendering a VarBlock."""
|
|
|
|
pass
|
|
|
|
|
|
class ValBlockSyntaxError(BlockSyntaxError):
|
|
"""A invalid ValBlock syntax was found."""
|
|
|
|
def __init__(self, content: str) -> None:
|
|
"""Adds the context of the error to the generic message."""
|
|
super().__init__(
|
|
f"A ValBlock starts with a single or double quote followed by at least one letter, \
|
|
finishing with the same type of quote as the first one. \
|
|
The content provided was: {content}",
|
|
)
|
|
|
|
|
|
class NamedArgBlockSyntaxError(BlockSyntaxError):
|
|
"""A invalid NamedArgBlock syntax was found."""
|
|
|
|
def __init__(self, content: str) -> None:
|
|
"""Adds the context of the error to the generic message."""
|
|
super().__init__(
|
|
f"A NamedArgBlock starts with a name (letters, numbers or underscore) \
|
|
followed by a single equal sign, then the value of the argument, \
|
|
which can either be a VarBlock (starting with '$') \
|
|
or a ValBlock (text surrounded by quotes). \
|
|
The content provided was: {content}",
|
|
)
|
|
|
|
|
|
class FunctionIdBlockSyntaxError(BlockSyntaxError):
|
|
"""A invalid FunctionIdBlock syntax was found."""
|
|
|
|
def __init__(self, content: str) -> None:
|
|
"""Adds the context of the error to the generic message."""
|
|
super().__init__(
|
|
f"A FunctionIdBlock is composed of either a plugin name and \
|
|
function name separated by a single dot, or just a function name. \
|
|
Both plugin and function names can only contain letters, numbers and underscores. \
|
|
The content provided was: {content}",
|
|
)
|
|
|
|
|
|
class CodeBlockSyntaxError(BlockSyntaxError):
|
|
"""A invalid CodeBlock syntax was found."""
|
|
|
|
pass
|
|
|
|
|
|
class CodeBlockTokenError(BlockException):
|
|
"""An error occurred while tokenizing a CodeBlock."""
|
|
|
|
pass
|
|
|
|
|
|
class CodeBlockRenderException(BlockRenderException):
|
|
"""An error occurred while rendering a CodeBlock."""
|
|
|
|
pass
|
|
|
|
|
|
class TemplateSyntaxError(BlockSyntaxError):
|
|
"""A invalid Template syntax was found."""
|
|
|
|
pass
|
|
|
|
|
|
class TemplateRenderException(BlockRenderException):
|
|
"""An error occurred while rendering a Template."""
|
|
|
|
pass
|
|
|
|
|
|
class HandlebarsTemplateSyntaxError(BlockSyntaxError):
|
|
"""A invalid HandlebarsTemplate syntax was found."""
|
|
|
|
pass
|
|
|
|
|
|
class HandlebarsTemplateRenderException(BlockRenderException):
|
|
"""An error occurred while rendering a HandlebarsTemplate."""
|
|
|
|
pass
|
|
|
|
|
|
class Jinja2TemplateSyntaxError(BlockSyntaxError):
|
|
"""A invalid Jinja2Template syntax was found."""
|
|
|
|
pass
|
|
|
|
|
|
class Jinja2TemplateRenderException(BlockRenderException):
|
|
"""An error occurred while rendering a Jinja2Template."""
|
|
|
|
pass
|
|
|
|
|
|
__all__ = [
|
|
"BlockException",
|
|
"BlockRenderException",
|
|
"BlockSyntaxError",
|
|
"CodeBlockRenderException",
|
|
"CodeBlockSyntaxError",
|
|
"CodeBlockTokenError",
|
|
"FunctionIdBlockSyntaxError",
|
|
"HandlebarsTemplateRenderException",
|
|
"HandlebarsTemplateSyntaxError",
|
|
"Jinja2TemplateRenderException",
|
|
"Jinja2TemplateSyntaxError",
|
|
"NamedArgBlockSyntaxError",
|
|
"TemplateRenderException",
|
|
"TemplateSyntaxError",
|
|
"ValBlockSyntaxError",
|
|
"VarBlockRenderError",
|
|
"VarBlockSyntaxError",
|
|
]
|