gofeatureflag-python-provider 0.3.0__tar.gz → 0.4.1__tar.gz

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: gofeatureflag-python-provider
-Version: 0.3.0
+Version: 0.4.1
 Summary: GO Feature Flag provider for OpenFeature
-Home-page: https://gofeatureflag.org
 License: Apache-2.0
 Keywords: feature flags,feature toggles,go-feature-flag,gofeatureflag,openfeature,open-feature
 Author: Thomas Poignant
@@ -25,6 +24,7 @@ Requires-Dist: urllib3 (>=2.1.0,<3.0.0)
 Requires-Dist: websocket-client (>=1.6.4,<2.0.0)
 Project-URL: Bug Tracker, https://github.com/thomaspoignant/go-feature-flag/issues
 Project-URL: Documentation, https://github.com/thomaspoignant/go-feature-flag/tree/main/openfeature/providers/python-provider
+Project-URL: Homepage, https://gofeatureflag.org
 Project-URL: Repository, https://github.com/thomaspoignant/go-feature-flag
 Project-URL: Source Code, https://github.com/thomaspoignant/go-feature-flag/tree/main/openfeature/providers/python-provider
 Description-Content-Type: text/markdown

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/gofeatureflag_python_provider/data_collector_hook.py

@@ -1,19 +1,17 @@
 import datetime
 import threading
 import time
-from http import HTTPStatus
-from typing import Optional
-from urllib.parse import urljoin
-
 import urllib3
-from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
-from openfeature.hook import Hook, HookContext
-
 from gofeatureflag_python_provider.options import GoFeatureFlagOptions
 from gofeatureflag_python_provider.request_data_collector import (
     FeatureEvent,
     RequestDataCollector,
 )
+from http import HTTPStatus
+from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
+from openfeature.hook import Hook, HookContext
+from typing import Optional
+from urllib.parse import urljoin
 
 default_targeting_key = "undefined-targetingKey"
 
@@ -31,6 +29,8 @@ class DataCollectorHook(Hook):
     _http_client: urllib3.PoolManager = None
     # _data_event_queue is the list of data to collect
     _event_queue: list[FeatureEvent] = []
+    # _exporter_metadata is the metadata we send to the GO Feature Flag relay proxy when we report the evaluation data usage.
+    _exporter_metadata: dict = {}
 
     def __init__(self, options: GoFeatureFlagOptions, http_client: urllib3.PoolManager):
         self._http_client = http_client
@@ -39,6 +39,9 @@ class DataCollectorHook(Hook):
         self._data_collector_endpoint = urljoin(
             str(self._options.endpoint), "/v1/data/collector"
         )
