Skip to content

feat: add FeatureProvider protocol #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 3, 2024
Merged

feat: add FeatureProvider protocol #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c180405
feat: add FeatureProvider interface
federicobond Nov 15, 2023
ec6df50
Update openfeature/provider/__init__.py
federicobond Feb 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions openfeature/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
from openfeature.evaluation_context import EvaluationContext
from openfeature.exception import GeneralError
from openfeature.hook import Hook
from openfeature.provider import FeatureProvider
from openfeature.provider.metadata import Metadata
from openfeature.provider.no_op_provider import NoOpProvider
from openfeature.provider.provider import AbstractProvider

_provider: AbstractProvider = NoOpProvider()
_provider: FeatureProvider = NoOpProvider()

_evaluation_context = EvaluationContext()

Expand All @@ -21,7 +21,7 @@ def get_client(
return OpenFeatureClient(name=name, version=version, provider=_provider)


def set_provider(provider: AbstractProvider) -> None:
def set_provider(provider: FeatureProvider) -> None:
global _provider
if provider is None:
raise GeneralError(error_message="No provider")
Expand All @@ -31,7 +31,7 @@ def set_provider(provider: AbstractProvider) -> None:
provider.initialize(_evaluation_context)


def get_provider() -> typing.Optional[AbstractProvider]:
def get_provider() -> typing.Optional[FeatureProvider]:
global _provider
return _provider

Expand Down
4 changes: 2 additions & 2 deletions openfeature/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
before_hooks,
error_hooks,
)
from openfeature.provider import FeatureProvider
from openfeature.provider.no_op_provider import NoOpProvider
from openfeature.provider.provider import AbstractProvider

logger = logging.getLogger("openfeature")

Expand Down Expand Up @@ -69,7 +69,7 @@ def __init__(
self,
name: typing.Optional[str],
version: typing.Optional[str],
provider: AbstractProvider,
provider: FeatureProvider,
context: typing.Optional[EvaluationContext] = None,
hooks: typing.Optional[typing.List[Hook]] = None,
) -> None:
Expand Down
61 changes: 61 additions & 0 deletions openfeature/provider/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import typing

from openfeature.evaluation_context import EvaluationContext
from openfeature.flag_evaluation import FlagResolutionDetails
from openfeature.hook import Hook

from .metadata import Metadata


class FeatureProvider(typing.Protocol): # pragma: no cover
def initialize(self, evaluation_context: EvaluationContext) -> None:
...

def shutdown(self) -> None:
...

def get_metadata(self) -> Metadata:
...

def get_provider_hooks(self) -> typing.List[Hook]:
...

def resolve_boolean_details(
self,
flag_key: str,
default_value: bool,
evaluation_context: typing.Optional[EvaluationContext] = None,
) -> FlagResolutionDetails[bool]:
...

def resolve_string_details(
self,
flag_key: str,
default_value: str,
evaluation_context: typing.Optional[EvaluationContext] = None,
) -> FlagResolutionDetails[str]:
...

def resolve_integer_details(
self,
flag_key: str,
default_value: int,
evaluation_context: typing.Optional[EvaluationContext] = None,
) -> FlagResolutionDetails[int]:
...

def resolve_float_details(
self,
flag_key: str,
default_value: float,
evaluation_context: typing.Optional[EvaluationContext] = None,
) -> FlagResolutionDetails[float]:
...

def resolve_object_details(
self,
flag_key: str,
default_value: typing.Union[dict, list],
evaluation_context: typing.Optional[EvaluationContext] = None,
) -> FlagResolutionDetails[typing.Union[dict, list]]:
...
3 changes: 2 additions & 1 deletion openfeature/provider/provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
from openfeature.evaluation_context import EvaluationContext
from openfeature.flag_evaluation import FlagResolutionDetails
from openfeature.hook import Hook
from openfeature.provider import FeatureProvider
from openfeature.provider.metadata import Metadata


class AbstractProvider:
class AbstractProvider(FeatureProvider):
def initialize(self, evaluation_context: EvaluationContext) -> None:
pass

Expand Down
10 changes: 5 additions & 5 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
from openfeature.hook import Hook
from openfeature.provider.metadata import Metadata
from openfeature.provider.no_op_provider import NoOpProvider
from openfeature.provider.provider import AbstractProvider
from openfeature.provider.provider import FeatureProvider


def test_should_not_raise_exception_with_noop_client():
Expand Down Expand Up @@ -61,7 +61,7 @@ def test_should_try_set_provider_and_fail_if_none_provided():
def test_should_invoke_provider_initialize_function_on_newly_registered_provider():
# Given
evaluation_context = EvaluationContext("targeting_key", {"attr1": "val1"})
provider = MagicMock(spec=AbstractProvider)
provider = MagicMock(spec=FeatureProvider)

# When
set_evaluation_context(evaluation_context)
Expand All @@ -73,8 +73,8 @@ def test_should_invoke_provider_initialize_function_on_newly_registered_provider

def test_should_invoke_provider_shutdown_function_once_provider_is_no_longer_in_use():
# Given
provider_1 = MagicMock(spec=AbstractProvider)
provider_2 = MagicMock(spec=AbstractProvider)
provider_1 = MagicMock(spec=FeatureProvider)
provider_2 = MagicMock(spec=FeatureProvider)

# When
set_provider(provider_1)
Expand Down Expand Up @@ -148,7 +148,7 @@ def test_should_add_hooks_to_api_hooks():

def test_should_call_provider_shutdown_on_api_shutdown():
# Given
provider = MagicMock(spec=AbstractProvider)
provider = MagicMock(spec=FeatureProvider)
set_provider(provider)

# When
Expand Down