160 lines
4.3 KiB
Python
160 lines
4.3 KiB
Python
from __future__ import annotations
|
|
|
|
import typing
|
|
from datetime import datetime
|
|
from enum import Enum
|
|
from typing import TYPE_CHECKING
|
|
|
|
from openfeature.evaluation_context import EvaluationContext
|
|
from openfeature.flag_evaluation import FlagEvaluationDetails, FlagType
|
|
|
|
if TYPE_CHECKING:
|
|
from openfeature.client import ClientMetadata
|
|
from openfeature.provider.metadata import Metadata
|
|
|
|
__all__ = [
|
|
"Hook",
|
|
"HookContext",
|
|
"HookHints",
|
|
"HookType",
|
|
"add_hooks",
|
|
"clear_hooks",
|
|
"get_hooks",
|
|
]
|
|
|
|
_hooks: list[Hook] = []
|
|
|
|
|
|
class HookType(Enum):
|
|
BEFORE = "before"
|
|
AFTER = "after"
|
|
FINALLY_AFTER = "finally_after"
|
|
ERROR = "error"
|
|
|
|
|
|
class HookContext:
|
|
def __init__(
|
|
self,
|
|
flag_key: str,
|
|
flag_type: FlagType,
|
|
default_value: typing.Any,
|
|
evaluation_context: EvaluationContext,
|
|
client_metadata: typing.Optional[ClientMetadata] = None,
|
|
provider_metadata: typing.Optional[Metadata] = None,
|
|
):
|
|
self.flag_key = flag_key
|
|
self.flag_type = flag_type
|
|
self.default_value = default_value
|
|
self.evaluation_context = evaluation_context
|
|
self.client_metadata = client_metadata
|
|
self.provider_metadata = provider_metadata
|
|
|
|
def __setattr__(self, key: str, value: typing.Any) -> None:
|
|
if hasattr(self, key) and key in (
|
|
"flag_key",
|
|
"flag_type",
|
|
"default_value",
|
|
"client_metadata",
|
|
"provider_metadata",
|
|
):
|
|
raise AttributeError(f"Attribute {key!r} is immutable")
|
|
super().__setattr__(key, value)
|
|
|
|
|
|
# https://openfeature.dev/specification/sections/hooks/#requirement-421
|
|
HookHints = typing.Mapping[
|
|
str,
|
|
typing.Union[
|
|
bool,
|
|
int,
|
|
float,
|
|
str,
|
|
datetime,
|
|
list[typing.Any],
|
|
dict[str, typing.Any],
|
|
],
|
|
]
|
|
|
|
|
|
class Hook:
|
|
def before(
|
|
self, hook_context: HookContext, hints: HookHints
|
|
) -> typing.Optional[EvaluationContext]:
|
|
"""
|
|
Runs before flag is resolved.
|
|
|
|
:param hook_context: Information about the particular flag evaluation
|
|
:param hints: An immutable mapping of data for users to
|
|
communicate to the hooks.
|
|
:return: An EvaluationContext. It will be merged with the
|
|
EvaluationContext instances from other hooks, the client and API.
|
|
"""
|
|
return None
|
|
|
|
def after(
|
|
self,
|
|
hook_context: HookContext,
|
|
details: FlagEvaluationDetails[typing.Any],
|
|
hints: HookHints,
|
|
) -> None:
|
|
"""
|
|
Runs after a flag is resolved.
|
|
|
|
:param hook_context: Information about the particular flag evaluation
|
|
:param details: Information about how the flag was resolved,
|
|
including any resolved values.
|
|
:param hints: A mapping of data for users to communicate to the hooks.
|
|
"""
|
|
pass
|
|
|
|
def error(
|
|
self, hook_context: HookContext, exception: Exception, hints: HookHints
|
|
) -> None:
|
|
"""
|
|
Run when evaluation encounters an error. Errors thrown will be swallowed.
|
|
|
|
:param hook_context: Information about the particular flag evaluation
|
|
:param exception: The exception that was thrown
|
|
:param hints: A mapping of data for users to communicate to the hooks.
|
|
"""
|
|
pass
|
|
|
|
def finally_after(
|
|
self,
|
|
hook_context: HookContext,
|
|
details: FlagEvaluationDetails[typing.Any],
|
|
hints: HookHints,
|
|
) -> None:
|
|
"""
|
|
Run after flag evaluation, including any error processing.
|
|
This will always run. Errors will be swallowed.
|
|
|
|
:param hook_context: Information about the particular flag evaluation
|
|
:param hints: A mapping of data for users to communicate to the hooks.
|
|
"""
|
|
pass
|
|
|
|
def supports_flag_value_type(self, flag_type: FlagType) -> bool:
|
|
"""
|
|
Check to see if the hook supports the particular flag type.
|
|
|
|
:param flag_type: particular type of the flag
|
|
:return: a boolean containing whether the flag type is supported (True)
|
|
or not (False)
|
|
"""
|
|
return True
|
|
|
|
|
|
def add_hooks(hooks: list[Hook]) -> None:
|
|
global _hooks
|
|
_hooks = _hooks + hooks
|
|
|
|
|
|
def clear_hooks() -> None:
|
|
global _hooks
|
|
_hooks = []
|
|
|
|
|
|
def get_hooks() -> list[Hook]:
|
|
return _hooks
|