+        self._exporter_metadata = options.exporter_metadata
+        self._exporter_metadata["provider"] = "python"
+        self._exporter_metadata["openfeature"] = True
 
     def after(
         self, hook_context: HookContext, details: FlagEvaluationDetails, hints: dict
@@ -106,7 +109,7 @@ class DataCollectorHook(Hook):
         if len(self._event_queue) > 0:
             try:
                 goff_request = RequestDataCollector(
-                    meta={"provider": "open-feature-python-sdk"},
+                    meta=self._exporter_metadata,
                     events=self._event_queue,
                 )
                 headers = {"Content-Type": "application/json"}

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/gofeatureflag_python_provider/options.py

@@ -50,3 +50,10 @@ class GoFeatureFlagOptions(BaseModel):
     # an API Key to the provider. Please ask the administrator of the relay proxy to provide an API Key.
     # Default: None
     api_key: typing.Optional[str] = None
+
+    # ExporterMetadata (optional) is the metadata we send to the GO Feature Flag relay proxy when we report the
+    # evaluation data usage.
+    #
+    # ‼️Important: If you are using a GO Feature Flag relay proxy before version v1.41.0, the information of this
+    # field will not be added to your feature events.
+    exporter_metadata: typing.Optional[dict] = {}

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/gofeatureflag_python_provider/provider.py

@@ -1,12 +1,19 @@
 import json
-from http import HTTPStatus
-from threading import Thread
-from typing import List, Optional, Type, Union
-from urllib.parse import urljoin
-
 import pylru
 import urllib3
 import websocket
+from gofeatureflag_python_provider.data_collector_hook import DataCollectorHook
+from gofeatureflag_python_provider.metadata import GoFeatureFlagMetadata
+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 (
+    JsonType,
+    ResponseFlagEvaluation,
+)
+from http import HTTPStatus
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.exception import (
     ErrorCode,
@@ -17,21 +24,11 @@ from openfeature.exception import (
 )
 from openfeature.flag_evaluation import FlagResolutionDetails, Reason
 from openfeature.hook import Hook
-from openfeature.provider.metadata import Metadata
 from openfeature.provider import AbstractProvider
+from openfeature.provider.metadata import Metadata
 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, GoFeatureFlagOptions
-from gofeatureflag_python_provider.request_flag_evaluation import (
-    RequestFlagEvaluation,
-    convert_evaluation_context,
-)
-from gofeatureflag_python_provider.response_flag_evaluation import (
-    JsonType,
-    ResponseFlagEvaluation,
-)
+from threading import Thread
+from typing import List, Optional, Type, Union
 
 AbstractProviderMetaclass = type(AbstractProvider)
 BaseModelMetaclass = type(BaseModel)
@@ -196,6 +193,16 @@ class GoFeatureFlagProvider(BaseModel, AbstractProvider, metaclass=CombinedMetac
                     "/v1/feature/{}/eval".format(flag_key),
                 )
 
+                # add exporter metadata to the context if it exists
+                if self.options.exporter_metadata:
+                    goff_request.gofeatureflag["exporterMetadata"] = (
+                        self.options.exporter_metadata
+                    )
+                    goff_request.gofeatureflag["exporterMetadata"]["openfeature"] = True
+                    goff_request.gofeatureflag["exporterMetadata"][
+                        "provider"
+                    ] = "python"
+
                 response = self._http_client.request(
                     method="POST",
                     url=url,

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/gofeatureflag_python_provider/request_data_collector.py

@@ -1,8 +1,6 @@
-from typing import Optional, Any
-
-from pydantic import Field, SkipValidation
-
 from gofeatureflag_python_provider.options import BaseModel
+from pydantic import Field, SkipValidation
+from typing import Optional, Any, Union
 
 
 class FeatureEvent(BaseModel):
@@ -47,7 +45,7 @@ class FeatureEvent(BaseModel):
 
 class RequestDataCollector(BaseModel):
     # Meta are the extra information added to identify who is calling the endpoint.
-    meta: Optional[dict[str, str]] = None
+    meta: Optional[dict[str, Union[str, int, float, bool]]] = None
 
     # Events is the list of the event we send in the payload
     events: list[FeatureEvent] = []

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/gofeatureflag_python_provider/request_flag_evaluation.py

@@ -1,15 +1,13 @@
 import hashlib
 import json
-from typing import Optional, Any
-
+from gofeatureflag_python_provider.options import BaseModel
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.exception import (
     TargetingKeyMissingError,
     InvalidContextError,
 )
 from pydantic import SkipValidation
-
-from gofeatureflag_python_provider.options import BaseModel
+from typing import Optional, Any, Dict
 
 
 class GoFeatureFlagEvaluationContext(BaseModel):
@@ -56,3 +54,4 @@ def convert_evaluation_context(
 class RequestFlagEvaluation(BaseModel):
     user: GoFeatureFlagEvaluationContext
     defaultValue: SkipValidation[Any] = None
+    gofeatureflag: Optional[Dict] = {}

{gofeatureflag_python_provider-0.3.0 → gofeatureflag_python_provider-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gofeatureflag-python-provider"
-version = "0.3.0"
+version = "0.4.1"
 description = "GO Feature Flag provider for OpenFeature"
 license = "Apache-2.0"
 authors = [ "Thomas Poignant" ]
@@ -38,7 +38,7 @@ classifiers = [
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.4,<9.0"
-black = ">=23.10.1,<25.0.0"
+black = ">=23.10.1,<26.0.0"
 requests = "^2.31.0"
 pyyaml = "^6.0.1"
 pytest-docker = ">=2.0.1,<4.0.0"