flagsmith 3.7.0__tar.gz → 3.9.0__tar.gz

{flagsmith-3.7.0 → flagsmith-3.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flagsmith
-Version: 3.7.0
+Version: 3.9.0
 Summary: Flagsmith Python SDK
 License: BSD3
 Keywords: feature,flag,flagsmith,remote,config
@@ -12,10 +12,10 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: flagsmith-flag-engine (>=5.1.0,<6.0.0)
-Requires-Dist: requests (>=2.27.1,<3.0.0)
-Requires-Dist: requests-futures (>=1.0.0,<2.0.0)
+Requires-Dist: pydantic (>=2,<3)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: requests-futures (>=1.0.1,<2.0.0)
 Requires-Dist: sseclient-py (>=1.8.0,<2.0.0)
 Project-URL: Documentation, https://docs.flagsmith.com
 Description-Content-Type: text/markdown
@@ -36,8 +36,8 @@ For full documentation visit
 
 ## Contributing
 
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
-of conduct, and the process for submitting pull requests
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull
+requests
 
 ## Getting Help
 

{flagsmith-3.7.0 → flagsmith-3.9.0}/README.md

@@ -14,8 +14,8 @@ For full documentation visit
 
 ## Contributing
 
-Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
-of conduct, and the process for submitting pull requests
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull
+requests
 
 ## Getting Help
 

flagsmith-3.9.0/flagsmith/__init__.py

@@ -0,0 +1,4 @@
+from . import webhooks
+from .flagsmith import Flagsmith
+
+__all__ = ("Flagsmith", "webhooks")

{flagsmith-3.7.0 → flagsmith-3.9.0}/flagsmith/flagsmith.py

@@ -1,8 +1,8 @@
-import json
 import logging
 import typing
-from datetime import datetime, timezone
+from datetime import timezone
 
+import pydantic
 import requests
 from flag_engine import engine
 from flag_engine.environments.models import EnvironmentModel
@@ -19,23 +19,14 @@ from flagsmith.models import DefaultFlag, Flags, Segment
 from flagsmith.offline_handlers import BaseOfflineHandler
 from flagsmith.polling_manager import EnvironmentDataPollingManager
 from flagsmith.streaming_manager import EventStreamManager, StreamEvent
-from flagsmith.utils.identities import Identity, generate_identities_data
+from flagsmith.types import JsonType, TraitConfig, TraitMapping
+from flagsmith.utils.identities import generate_identity_data
 
 logger = logging.getLogger(__name__)
 
 DEFAULT_API_URL = "https://edge.api.flagsmith.com/api/v1/"
 DEFAULT_REALTIME_API_URL = "https://realtime.flagsmith.com/"
 
-JsonType = typing.Union[
-    None,
-    int,
-    str,
-    bool,
-    typing.List["JsonType"],
-    typing.List[typing.Mapping[str, "JsonType"]],
-    typing.Dict[str, "JsonType"],
-]
-
 
 class Flagsmith:
     """A Flagsmith client.
@@ -168,8 +159,10 @@ class Flagsmith:
                 )
 
     def _initialise_local_evaluation(self) -> None:
+        # To ensure that the environment is set before allowing subsequent
+        # method calls, update the environment manually.
+        self.update_environment()
         if self.enable_realtime_updates:
-            self.update_environment()
             if not self._environment:
                 raise ValueError("Unable to get environment from API key")
 
@@ -184,9 +177,6 @@ class Flagsmith:
             self.event_stream_thread.start()
 
         else:
-            # To ensure that the environment is set before allowing subsequent
-            # method calls, update the environment manually.
-            self.update_environment()
             self.environment_data_polling_manager_thread = (
                 EnvironmentDataPollingManager(
                     main=self,
@@ -198,21 +188,6 @@ class Flagsmith:
             self.environment_data_polling_manager_thread.start()
 
     def handle_stream_event(self, event: StreamEvent) -> None:
-        try:
-            event_data = json.loads(event.data)
-        except json.JSONDecodeError as e:
-            raise FlagsmithAPIError("Unable to get valid json from event data.") from e
-
-        try:
-            stream_updated_at = datetime.fromtimestamp(event_data.get("updated_at"))
-        except TypeError as e:
-            raise FlagsmithAPIError(
-                "Unable to get valid timestamp from event data."
-            ) from e
-
-        if stream_updated_at.tzinfo is None:
-            stream_updated_at = stream_updated_at.astimezone(timezone.utc)
-
         if not self._environment:
             raise ValueError(
                 "Unable to access environment. Environment should not be null"
@@ -221,7 +196,7 @@ class Flagsmith:
         if environment_updated_at.tzinfo is None:
             environment_updated_at = environment_updated_at.astimezone(timezone.utc)
 
-        if stream_updated_at > environment_updated_at:
+        if event.updated_at > environment_updated_at:
             self.update_environment()
 
     def get_environment_flags(self) -> Flags:
@@ -237,7 +212,9 @@ class Flagsmith:
     def get_identity_flags(
         self,
         identifier: str,
-        traits: typing.Optional[typing.Mapping[str, TraitValue]] = None,
+        traits: typing.Optional[TraitMapping] = None,
+        *,
+        transient: bool = False,
     ) -> Flags:
         """
         Get all the flags for the current environment for a given identity. Will also
@@ -247,13 +224,20 @@ class Flagsmith:
         :param identifier: a unique identifier for the identity in the current
             environment, e.g. email address, username, uuid
         :param traits: a dictionary of traits to add / update on the identity in
-            Flagsmith, e.g. {"num_orders": 10}
+            Flagsmith, e.g. `{"num_orders": 10}`. Envelope traits you don't want persisted
+            in a dictionary with `"transient"` and `"value"` keys, e.g.
+            `{"num_orders": 10, "color": {"value": "pink", "transient": True}}`.
+        :param transient: if `True`, the identity won't get persisted
         :return: Flags object holding all the flags for the given identity.
         """
         traits = traits or {}
         if (self.offline_mode or self.enable_local_evaluation) and self._environment:
             return self._get_identity_flags_from_document(identifier, traits)
-        return self._get_identity_flags_from_api(identifier, traits)
+        return self._get_identity_flags_from_api(
+            identifier,
+            traits,
+            transient=transient,
+        )
 
     def get_identity_segments(
         self,
@@ -281,16 +265,15 @@ class Flagsmith:
         return [Segment(id=sm.id, name=sm.name) for sm in segment_models]
 
     def update_environment(self) -> None:
-        self._environment = self._get_environment_from_api()
-        self._update_overrides()
-
-    def _update_overrides(self) -> None:
-        if not self._environment:
-            return
-        if overrides := self._environment.identity_overrides:
-            self._identity_overrides_by_identifier = {
-                identity.identifier: identity for identity in overrides
-            }
+        try:
+            self._environment = self._get_environment_from_api()
+        except (FlagsmithAPIError, pydantic.ValidationError):
+            logger.exception("Error updating environment")
+        else:
+            if overrides := self._environment.identity_overrides:
+                self._identity_overrides_by_identifier = {
+                    identity.identifier: identity for identity in overrides
+                }
 
     def _get_environment_from_api(self) -> EnvironmentModel:
         environment_data = self._get_json_response(self.environment_url, method="GET")
@@ -306,7 +289,7 @@ class Flagsmith:
         )
 
     def _get_identity_flags_from_document(
-        self, identifier: str, traits: typing.Mapping[str, TraitValue]
+        self, identifier: str, traits: TraitMapping
     ) -> Flags:
         identity_model = self._get_identity_model(identifier, **traits)
         if self._environment is None:
@@ -339,13 +322,23 @@ class Flagsmith:
             raise
 
     def _get_identity_flags_from_api(
-        self, identifier: str, traits: typing.Mapping[str, typing.Any]
+        self,
+        identifier: str,
+        traits: TraitMapping,
+        *,
+        transient: bool = False,
     ) -> Flags:
+        request_body = generate_identity_data(
+            identifier,
+            traits,
+            transient=transient,
+        )
         try:
-            data = generate_identities_data(identifier, traits)
             json_response: typing.Dict[str, typing.List[typing.Dict[str, JsonType]]] = (
                 self._get_json_response(
-                    url=self.identities_url, method="POST", body=data
+                    url=self.identities_url,
+                    method="POST",
+                    body=request_body,
                 )
             )
             return Flags.from_api_flags(
@@ -364,22 +357,16 @@ class Flagsmith:
         self,
         url: str,
         method: str,
-        body: typing.Optional[
-            typing.Union[Identity, typing.Dict[str, JsonType]]
-        ] = None,
+        body: typing.Optional[JsonType] = None,
     ) -> typing.Any:
         try:
             request_method = getattr(self.session, method.lower())
             response = request_method(
                 url, json=body, timeout=self.request_timeout_seconds
             )
-            if response.status_code != 200:
-                raise FlagsmithAPIError(
-                    "Invalid request made to Flagsmith API. Response status code: %d",
-                    response.status_code,
-                )
+            response.raise_for_status()
             return response.json()
-        except (requests.ConnectionError, json.JSONDecodeError) as e:
+        except requests.RequestException as e:
             raise FlagsmithAPIError(
                 "Unable to get valid response from Flagsmith API."
             ) from e
@@ -387,7 +374,7 @@ class Flagsmith:
     def _get_identity_model(
         self,
         identifier: str,
-        **traits: TraitValue,
+        **traits: typing.Union[TraitValue, TraitConfig],
     ) -> IdentityModel:
         if not self._environment:
             raise FlagsmithClientError(
@@ -395,7 +382,10 @@ class Flagsmith:
             )
 
         trait_models = [
-            TraitModel(trait_key=key, trait_value=value)
+            TraitModel(
+                trait_key=key,
+                trait_value=value["value"] if isinstance(value, dict) else value,
+            )
             for key, value in traits.items()
         ]
 

{flagsmith-3.7.0 → flagsmith-3.9.0}/flagsmith/polling_manager.py

@@ -5,10 +5,6 @@ import threading
 import time
 import typing
 
-import requests
-
-from flagsmith.exceptions import FlagsmithAPIError
-
 if typing.TYPE_CHECKING:
     from flagsmith import Flagsmith
 
@@ -30,10 +26,7 @@ class EnvironmentDataPollingManager(threading.Thread):
 
     def run(self) -> None:
         while not self._stop_event.is_set():
-            try:
-                self.main.update_environment()
-            except (FlagsmithAPIError, requests.RequestException):
-                logger.exception("Failed to update environment")
+            self.main.update_environment()
             time.sleep(self.refresh_interval_seconds)
 
     def stop(self) -> None:

{flagsmith-3.7.0 → flagsmith-3.9.0}/flagsmith/streaming_manager.py

@@ -1,18 +1,17 @@
 import logging
 import threading
 import typing
-from typing import Callable, Generator, Optional, Protocol, cast
+from typing import Callable, Optional
 
+import pydantic
 import requests
 import sseclient
 
-from flagsmith.exceptions import FlagsmithAPIError
-
 logger = logging.getLogger(__name__)
 
 
-class StreamEvent(Protocol):
-    data: str
+class StreamEvent(pydantic.BaseModel):
+    updated_at: pydantic.AwareDatetime
 
 
 class EventStreamManager(threading.Thread):
@@ -22,7 +21,7 @@ class EventStreamManager(threading.Thread):
         stream_url: str,
         on_event: Callable[[StreamEvent], None],
         request_timeout_seconds: Optional[int] = None,
-        **kwargs: typing.Any
+        **kwargs: typing.Any,
     ) -> None:
         super().__init__(*args, **kwargs)
         self._stop_event = threading.Event()
@@ -39,17 +38,12 @@ class EventStreamManager(threading.Thread):
                     headers={"Accept": "application/json, text/event-stream"},
                     timeout=self.request_timeout_seconds,
                 ) as response:
-                    sse_client = sseclient.SSEClient(
-                        cast(Generator[bytes, None, None], response)
-                    )
+                    sse_client = sseclient.SSEClient(chunk for chunk in response)
                     for event in sse_client.events():
-                        self.on_event(event)
-
-            except requests.exceptions.ReadTimeout:
-                pass
+                        self.on_event(StreamEvent.model_validate_json(event.data))
 
-            except (FlagsmithAPIError, requests.RequestException):
-                logger.exception("Error handling event stream")
+            except (requests.RequestException, pydantic.ValidationError):
+                logger.exception("Error opening or reading from the event stream")
 
     def stop(self) -> None:
         self._stop_event.set()

flagsmith-3.9.0/flagsmith/types.py

@@ -0,0 +1,25 @@
+import typing
+
+from flag_engine.identities.traits.types import TraitValue
+from typing_extensions import TypeAlias
+
+_JsonScalarType: TypeAlias = typing.Union[
+    int,
+    str,
+    float,
+    bool,
+    None,
+]
+JsonType: TypeAlias = typing.Union[
+    _JsonScalarType,
+    typing.Dict[str, "JsonType"],
+    typing.List["JsonType"],
+]
+
+
+class TraitConfig(typing.TypedDict):
+    value: TraitValue
+    transient: bool
+
+
+TraitMapping: TypeAlias = typing.Mapping[str, typing.Union[TraitValue, TraitConfig]]

flagsmith-3.9.0/flagsmith/utils/identities.py

@@ -0,0 +1,26 @@
+import typing
+
+from flagsmith.types import JsonType, TraitMapping
+
+
+def generate_identity_data(
+    identifier: str,
+    traits: TraitMapping,
+    *,
+    transient: bool,
+) -> JsonType:
+    identity_data: typing.Dict[str, JsonType] = {"identifier": identifier}
+    traits_data: typing.List[JsonType] = []
+    for trait_key, trait_value in traits.items():
+        trait_data: typing.Dict[str, JsonType] = {"trait_key": trait_key}
+        if isinstance(trait_value, dict):
+            trait_data["trait_value"] = trait_value["value"]
+            if trait_value.get("transient"):
+                trait_data["transient"] = True
+        else:
+            trait_data["trait_value"] = trait_value
+        traits_data.append(trait_data)
+    identity_data["traits"] = traits_data
+    if transient:
+        identity_data["transient"] = True
+    return identity_data

flagsmith-3.9.0/flagsmith/webhooks.py

@@ -0,0 +1,41 @@
+import hashlib
+import hmac
+from typing import Union
+
+
+def generate_signature(
+    request_body: Union[str, bytes],
+    shared_secret: str,
+) -> str:
+    """Generates a signature for a webhook request body using HMAC-SHA256.
+
+    :param request_body: The raw request body, as string or bytes.
+    :param shared_secret: The shared secret configured for this specific webhook.
+    :return: The hex-encoded signature.
+    """
+    if isinstance(request_body, str):
+        request_body = request_body.encode()
+
+    shared_secret_bytes = shared_secret.encode()
+
+    return hmac.new(
+        key=shared_secret_bytes,
+        msg=request_body,
+        digestmod=hashlib.sha256,
+    ).hexdigest()
+
+
+def verify_signature(
+    request_body: Union[str, bytes],
+    received_signature: str,
+    shared_secret: str,
+) -> bool:
+    """Verifies a webhook's signature to determine if the request was sent by Flagsmith.
+
+    :param request_body: The raw request body, as string or bytes.
+    :param received_signature: The signature as received in the X-Flagsmith-Signature request header.
+    :param shared_secret: The shared secret configured for this specific webhook.
+    :return: True if the signature is valid, False otherwise.
+    """
+    expected_signature = generate_signature(request_body, shared_secret)
+    return hmac.compare_digest(expected_signature, received_signature)

{flagsmith-3.7.0 → flagsmith-3.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "flagsmith"
-version = "3.7.0"
+version = "3.9.0"
 description = "Flagsmith Python SDK"
 authors = ["Flagsmith <support@flagsmith.com>"]
 license = "BSD3"
@@ -11,30 +11,29 @@ packages = [{ include = "flagsmith" }]
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<4"
-requests = "^2.27.1"
-requests-futures = "^1.0.0"
+requests = "^2.32.3"
+requests-futures = "^1.0.1"
 flagsmith-flag-engine = "^5.1.0"
 sseclient-py = "^1.8.0"
+pydantic = "^2"
 
 [tool.poetry.group.dev]
 optional = true
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.0"
+pytest-cov = "^4.1.0"
 pytest-mock = "^3.6.1"
-black = ">=23.3,<25.0"
 pre-commit = "^2.17.0"
 responses = "^0.24.1"
-flake8 = "^6.1.0"
-isort = "^5.12.0"
-mypy = "^1.7.1"
-types-requests = "^2.31.0.10"
-pytest-cov = "^4.1.0"
+types-requests = "^2.32"
 
 [tool.mypy]
 plugins = ["pydantic.mypy"]
 exclude = ["example/*"]
 
+[tool.black]
+target-version = ["py38"]
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

flagsmith-3.7.0/flagsmith/__init__.py

@@ -1,3 +0,0 @@
-from .flagsmith import Flagsmith
-
-__all__ = ("Flagsmith",)

flagsmith-3.7.0/flagsmith/utils/identities.py

@@ -1,21 +0,0 @@
-import typing
-
-from flag_engine.identities.traits.types import TraitValue
-
-Identity = typing.TypedDict(
-    "Identity",
-    {"identifier": str, "traits": typing.List[typing.Mapping[str, TraitValue]]},
-)
-
-
-def generate_identities_data(
-    identifier: str, traits: typing.Optional[typing.Mapping[str, TraitValue]] = None
-) -> Identity:
-    return {
-        "identifier": identifier,
-        "traits": (
-            [{"trait_key": k, "trait_value": v} for k, v in traits.items()]
-            if traits
-            else []
-        ),
-    }