95 lines
2.9 KiB
Python
95 lines
2.9 KiB
Python
from __future__ import annotations
|
|
|
|
import typing
|
|
from dataclasses import dataclass
|
|
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
|
|
|
|
|
|
class HookType(Enum):
|
|
BEFORE = "before"
|
|
AFTER = "after"
|
|
FINALLY_AFTER = "finally_after"
|
|
ERROR = "error"
|
|
|
|
|
|
@dataclass
|
|
class HookContext:
|
|
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
|
|
|
|
|
|
class Hook:
|
|
def before(
|
|
self, hook_context: HookContext, hints: dict
|
|
) -> 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: dict,
|
|
) -> 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: dict
|
|
) -> 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, hints: dict) -> 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
|