gofeatureflag-python-provider 0.1.1__tar.gz → 0.2.0__tar.gz

{gofeatureflag_python_provider-0.1.1 → gofeatureflag_python_provider-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gofeatureflag-python-provider
-Version: 0.1.1
+Version: 0.2.0
 Summary: GO Feature Flag provider for OpenFeature
 Home-page: https://gofeatureflag.org
 License: Apache-2.0
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: asyncio (>=3.4.3,<4.0.0)
-Requires-Dist: openfeature-sdk (>=0.4.1,<0.5.0)
+Requires-Dist: openfeature-sdk (>=0.5.0,<0.8.0)
 Requires-Dist: pydantic (>=2.5.2,<3.0.0)
 Requires-Dist: pylru (>=1.2.1,<2.0.0)
 Requires-Dist: rel (>=0.4.9,<0.5.0)
@@ -58,13 +58,13 @@ from gofeatureflag_python_provider.options import GoFeatureFlagOptions
 from openfeature import api
 from openfeature.evaluation_context import EvaluationContext
 
-// ...
+# ...
 
 goff_provider = GoFeatureFlagProvider(
     options=GoFeatureFlagOptions(endpoint="https://gofeatureflag.org/")
 )
 api.set_provider(goff_provider)
-client = api.get_client(name="test-client")
+client = api.get_client(domain="test-client")
 ```
 
 ## Evaluate your flag
@@ -76,9 +76,9 @@ This code block explains how you can create an `EvaluationContext` and use it to
 > 
 > **Refer to the [Open Feature documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api#basic-evaluation) to know more about it.**
 
-```csharp
-// Context of your flag evaluation.
-// With GO Feature Flag you MUST have a targetingKey that is a unique identifier of the user.
+```python
+# Context of your flag evaluation.
+# With GO Feature Flag you MUST have a targetingKey that is a unique identifier of the user.
 evaluation_ctx = EvaluationContext(
     targeting_key="d45e303a-38c2-11ed-a261-0242ac120002",
     attributes={

{gofeatureflag_python_provider-0.1.1 → gofeatureflag_python_provider-0.2.0}/README.md

@@ -28,13 +28,13 @@ from gofeatureflag_python_provider.options import GoFeatureFlagOptions
 from openfeature import api
 from openfeature.evaluation_context import EvaluationContext
 
-// ...
+# ...
 
 goff_provider = GoFeatureFlagProvider(
     options=GoFeatureFlagOptions(endpoint="https://gofeatureflag.org/")
 )
 api.set_provider(goff_provider)
-client = api.get_client(name="test-client")
+client = api.get_client(domain="test-client")
 ```
 
 ## Evaluate your flag
@@ -46,9 +46,9 @@ This code block explains how you can create an `EvaluationContext` and use it to
 > 
 > **Refer to the [Open Feature documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api#basic-evaluation) to know more about it.**
 
-```csharp
-// Context of your flag evaluation.
-// With GO Feature Flag you MUST have a targetingKey that is a unique identifier of the user.
+```python
+# Context of your flag evaluation.
+# With GO Feature Flag you MUST have a targetingKey that is a unique identifier of the user.
 evaluation_ctx = EvaluationContext(
     targeting_key="d45e303a-38c2-11ed-a261-0242ac120002",
     attributes={

{gofeatureflag_python_provider-0.1.1 → gofeatureflag_python_provider-0.2.0}/gofeatureflag_python_provider/provider.py

@@ -8,32 +8,29 @@ import pylru
 import urllib3
 import websocket
 from openfeature.evaluation_context import EvaluationContext
-from openfeature.exception import ErrorCode
 from openfeature.exception import (
+    ErrorCode,
     FlagNotFoundError,
-    TypeMismatchError,
     GeneralError,
     OpenFeatureError,
+    TypeMismatchError,
 )
-from openfeature.flag_evaluation import FlagEvaluationDetails
-from openfeature.flag_evaluation import Reason
+from openfeature.flag_evaluation import FlagResolutionDetails, Reason
 from openfeature.hook import Hook
 from openfeature.provider.metadata import Metadata
-from openfeature.provider.provider import AbstractProvider
-from pydantic import ValidationError, PrivateAttr
+from openfeature.provider import AbstractProvider
+from pydantic import PrivateAttr, ValidationError
 
 from gofeatureflag_python_provider.data_collector_hook import DataCollectorHook
 from gofeatureflag_python_provider.metadata import GoFeatureFlagMetadata
-from gofeatureflag_python_provider.options import BaseModel
-from gofeatureflag_python_provider.options import GoFeatureFlagOptions
-from gofeatureflag_python_provider.provider_status import ProviderStatus
+from gofeatureflag_python_provider.options import BaseModel, GoFeatureFlagOptions
 from gofeatureflag_python_provider.request_flag_evaluation import (
     RequestFlagEvaluation,
     convert_evaluation_context,
 )
 from gofeatureflag_python_provider.response_flag_evaluation import (
-    ResponseFlagEvaluation,
     JsonType,
+    ResponseFlagEvaluation,
 )
 
 AbstractProviderMetaclass = type(AbstractProvider)
@@ -48,7 +45,6 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
     options: GoFeatureFlagOptions
     _http_client: urllib3.PoolManager = PrivateAttr()
     _cache: pylru.lrucache = PrivateAttr()
-    _status: ProviderStatus = PrivateAttr(ProviderStatus.NOT_READY)
     _data_collector_hook: Optional[DataCollectorHook] = PrivateAttr()
     _ws: websocket.WebSocketApp = PrivateAttr()
     _ws_thread: Thread = PrivateAttr()
@@ -77,18 +73,8 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         self._ws = websocket.WebSocketApp(
             self._build_websocket_uri(),
             on_message=self._websocket_message_handler,
-            on_open=self._websocket_open_handler,
-            on_close=self._websocket_close_handler,
-            on_error=self._websocket_error_handler,
         )
 
-    def get_status(self) -> ProviderStatus:
-        """
-        get_status returns the status of the provider
-        :return: the status of the provider
-        """
-        return self._status
-
     def initialize(self, evaluation_context: EvaluationContext) -> None:
         """
         initialize is called when the provider is initialized.
@@ -101,8 +87,6 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         if self.options.disable_cache_invalidation is False:
             self._ws_thread = Thread(target=self.run_websocket)
             self._ws_thread.start()
-        else:
-            self._status = ProviderStatus.READY
 
     def shutdown(self):
         if self.options.disable_cache_invalidation is False:
@@ -116,8 +100,6 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
             self._data_collector_hook.shutdown()
             self._data_collector_hook = None
 
-        self._status = ProviderStatus.NOT_READY
-
     def get_metadata(self) -> Metadata:
         return GoFeatureFlagMetadata()
 
@@ -131,7 +113,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         flag_key: str,
         default_value: bool,
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagEvaluationDetails[bool]:
+    ) -> FlagResolutionDetails[bool]:
         return self.generic_go_feature_flag_resolver(
             bool, flag_key, default_value, evaluation_context
         )
@@ -141,7 +123,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         flag_key: str,
         default_value: str,
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagEvaluationDetails[str]:
+    ) -> FlagResolutionDetails[str]:
         return self.generic_go_feature_flag_resolver(
             str, flag_key, default_value, evaluation_context
         )
@@ -151,7 +133,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         flag_key: str,
         default_value: int,
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagEvaluationDetails[int]:
+    ) -> FlagResolutionDetails[int]:
         return self.generic_go_feature_flag_resolver(
             int, flag_key, default_value, evaluation_context
         )
@@ -161,7 +143,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         flag_key: str,
         default_value: float,
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagEvaluationDetails[float]:
+    ) -> FlagResolutionDetails[float]:
         return self.generic_go_feature_flag_resolver(
             float, flag_key, default_value, evaluation_context
         )
@@ -171,7 +153,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         flag_key: str,
         default_value: dict,
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagEvaluationDetails[Union[list, dict]]:
+    ) -> FlagResolutionDetails[Union[list, dict]]:
         return self.generic_go_feature_flag_resolver(
             Union[dict, list], flag_key, default_value, evaluation_context
         )
@@ -182,7 +164,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         flag_key: str,
         default_value: JsonType,
         evaluation_context: Optional[EvaluationContext] = None,
-    ) -> FlagEvaluationDetails[JsonType]:
+    ) -> FlagResolutionDetails[JsonType]:
         """
         generic_go_feature_flag_resolver is a generic evaluations of your flag with GO Feature Flag relay proxy it works
         with all types.
@@ -191,18 +173,9 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         :param flag_key:  name of the flag
         :param default_value: default value of the flag
         :param evaluation_context: context to evaluate the flag
-        :return: a FlagEvaluationDetails object containing the response for the SDK.
+        :return: a FlagResolutionDetails object containing the response for the SDK.
         """
         try:
-            if self._status != ProviderStatus.READY:
-                return FlagEvaluationDetails[original_type](
-                    flag_key=flag_key,
-                    value=default_value,
-                    reason=Reason.ERROR,
-                    error_code=ErrorCode.PROVIDER_NOT_READY,
-                    error_message="GO Feature Flag provider is not ready",
-                )
-
             goff_evaluation_context = convert_evaluation_context(evaluation_context)
             goff_request = RequestFlagEvaluation(
                 user=goff_evaluation_context,
@@ -252,8 +225,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
                     )
 
             if response_flag_evaluation.reason == Reason.DISABLED.value:
-                return FlagEvaluationDetails[original_type](
-                    flag_key=flag_key,
+                return FlagResolutionDetails[original_type](
                     value=default_value,
                     reason=Reason.DISABLED,
                 )
@@ -263,8 +235,7 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
                     "flag {} was not found in your configuration".format(flag_key)
                 )
 
-            return FlagEvaluationDetails[original_type](
-                flag_key=flag_key,
+            return FlagResolutionDetails[original_type](
                 value=response_flag_evaluation.value,
                 variant=response_flag_evaluation.variationType,
                 reason=(
@@ -315,29 +286,5 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
         # when we receive a message from go-feature-flag server, we clear the cache.
         self._cache.clear()
 
-    def _websocket_open_handler(self, ws_app) -> None:
-        """
-        websocket_open_handler is the handler called when the websocket is open
-        :param ws app: the websocket app
-        :return: None
-        """
-        self._status = ProviderStatus.READY
-
-    def _websocket_error_handler(self, ws_app, error) -> None:
-        """
-        websocket_error_handler is the handler called when we receive an error from the GO Feature Flag server
-        :param ws_app: the websocket app
-        :param error: error received
-        :return: None
-        """
-        self._status = ProviderStatus.ERROR
-
-    def _websocket_close_handler(self, ws_app, close_status_code, close_msg) -> None:
-        """
-        websocket_close_handler is the handler called when the websocket is closed
-        :param wsapp: the websocket app
-        :param close_status_code: the status code of the close
-        :param close_msg: the message of the close
-        :return: None
-        """
-        self._status = ProviderStatus.STALE
+    def __hash__(self):
+        return id(self)

{gofeatureflag_python_provider-0.1.1 → gofeatureflag_python_provider-0.2.0}/gofeatureflag_python_provider/response_flag_evaluation.py

@@ -1,4 +1,4 @@
-from typing import Optional, Generic, Union, TypeVar
+from typing import Optional, Union, TypeVar
 from gofeatureflag_python_provider.options import BaseModel
 
 

{gofeatureflag_python_provider-0.1.1 → gofeatureflag_python_provider-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gofeatureflag-python-provider"
-version = "0.1.1"
+version = "0.2.0"
 description = "GO Feature Flag provider for OpenFeature"
 license = "Apache-2.0"
 authors = [ "Thomas Poignant" ]
@@ -28,7 +28,7 @@ classifiers = [
 
   [tool.poetry.dependencies]
   python = "^3.9"
-  openfeature-sdk = "^0.4.1"
+  openfeature-sdk = ">=0.5.0,<0.8.0"
   pydantic = "^2.5.2"
   urllib3 = "^2.1.0"
   pylru = "^1.2.1"

gofeatureflag_python_provider-0.1.1/gofeatureflag_python_provider/provider_status.py

@@ -1,9 +0,0 @@
-from enum import Enum
-
-
-# ProviderStatus is an enum that represents the status of a provider
-class ProviderStatus(Enum):
-    NOT_READY = 1
-    READY = 2
-    STALE = 3
-    ERROR = 4