Files
semantic-kernel/python/semantic_kernel/exceptions/function_exceptions.py
T
Eduard van Valkenburg 51f5554b39 Python: removed D101 and fixes for it (#7853)
### 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 😄
2024-08-05 16:33:49 +00:00

92 lines
2.1 KiB
Python

# Copyright (c) Microsoft. All rights reserved.
from semantic_kernel.exceptions.kernel_exceptions import KernelException
class FunctionException(KernelException):
"""Base class for all function exceptions."""
pass
class FunctionSyntaxError(FunctionException):
"""Base class for all function syntax exceptions."""
pass
class FunctionInitializationError(FunctionException):
"""An error occurred while initializing the function."""
def __init__(self, message: str):
"""Adds the context of the error to the generic message."""
super().__init__("KernelFunction failed to initialize: " + message)
class PluginInitializationError(FunctionException):
"""An error occurred while initializing the plugin."""
pass
class PluginInvalidNameError(FunctionSyntaxError):
"""An error occurred while validating the plugin name."""
pass
class FunctionInvalidNameError(FunctionSyntaxError):
"""An error occurred while validating the function name."""
pass
class FunctionInvalidParamNameError(FunctionSyntaxError):
"""An error occurred while validating the function parameter name."""
pass
class FunctionNameNotUniqueError(FunctionSyntaxError):
"""An error occurred while validating the function name."""
pass
class FunctionExecutionException(FunctionException):
"""Base class for all function execution exceptions."""
pass
class FunctionResultError(FunctionException):
"""An error occurred while validating the function result."""
pass
class FunctionInvalidParameterConfiguration(FunctionException):
"""An error occurred while validating the function parameter configuration."""
pass
class PromptRenderingException(FunctionException):
"""An error occurred while rendering a prompt."""
pass
__all__ = [
"FunctionException",
"FunctionExecutionException",
"FunctionInitializationError",
"FunctionInvalidNameError",
"FunctionInvalidParamNameError",
"FunctionNameNotUniqueError",
"FunctionResultError",
"FunctionSyntaxError",
"PluginInitializationError",
"PluginInvalidNameError",
"PromptRenderingException",
]