growthbook 1.3.1__py2.py3-none-any.whl → 1.4.1__py2.py3-none-any.whl

growthbook/__init__.py

@@ -18,5 +18,5 @@ from .plugins import (
 )
 
 # x-release-please-start-version
-__version__ = "1.3.1"
+__version__ = "1.4.1"
 # x-release-please-end

growthbook/common_types.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 import sys
+from token import OP
 # Only require typing_extensions if using Python 3.7 or earlier
 if sys.version_info >= (3, 8):
     from typing import TypedDict
@@ -8,7 +9,7 @@ else:
     from typing_extensions import TypedDict
 
 from dataclasses import dataclass, field
-from typing import Any, Dict, List, Optional, Union, Set, Tuple
+from typing import Any, Callable, Dict, List, Optional, Union, Set, Tuple
 from enum import Enum
 from abc import ABC, abstractmethod
 
@@ -400,6 +401,15 @@ class StackContext:
 class FeatureRefreshStrategy(Enum):
     STALE_WHILE_REVALIDATE = 'HTTP_REFRESH'
     SERVER_SENT_EVENTS = 'SSE'
+@dataclass
+class UserContext:
+    # user_id: Optional[str] = None
+    url: str = ""
+    attributes: Dict[str, Any] = field(default_factory=dict)
+    groups: Dict[str, str] = field(default_factory=dict)
+    forced_variations: Dict[str, Any] = field(default_factory=dict)
+    overrides: Dict[str, Any] = field(default_factory=dict)
+    sticky_bucket_assignment_docs: Dict[str, Any] = field(default_factory=dict)
 
 @dataclass
 class Options:
@@ -415,17 +425,9 @@ class Options:
     refresh_strategy: Optional[FeatureRefreshStrategy] = FeatureRefreshStrategy.STALE_WHILE_REVALIDATE
     sticky_bucket_service: Optional[AbstractStickyBucketService] = None
     sticky_bucket_identifier_attributes: Optional[List[str]] = None
-    on_experiment_viewed=None
+    on_experiment_viewed: Optional[Callable[[Experiment, Result, Optional[UserContext]], None]] = None
+    tracking_plugins: Optional[List[Any]] = None
 
-@dataclass
-class UserContext:
-    # user_id: Optional[str] = None
-    url: str = ""
-    attributes: Dict[str, Any] = field(default_factory=dict)
-    groups: Dict[str, str] = field(default_factory=dict)
-    forced_variations: Dict[str, Any] = field(default_factory=dict)
-    overrides: Dict[str, Any] = field(default_factory=dict)
-    sticky_bucket_assignment_docs: Dict[str, Any] = field(default_factory=dict)
 
 @dataclass
 class GlobalContext:

growthbook/core.py

@@ -4,7 +4,7 @@ import json
 
 from urllib.parse import urlparse, parse_qs
 from typing import Callable, Optional, Any, Set, Tuple, List, Dict
-from .common_types import EvaluationContext, FeatureResult, Experiment, Filter, Result, VariationMeta
+from .common_types import EvaluationContext, FeatureResult, Experiment, Filter, Result, UserContext, VariationMeta
 
 
 logger = logging.getLogger("growthbook.core")
@@ -414,7 +414,7 @@ def eval_feature(
     key: str,
     evalContext: EvaluationContext = None,
     callback_subscription: Callable[[Experiment, Result], None] = None,
-    tracking_cb: Callable[[Experiment, Result], None] = None
+    tracking_cb: Callable[[Experiment, Result, UserContext], None] = None
 ) -> FeatureResult:
     """Core feature evaluation logic as a standalone function"""
 
