refactor!: simplify namespaces to make public API more pythonic (#172)

* refactor!: simplify namespaces to make public API more pythonic

Signed-off-by: Federico Bond <federicobond@gmail.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>

Author: 3 people

open_feature/hooks/hook_support.py renamed to open_feature/_internal/hook_support.py

@@ -2,12 +2,9 @@
 import typing
 from functools import reduce
 
-from open_feature.evaluation_context.evaluation_context import EvaluationContext
-from open_feature.flag_evaluation.flag_evaluation_details import FlagEvaluationDetails
-from open_feature.flag_evaluation.flag_type import FlagType
-from open_feature.hooks.hook import Hook
-from open_feature.hooks.hook_context import HookContext
-from open_feature.hooks.hook_type import HookType
+from open_feature.evaluation_context import EvaluationContext
+from open_feature.flag_evaluation import FlagEvaluationDetails, FlagType
+from open_feature.hook import Hook, HookContext, HookType
 
 
 def error_hooks(

open_feature/open_feature_api.py renamed to open_feature/api.py

@@ -1,9 +1,9 @@
 import typing
 
-from open_feature.evaluation_context.evaluation_context import EvaluationContext
-from open_feature.exception.exceptions import GeneralError
-from open_feature.hooks.hook import Hook
-from open_feature.open_feature_client import OpenFeatureClient
+from open_feature.client import OpenFeatureClient
+from open_feature.evaluation_context import EvaluationContext
+from open_feature.exception import GeneralError
+from open_feature.hook import Hook
 from open_feature.provider.metadata import Metadata
 from open_feature.provider.no_op_provider import NoOpProvider
 from open_feature.provider.provider import AbstractProvider

open_feature/open_feature_client.py renamed to open_feature/client.py

@@ -2,22 +2,23 @@
 import typing
 from dataclasses import dataclass
 
-from open_feature import open_feature_api as api
-from open_feature.evaluation_context.evaluation_context import EvaluationContext
-from open_feature.exception.error_code import ErrorCode
-from open_feature.exception.exceptions import (
+from open_feature import api
+from open_feature.evaluation_context import EvaluationContext
+from open_feature.exception import (
+    ErrorCode,
     GeneralError,
     OpenFeatureError,
     TypeMismatchError,
 )
-from open_feature.flag_evaluation.flag_evaluation_details import FlagEvaluationDetails
-from open_feature.flag_evaluation.flag_evaluation_options import FlagEvaluationOptions
-from open_feature.flag_evaluation.flag_type import FlagType
-from open_feature.flag_evaluation.reason import Reason
-from open_feature.flag_evaluation.resolution_details import FlagResolutionDetails
-from open_feature.hooks.hook import Hook
-from open_feature.hooks.hook_context import HookContext
-from open_feature.hooks.hook_support import (
+from open_feature.flag_evaluation import (
+    FlagEvaluationDetails,
+    FlagEvaluationOptions,
+    FlagType,
+    Reason,
+    FlagResolutionDetails,
+)
+from open_feature.hook import Hook, HookContext
+from open_feature.hook.hook_support import (
     after_all_hooks,
     after_hooks,
     before_hooks,

open_feature/evaluation_context/evaluation_context.py renamed to open_feature/evaluation_context.py

@@ -1,6 +1,15 @@
 import typing
+from enum import Enum
 
-from open_feature.exception.error_code import ErrorCode
+
+class ErrorCode(Enum):
+    PROVIDER_NOT_READY = "PROVIDER_NOT_READY"
+    FLAG_NOT_FOUND = "FLAG_NOT_FOUND"
+    PARSE_ERROR = "PARSE_ERROR"
+    TYPE_MISMATCH = "TYPE_MISMATCH"
+    TARGETING_KEY_MISSING = "TARGETING_KEY_MISSING"
+    INVALID_CONTEXT = "INVALID_CONTEXT"
+    GENERAL = "GENERAL"
 
 
 class OpenFeatureError(Exception):

open_feature/exception/exceptions.py renamed to open_feature/exception.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+import typing
+from dataclasses import dataclass, field
+
+from open_feature._backports.strenum import StrEnum
+from open_feature.exception import ErrorCode
+
+if typing.TYPE_CHECKING:  # resolves a circular dependency in type annotations
+    from open_feature.hook import Hook
+
+
+class FlagType(StrEnum):
+    BOOLEAN = "BOOLEAN"
+    STRING = "STRING"
+    OBJECT = "OBJECT"
+    FLOAT = "FLOAT"
+    INTEGER = "INTEGER"
+
+
+class Reason(StrEnum):
+    CACHED = "CACHED"
+    DEFAULT = "DEFAULT"
+    DISABLED = "DISABLED"
+    ERROR = "ERROR"
+    STATIC = "STATIC"
+    SPLIT = "SPLIT"
+    TARGETING_MATCH = "TARGETING_MATCH"
+    UNKNOWN = "UNKNOWN"
+
+
+T = typing.TypeVar("T", covariant=True)
+
+
+@dataclass
+class FlagEvaluationDetails(typing.Generic[T]):
+    flag_key: str
+    value: T
+    variant: typing.Optional[str] = None
+    reason: typing.Optional[Reason] = None
+    error_code: typing.Optional[ErrorCode] = None
+    error_message: typing.Optional[str] = None
+
+
+@dataclass
+class FlagEvaluationOptions:
+    hooks: typing.List[Hook] = field(default_factory=list)
+    hook_hints: dict = field(default_factory=dict)
+
+
+U = typing.TypeVar("U", covariant=True)
+
+
+@dataclass
+class FlagResolutionDetails(typing.Generic[U]):
+    value: U
+    error_code: typing.Optional[ErrorCode] = None
+    error_message: typing.Optional[str] = None
+    reason: typing.Optional[Reason] = None
+    variant: typing.Optional[str] = None
+    flag_metadata: typing.Optional[str] = None