gofeatureflag-python-provider 0.1.0__tar.gz → 0.1.2__tar.gz

{gofeatureflag_python_provider-0.1.0 → gofeatureflag_python_provider-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gofeatureflag-python-provider
-Version: 0.1.0
+Version: 0.1.2
 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.6.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,27 +58,27 @@ 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
 
-This code block explain how you can create an `EvaluationContext` and use it to evaluate your flag.
+This code block explains how you can create an `EvaluationContext` and use it to evaluate your flag.
 
 
 > In this example we are evaluating a `boolean` flag, but other types are available.
 > 
 > **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.0 → gofeatureflag_python_provider-0.1.2}/README.md

@@ -28,27 +28,27 @@ 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
 
-This code block explain how you can create an `EvaluationContext` and use it to evaluate your flag.
+This code block explains how you can create an `EvaluationContext` and use it to evaluate your flag.
 
 
 > In this example we are evaluating a `boolean` flag, but other types are available.
 > 
 > **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.0 → gofeatureflag_python_provider-0.1.2}/gofeatureflag_python_provider/data_collector_hook.py

@@ -47,9 +47,11 @@ class DataCollectorHook(Hook):
             # we don't collect data if the data collection is disabled or if the flag is not cached
             return
         feature_event = FeatureEvent(
-            contextKind="anonymousUser"
-            if hook_context.evaluation_context.attributes["anonymous"]
-            else "user",
+            contextKind=(
+                "anonymousUser"
+                if hook_context.evaluation_context.attributes["anonymous"]
+                else "user"
+            ),
             creationDate=int(datetime.datetime.now().timestamp()),
             default=False,
             key=hook_context.flag_key,
@@ -66,9 +68,11 @@ class DataCollectorHook(Hook):
             return
 
         feature_event = FeatureEvent(
-            contextKind="anonymousUser"
-            if hook_context.evaluation_context.attributes["anonymous"]
-            else "user",
+            contextKind=(
+                "anonymousUser"
+                if hook_context.evaluation_context.attributes["anonymous"]
+                else "user"
+            ),
             creationDate=int(datetime.datetime.now().timestamp()),
             default=True,
             key=hook_context.flag_key,

{gofeatureflag_python_provider-0.1.0 → gofeatureflag_python_provider-0.1.2}/gofeatureflag_python_provider/provider.py

@@ -8,36 +8,41 @@ 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 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.options import BaseModel, GoFeatureFlagOptions
 from gofeatureflag_python_provider.provider_status import ProviderStatus
 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)
+BaseModelMetaclass = type(BaseModel)
 
-class GoFeatureFlagProvider(AbstractProvider, BaseModel):
+
+class CombinedMetaclass(AbstractProviderMetaclass, BaseModelMetaclass):
+    pass
+
+
+class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetaclass):
     options: GoFeatureFlagOptions
     _http_client: urllib3.PoolManager = PrivateAttr()
     _cache: pylru.lrucache = PrivateAttr()
@@ -124,7 +129,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         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
         )
@@ -134,7 +139,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         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
         )
@@ -144,7 +149,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         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
         )
@@ -154,7 +159,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         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
         )
@@ -164,7 +169,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         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
         )
@@ -175,7 +180,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         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.
@@ -184,12 +189,11 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         :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,
+                return FlagResolutionDetails[original_type](
                     value=default_value,
                     reason=Reason.ERROR,
                     error_code=ErrorCode.PROVIDER_NOT_READY,
@@ -245,8 +249,7 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
                     )
 
             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,
                 )
@@ -256,13 +259,12 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
                     "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=Reason.CACHED
-                if is_from_cache
-                else response_flag_evaluation.reason,
+                reason=(
+                    Reason.CACHED if is_from_cache else response_flag_evaluation.reason
+                ),
                 flag_metadata=response_flag_evaluation.metadata,
             )
         except ValidationError as exc:
@@ -334,3 +336,6 @@ class GoFeatureFlagProvider(AbstractProvider, BaseModel):
         :return: None
         """
         self._status = ProviderStatus.STALE
+
+    def __hash__(self):
+        return id(self)

{gofeatureflag_python_provider-0.1.0 → gofeatureflag_python_provider-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gofeatureflag-python-provider"
-version = "0.1.0"
+version = "0.1.2"
 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.6.0"
   pydantic = "^2.5.2"
   urllib3 = "^2.1.0"
   pylru = "^1.2.1"
@@ -37,11 +37,11 @@ classifiers = [
   asyncio = "^3.4.3"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.4"
-black = "^23.10.1"
+pytest = ">=7.4,<9.0"
+black = ">=23.10.1,<25.0.0"
 requests = "^2.31.0"
 pyyaml = "^6.0.1"
-pytest-docker = "^2.0.1"
+pytest-docker = ">=2.0.1,<4.0.0"
 
 [build-system]
 requires = [ "poetry-core>=1.0.0" ]