@@ -634,7 +634,7 @@ def _get_sticky_bucket_variation(
 def run_experiment(experiment: Experiment, 
                    featureId: Optional[str] = None, 
                    evalContext: EvaluationContext = None, 
-                   tracking_cb: Callable[[Experiment, Result], None] = None
+                   tracking_cb: Callable[[Experiment, Result, UserContext], None] = None
                 ) -> Result:
     if evalContext is None:
         raise ValueError("evalContext is required - run_experiment")
@@ -859,7 +859,7 @@ def run_experiment(experiment: Experiment,
 
     # 14. Fire the tracking callback if set
     if tracking_cb:
-        tracking_cb(experiment, result)
+        tracking_cb(experiment, result, evalContext.user)
 
     # 15. Return the result
     logger.debug("Assigned variation %d in experiment %s", assigned, experiment.key)

growthbook/growthbook.py

@@ -120,12 +120,13 @@ class InMemoryStickyBucketService(AbstractStickyBucketService):
 
 
 class SSEClient:
-    def __init__(self, api_host, client_key, on_event, reconnect_delay=5, headers=None):
+    def __init__(self, api_host, client_key, on_event, reconnect_delay=5, headers=None, timeout = 30):
         self.api_host = api_host
         self.client_key = client_key
 
         self.on_event = on_event
         self.reconnect_delay = reconnect_delay
+        self.timeout = timeout
 
         self._sse_session = None
         self._sse_thread = None
@@ -173,7 +174,8 @@ class SSEClient:
         
         while self.is_running:
             try:
-                async with aiohttp.ClientSession(headers=self.headers) as session:
+                async with aiohttp.ClientSession(headers=self.headers, 
+                    timeout=aiohttp.ClientTimeout(total=self.timeout)) as session:
                     self._sse_session = session
 
                     async with session.get(url) as response:
@@ -407,10 +409,10 @@ class FeatureRepository(object):
         return data
 
 
-    def startAutoRefresh(self, api_host, client_key, cb):
+    def startAutoRefresh(self, api_host, client_key, cb, streaming_timeout=30):
         if not client_key:
             raise ValueError("Must specify `client_key` to start features streaming")
-        self.sse_client = self.sse_client or SSEClient(api_host=api_host, client_key=client_key, on_event=cb)
+        self.sse_client = self.sse_client or SSEClient(api_host=api_host, client_key=client_key, on_event=cb, timeout=streaming_timeout)
         self.sse_client.connect()
 
     def stopAutoRefresh(self):
@@ -443,6 +445,7 @@ class GrowthBook(object):
         sticky_bucket_identifier_attributes: List[str] = None,
         savedGroups: dict = {},
         streaming: bool = False,
+        streaming_timeout: int = 30,
         plugins: List = None,
         # Deprecated args
         trackingCallback=None,
@@ -471,6 +474,7 @@ class GrowthBook(object):
         self._trackingCallback = on_experiment_viewed or trackingCallback
 
         self._streaming = streaming
+        self._streaming_timeout = streaming_timeout
 
         # Deprecated args
         self._user = user
@@ -587,7 +591,8 @@ class GrowthBook(object):
         feature_repo.startAutoRefresh(
             api_host=self._api_host, 
             client_key=self._client_key,
-            cb=self._dispatch_sse_event
+            cb=self._dispatch_sse_event,
+            streaming_timeout=self._streaming_timeout
         )
 
     def stopAutoRefresh(self):
@@ -671,7 +676,7 @@ class GrowthBook(object):
         return self.get_feature_value(key, fallback)
 
     def get_feature_value(self, key: str, fallback):
-        res = self.evalFeature(key)
+        res = self.eval_feature(key)
         return res.value if res.value is not None else fallback
 
     # @deprecated, use eval_feature
@@ -753,7 +758,7 @@ class GrowthBook(object):
         self._subscriptions.add(callback)
         return lambda: self._subscriptions.remove(callback)
 
-    def _track(self, experiment: Experiment, result: Result) -> None:
+    def _track(self, experiment: Experiment, result: Result, user_context: UserContext) -> None:
         if not self._trackingCallback:
             return None
         key = (
@@ -764,7 +769,7 @@ class GrowthBook(object):
         )
         if not self._tracked.get(key):
             try:
-                self._trackingCallback(experiment=experiment, result=result)
+                self._trackingCallback(experiment=experiment, result=result, user_context=user_context)
                 self._tracked[key] = True
             except Exception:
                 pass

growthbook/growthbook_client.py

@@ -317,6 +317,10 @@ class GrowthBookClient:
         }
         self._sticky_bucket_cache_lock = False
         
+        # Plugin support
+        self._tracking_plugins: List[Any] = self.options.tracking_plugins or []
+        self._initialized_plugins: List[Any] = []
+        
         self._features_repository = (
             EnhancedFeatureRepository(
                 self.options.api_host or "https://cdn.growthbook.io", 
@@ -330,9 +334,12 @@ class GrowthBookClient:
         
         self._global_context: Optional[GlobalContext] = None
         self._context_lock = asyncio.Lock()
+        
+        # Initialize plugins
+        self._initialize_plugins()
 
 
-    def _track(self, experiment: Experiment, result: Result) -> None:
+    def _track(self, experiment: Experiment, result: Result, user_context: UserContext) -> None:
         """Thread-safe tracking implementation"""
         if not self.options.on_experiment_viewed:
             return
@@ -348,7 +355,7 @@ class GrowthBookClient:
         with self._tracked_lock:
             if not self._tracked.get(key):
                 try:
-                    self.options.on_experiment_viewed(experiment=experiment, result=result)
+                    self.options.on_experiment_viewed(experiment, result, user_context)
                     self._tracked[key] = True
                 except Exception:
                     logger.exception("Error in tracking callback")
@@ -492,25 +499,25 @@ class GrowthBookClient:
         """Evaluate a feature with proper async context management"""
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
-            result = core_eval_feature(key=key, evalContext=context)
+            result = core_eval_feature(key=key, evalContext=context, tracking_cb=self._track)
             return result
 
     async def is_on(self, key: str, user_context: UserContext) -> bool:
         """Check if a feature is enabled with proper async context management"""
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
-            return core_eval_feature(key=key, evalContext=context).on
+            return core_eval_feature(key=key, evalContext=context, tracking_cb=self._track).on
     
     async def is_off(self, key: str, user_context: UserContext) -> bool:
         """Check if a feature is set to off with proper async context management"""
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
-            return core_eval_feature(key=key, evalContext=context).off
+            return core_eval_feature(key=key, evalContext=context, tracking_cb=self._track).off
     
     async def get_feature_value(self, key: str, fallback: Any, user_context: UserContext) -> Any:
         async with self._context_lock:
             context = await self.create_evaluation_context(user_context)
-            result = core_eval_feature(key=key, evalContext=context)
+            result = core_eval_feature(key=key, evalContext=context, tracking_cb=self._track)
             return result.value if result.value is not None else fallback
 
     async def run(self, experiment: Experiment, user_context: UserContext) -> Result:
@@ -539,4 +546,37 @@ class GrowthBookClient:
 
         # Clear context
         async with self._context_lock:
-            self._global_context = None
+            self._global_context = None
+            
+        # Cleanup plugins
+        self._cleanup_plugins()
+
+    def _initialize_plugins(self) -> None:
+        """Initialize all tracking plugins with this GrowthBookClient instance."""
+        for plugin in self._tracking_plugins:
+            try:
+                if hasattr(plugin, 'initialize'):
+                    # Plugin is a class instance with initialize method
+                    plugin.initialize(self)
+                    self._initialized_plugins.append(plugin)
+                    logger.debug(f"Initialized plugin: {plugin.__class__.__name__}")
+                elif callable(plugin):
+                    # Plugin is a callable function
+                    plugin(self)
+                    self._initialized_plugins.append(plugin)
+                    logger.debug(f"Initialized callable plugin: {plugin.__name__}")
+                else:
+                    logger.warning(f"Plugin {plugin} is neither callable nor has initialize method")
+            except Exception as e:
+                logger.error(f"Failed to initialize plugin {plugin}: {e}")
+
+    def _cleanup_plugins(self) -> None:
+        """Cleanup all initialized plugins."""
+        for plugin in self._initialized_plugins:
+            try:
+                if hasattr(plugin, 'cleanup'):
+                    plugin.cleanup()
+                    logger.debug(f"Cleaned up plugin: {plugin.__class__.__name__}")
+            except Exception as e:
+                logger.error(f"Error cleaning up plugin {plugin}: {e}")
+        self._initialized_plugins.clear()

growthbook/plugins/growthbook_tracking.py

@@ -2,14 +2,16 @@ import json
 import logging
 import threading
 import time
-from typing import Dict, Any, Optional, List, Callable
+from typing import Dict, Any, Optional, List, Callable, TYPE_CHECKING
 from .base import GrowthBookPlugin
 
-requests: Any = None
-try:
-    import requests
-except ImportError:
-    pass
+if TYPE_CHECKING:
+    import requests  # type: ignore
+else:
+    try:
+        import requests  # type: ignore
+    except ImportError:
+        requests = None
 
 logger = logging.getLogger("growthbook.plugins.growthbook_tracking")
 
@@ -88,22 +90,43 @@ class GrowthBookTrackingPlugin(GrowthBookPlugin):
         super().cleanup()
     
     def _setup_experiment_tracking(self, gb_instance) -> None:
-        """Setup experiment tracking."""
-        original_callback = getattr(gb_instance, '_trackingCallback', None)
+        """Setup experiment tracking for both legacy and async clients."""
         
-        def tracking_wrapper(experiment, result):
+        def tracking_wrapper(experiment, result, user_context=None):
             # Track to ingestor
             self._track_experiment_viewed(experiment, result)
             
             # Call additional callback
             if self.additional_callback:
-                self._safe_execute(self.additional_callback, experiment, result)
+                self._safe_execute(self.additional_callback, experiment, result, user_context)
+        
+        # Check if it's the legacy GrowthBook client (has _trackingCallback)
+        if hasattr(gb_instance, '_trackingCallback'):
+            # Legacy GrowthBook client
+            original_callback = getattr(gb_instance, '_trackingCallback', None)
+            
+            def legacy_wrapper(experiment, result, user_context=None):
+                tracking_wrapper(experiment, result, user_context)
+                # Call original callback
+                if original_callback:
+                    self._safe_execute(original_callback, experiment, result, user_context)
+            
+            gb_instance._trackingCallback = legacy_wrapper
+            
+        elif hasattr(gb_instance, 'options') and hasattr(gb_instance.options, 'on_experiment_viewed'):
+            # New GrowthBookClient (async)
+            original_callback = gb_instance.options.on_experiment_viewed
+            
+            def async_wrapper(experiment, result, user_context):
+                tracking_wrapper(experiment, result, user_context)
+                # Call original callback
+                if original_callback:
+                    self._safe_execute(original_callback, experiment, result, user_context)
             
-            # Call original callback
-            if original_callback:
-                self._safe_execute(original_callback, experiment, result)
+            gb_instance.options.on_experiment_viewed = async_wrapper
         
-        gb_instance._trackingCallback = tracking_wrapper
+        else:
+            self.logger.warning("_trackingCallback or on_experiment_viewed properties not found - tracking may not work properly")
     
     def _setup_feature_tracking(self, gb_instance):
         """Setup feature evaluation tracking."""

growthbook/plugins/request_context.py

@@ -77,6 +77,7 @@ class RequestContextPlugin(GrowthBookPlugin):
         self.client_side_attributes = client_side_attributes
         self.extract_utm = extract_utm
         self.extract_user_agent = extract_user_agent
+        self._extracted_attributes: Dict[str, Any] = {}
         
     def initialize(self, gb_instance) -> None:
         """Initialize plugin - extract attributes from request context."""
@@ -87,18 +88,33 @@ class RequestContextPlugin(GrowthBookPlugin):
             request_attributes = self._extract_all_attributes()
             
             if request_attributes:
-                # Merge with existing attributes (existing take precedence)
-                current_attributes = gb_instance.get_attributes()
-                merged_attributes = {**request_attributes, **current_attributes}
-                gb_instance.set_attributes(merged_attributes)
-                
-                self.logger.info(f"Extracted {len(request_attributes)} request attributes")
+                # Check client type and merge attributes accordingly
+                if hasattr(gb_instance, 'get_attributes') and hasattr(gb_instance, 'set_attributes'):
+                    # Legacy GrowthBook client
+                    current_attributes = gb_instance.get_attributes()
+                    merged_attributes = {**request_attributes, **current_attributes}
+                    gb_instance.set_attributes(merged_attributes)
+                    self.logger.info(f"Extracted {len(request_attributes)} request attributes for legacy client")
+                    
+                elif hasattr(gb_instance, 'options'):
+                    # New GrowthBookClient - store attributes for future use
+                    # Note: GrowthBookClient doesn't have get/set_attributes, but we can store
+                    # the extracted attributes for potential future use or logging
+                    self._extracted_attributes = request_attributes
+                    self.logger.info(f"Extracted {len(request_attributes)} request attributes for async client (stored for reference)")
+                    
+                else:
+                    self.logger.warning("Unknown client type - cannot set attributes")
             else:
                 self.logger.debug("No request context available")
                 
         except Exception as e:
             self.logger.error(f"Failed to extract request attributes: {e}")
     
+    def get_extracted_attributes(self) -> Dict[str, Any]:
+        """Get the attributes extracted from request context."""
+        return self._extracted_attributes.copy()
+    
     def _extract_all_attributes(self) -> Dict[str, Any]:
         """Extract all available attributes from request context."""
         attributes = {}

{growthbook-1.3.1.dist-info → growthbook-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: growthbook
-Version: 1.3.1
+Version: 1.4.1
 Summary: Powerful Feature flagging and A/B testing for Python apps
 Home-page: https://github.com/growthbook/growthbook-python
 Author: GrowthBook

growthbook-1.4.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+growthbook/__init__.py,sha256=wx8DI5CN6we3wD2KfxR9CgroKfiiF7LQSQuqdrzQyjw,444
+growthbook/common_types.py,sha256=OUGkqoUuYetWz1cyA1eWz5DM3awYw_ExcNAjFqJuGAc,14881
+growthbook/core.py,sha256=n9nwna26iZTY48LIvQqu5N_RrE35X0wlRBhq0-Qdb-s,35241
+growthbook/growthbook.py,sha256=oxjXeGkYOU164miEcZzTFPCgMJrcCB_XHCB7IOOabFM,31037
+growthbook/growthbook_client.py,sha256=1bDIuJoxlKUR_bKe_gD6V7JlUPt53uGgix9DhgSkPPc,23360
+growthbook/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+growthbook/plugins/__init__.py,sha256=y2eAV1sA041XWcftBVTDH0t-ggy9r2C5oKRYRF6XR6s,602
+growthbook/plugins/base.py,sha256=PWBXUBj62hi25Y5Eif9WmEWagWdkwGXHi2dMtn44bo8,3637
+growthbook/plugins/growthbook_tracking.py,sha256=FvPFOuKF_xKjmTX8x_hzMlHrrL-68Y2ZPw1Hfl2_ilQ,11333
+growthbook/plugins/request_context.py,sha256=O5FJDrjJR5u0rx3ENGO9cOsKMHd9e0l0Nvdb1PHfmm8,12951
+growthbook-1.4.1.dist-info/licenses/LICENSE,sha256=D-TcBckB0dTPUlNJ8jBiTIJIj1ekHLB1CY7HJtJKhMY,1069
+growthbook-1.4.1.dist-info/METADATA,sha256=G1jZbYb7vuJL1FIo2gdBimQVFwuoGI-JLvd4dJGZxLQ,22073
+growthbook-1.4.1.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+growthbook-1.4.1.dist-info/top_level.txt,sha256=dzfRQFGYejCIUstRSrrRVTMlxf7pBqASTI5S8gGRlXw,11
+growthbook-1.4.1.dist-info/RECORD,,

growthbook-1.3.1.dist-info/RECORD

@@ -1,15 +0,0 @@
-growthbook/__init__.py,sha256=2pw6uyYKI4IQ59LZbCUsNroy4LLFZ_5XyPmscPUyAwI,444
-growthbook/common_types.py,sha256=1jDWwS_9L0z_AZb5AJq1arEqi6QU66N3S4vYzkcDFDY,14728
-growthbook/core.py,sha256=LCz5f5rchUL056kgJxgH566NoZWr2nr4hhL7MRlyNiM,35184
-growthbook/growthbook.py,sha256=IJmFKTx87zAwQ6nO_Gepm5-S_Mtwf-lnt2RFBviB6Lk,30672
-growthbook/growthbook_client.py,sha256=zLgoBSBCSfCb8OE0b-XQiDAEB4djTiMSrbNpqBui-M0,21454
-growthbook/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-growthbook/plugins/__init__.py,sha256=y2eAV1sA041XWcftBVTDH0t-ggy9r2C5oKRYRF6XR6s,602
-growthbook/plugins/base.py,sha256=PWBXUBj62hi25Y5Eif9WmEWagWdkwGXHi2dMtn44bo8,3637
-growthbook/plugins/growthbook_tracking.py,sha256=aL_dgsPt51IZNxRVZVA5U3QEiGW-e-l5tC7Owl6CZO0,10032
-growthbook/plugins/request_context.py,sha256=7_9LOfS5nXbxXE7KJ-zNT4Ug4-_698A4c3t0hjr6l4c,11895
-growthbook-1.3.1.dist-info/licenses/LICENSE,sha256=D-TcBckB0dTPUlNJ8jBiTIJIj1ekHLB1CY7HJtJKhMY,1069
-growthbook-1.3.1.dist-info/METADATA,sha256=FwTzARVgHtfSH2ZnCWVq0G9k5ISiPyQDIeYjabR3vCQ,22073
-growthbook-1.3.1.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-growthbook-1.3.1.dist-info/top_level.txt,sha256=dzfRQFGYejCIUstRSrrRVTMlxf7pBqASTI5S8gGRlXw,11
-growthbook-1.3.1.dist-info/RECORD,,