posthoganalytics 6.1.0__py3-none-any.whl → 6.2.1__py3-none-any.whl

posthoganalytics/client.py

@@ -97,29 +97,20 @@ def add_context_tags(properties):
 
 
 class Client(object):
-    """Create a new PostHog client.
+    """
+    This is the SDK reference for the PostHog Python SDK.
+    You can learn more about example usage in the [Python SDK documentation](/docs/libraries/python).
+    You can also follow [Flask](/docs/libraries/flask) and [Django](/docs/libraries/django)
+    guides to integrate PostHog into your project.
 
     Examples:
-        Basic usage:
-        >>> client = Client("your-api-key")
-
-        With memory-based feature flag fallback cache:
-        >>> client = Client(
-        ...     "your-api-key",
-        ...     flag_fallback_cache_url="memory://local/?ttl=300&size=10000"
-        ... )
-
-        With Redis fallback cache for high-scale applications:
-        >>> client = Client(
-        ...     "your-api-key",
-        ...     flag_fallback_cache_url="redis://localhost:6379/0/?ttl=300"
-        ... )
-
-        With Redis authentication:
-        >>> client = Client(
-        ...     "your-api-key",
-        ...     flag_fallback_cache_url="redis://username:password@localhost:6379/0/?ttl=300"
-        ... )
+        ```python
+        from posthoganalytics import Posthog
+        posthog = Posthog('<ph_project_api_key>', host='<ph_client_api_host>')
+        posthog.debug = True
+        if settings.TEST:
+            posthog.disabled = True
+        ```
     """
 
     log = logging.getLogger("posthog")
@@ -154,6 +145,24 @@ class Client(object):
         flag_fallback_cache_url=None,
         enable_local_evaluation=True,
     ):
+        """
+        Initialize a new PostHog client instance.
+
+        Args:
+            project_api_key: The project API key.
+            host: The host to use for the client.
+            debug: Whether to enable debug mode.
+
+        Examples:
+            ```python
+            from posthoganalytics import Posthog
+
+            posthog = Posthog('<ph_project_api_key>', host='<ph_app_host>')
+            ```
+
+        Category:
+            Initialization
+        """
         self.queue = queue.Queue(max_queue_size)
 
         # api_key: This should be the Team API Key (token), public
@@ -252,6 +261,23 @@ class Client(object):
                     consumer.start()
 
     def new_context(self, fresh=False, capture_exceptions=True):
+        """
+        Create a new context for managing shared state. Learn more about [contexts](/docs/libraries/python#contexts).
+
+        Args:
+            fresh: Whether to create a fresh context that doesn't inherit from parent.
+            capture_exceptions: Whether to automatically capture exceptions in this context.
+
+        Examples:
+            ```python
+            with posthog.new_context():
+                identify_context('<distinct_id>')
+                posthog.capture('event_name')
+            ```
+
+        Category:
+            Contexts
+        """
         return new_context(
             fresh=fresh, capture_exceptions=capture_exceptions, client=self
         )
@@ -287,7 +313,17 @@ class Client(object):
         disable_geoip=None,
     ) -> dict[str, Union[bool, str]]:
         """
-        Get feature flag variants for a distinct_id by calling decide.
+        Get feature flag variants for a user by calling decide.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Category:
+            Feature Flags
         """
         resp_data = self.get_flags_decision(
             distinct_id, groups, person_properties, group_properties, disable_geoip
@@ -303,7 +339,22 @@ class Client(object):
         disable_geoip=None,
     ) -> dict[str, str]:
         """
-        Get feature flag payloads for a distinct_id by calling decide.
+        Get feature flag payloads for a user by calling decide.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            payloads = posthog.get_feature_payloads('<distinct_id>')
+            ```
+
+        Category:
+            Feature Flags
         """
         resp_data = self.get_flags_decision(
             distinct_id, groups, person_properties, group_properties, disable_geoip
@@ -319,7 +370,22 @@ class Client(object):
         disable_geoip=None,
     ) -> FlagsAndPayloads:
         """
-        Get feature flags and payloads for a distinct_id by calling decide.
+        Get feature flags and payloads for a user by calling decide.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            result = posthog.get_feature_flags_and_payloads('<distinct_id>')
+            ```
+
+        Category:
+            Feature Flags
         """
         resp = self.get_flags_decision(
             distinct_id, groups, person_properties, group_properties, disable_geoip
@@ -335,7 +401,22 @@ class Client(object):
         disable_geoip=None,
     ) -> FlagsResponse:
         """
-        Get feature flags decision, using either flags() or decide() API based on rollout.
+        Get feature flags decision.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            decision = posthog.get_flags_decision('user123')
+            ```
+
+        Category:
+            Feature Flags
         """
 
         if distinct_id is None:
@@ -367,6 +448,52 @@ class Client(object):
     def capture(
         self, event: str, **kwargs: Unpack[OptionalCaptureArgs]
     ) -> Optional[str]:
+        """
+        Captures an event manually. [Learn about capture best practices](https://posthog.com/docs/product-analytics/capture-events)
+
+        Args:
+            event: The event name to capture.
+            distinct_id: The distinct ID of the user.
+            properties: A dictionary of properties to include with the event.
+            timestamp: The timestamp of the event.
+            uuid: A unique identifier for the event.
+            groups: A dictionary of group information.
+            send_feature_flags: Whether to send feature flags with the event.
+            disable_geoip: Whether to disable GeoIP for this event.
+
+        Examples:
+            ```python
+            # Anonymous event
+            posthog.capture('some-anon-event')
+            ```
+            ```python
+            # Context usage
+            from posthoganalytics import identify_context, new_context
+            with new_context():
+                identify_context('distinct_id_of_the_user')
+                posthog.capture('user_signed_up')
+                posthog.capture('user_logged_in')
+                posthog.capture('some-custom-action', distinct_id='distinct_id_of_the_user')
+            ```
+            ```python
+            # Set event properties
+            posthog.capture(
+                "user_signed_up",
+                distinct_id="distinct_id_of_the_user",
+                properties={
+                    "login_type": "email",
+                    "is_free_trial": "true"
+                }
+            )
+            ```
+            ```python
+            # Page view event
+            posthog.capture('$pageview', distinct_id="distinct_id_of_the_user", properties={'$current_url': 'https://example.com'})
+            ```
+
+        Category:
+            Capture
+        """
         distinct_id = kwargs.get("distinct_id", None)
         properties = kwargs.get("properties", None)
         timestamp = kwargs.get("timestamp", None)
@@ -433,6 +560,39 @@ class Client(object):
         return self._enqueue(msg, disable_geoip)
 
     def set(self, **kwargs: Unpack[OptionalSetArgs]) -> Optional[str]:
+        """
+        Set properties on a person profile.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            properties: A dictionary of properties to set.
+            timestamp: The timestamp of the event.
+            uuid: A unique identifier for the event.
+            disable_geoip: Whether to disable GeoIP for this event.
+
+        Examples:
+            ```python
+            # Set with distinct id
+            posthog.capture(
+                'event_name',
+                distinct_id='user-distinct-id',
+                properties={
+                    '$set': {'name': 'Max Hedgehog'},
+                    '$set_once': {'initial_url': '/blog'}
+                }
+            )
+            ```
+            ```python
+            # Set using context
+            from posthoganalytics import new_context, identify_context
+            with new_context():
+                identify_context('user-distinct-id')
+                posthog.capture('event_name')
+            ```
+
+        Category:
+            Identification
+        """
         distinct_id = kwargs.get("distinct_id", None)
         properties = kwargs.get("properties", None)
         timestamp = kwargs.get("timestamp", None)
@@ -459,6 +619,24 @@ class Client(object):
         return self._enqueue(msg, disable_geoip)
 
     def set_once(self, **kwargs: Unpack[OptionalSetArgs]) -> Optional[str]:
+        """
+        Set properties on a person profile only if they haven't been set before.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            properties: A dictionary of properties to set once.
+            timestamp: The timestamp of the event.
+            uuid: A unique identifier for the event.
+            disable_geoip: Whether to disable GeoIP for this event.
+
+        Examples:
+            ```python
+            posthog.set_once(distinct_id='user123', properties={'initial_signup_date': '2024-01-01'})
+            ```
+
+        Category:
+            Identification
+        """
         distinct_id = kwargs.get("distinct_id", None)
         properties = kwargs.get("properties", None)
         timestamp = kwargs.get("timestamp", None)
@@ -487,18 +665,41 @@ class Client(object):
         self,
         group_type: str,
         group_key: str,
-        properties=None,
-        timestamp=None,
-        uuid=None,
-        disable_geoip=None,
-        distinct_id=None,
-    ):
+        properties: Optional[Dict[str, Any]] = None,
+        timestamp: Optional[Union[datetime, str]] = None,
+        uuid: Optional[str] = None,
+        disable_geoip: Optional[bool] = None,
+        distinct_id: Optional[ID_TYPES] = None,
+    ) -> Optional[str]:
+        """
+        Identify a group and set its properties.
+
+        Args:
+            group_type: The type of group (e.g., 'company', 'team').
+            group_key: The unique identifier for the group.
+            properties: A dictionary of properties to set on the group.
+            timestamp: The timestamp of the event.
+            uuid: A unique identifier for the event.
+            disable_geoip: Whether to disable GeoIP for this event.
+            distinct_id: The distinct ID of the user performing the action.
+
+        Examples:
+            ```python
+            posthog.group_identify('company', 'company_id_in_your_db', {
+                'name': 'Awesome Inc.',
+                'employees': 11
+            })
+            ```
+
+        Category:
+            Identification
+        """
         properties = properties or {}
 
         # group_identify is purposefully always personful
         distinct_id = get_identity_state(distinct_id)[0]
 
-        msg = {
+        msg: Dict[str, Any] = {
             "event": "$groupidentify",
             "properties": {
                 "$group_type": group_type,
@@ -512,7 +713,7 @@ class Client(object):
 
         # NOTE - group_identify doesn't generally use context properties - should it?
         if get_context_session_id():
-            msg["properties"]["$session_id"] = get_context_session_id()
+            msg["properties"]["$session_id"] = str(get_context_session_id())
 
         return self._enqueue(msg, disable_geoip)
 
@@ -524,6 +725,24 @@ class Client(object):
         uuid=None,
         disable_geoip=None,
     ):
+        """
+        Create an alias between two distinct IDs.
+
+        Args:
+            previous_id: The previous distinct ID.
+            distinct_id: The new distinct ID to alias to.
+            timestamp: The timestamp of the event.
+            uuid: A unique identifier for the event.
+            disable_geoip: Whether to disable GeoIP for this event.
+
+        Examples:
+            ```python
+            posthog.alias(previous_id='distinct_id', distinct_id='alias_id')
+            ```
+
+        Category:
+            Identification
+        """
         (distinct_id, personless) = get_identity_state(distinct_id)
 
         if personless:
@@ -541,7 +760,7 @@ class Client(object):
         }
 
         if get_context_session_id():
-            msg["properties"]["$session_id"] = get_context_session_id()
+            msg["properties"]["$session_id"] = str(get_context_session_id())
 
         return self._enqueue(msg, disable_geoip)
 
@@ -550,6 +769,28 @@ class Client(object):
         exception: Optional[ExceptionArg],
         **kwargs: Unpack[OptionalCaptureArgs],
     ):
+        """
+        Capture an exception for error tracking.
+
+        Args:
+            exception: The exception to capture.
+            distinct_id: The distinct ID of the user.
+            properties: A dictionary of additional properties.
+            send_feature_flags: Whether to send feature flags with the exception.
+            disable_geoip: Whether to disable GeoIP for this event.
+
+        Examples:
+            ```python
+            try:
+                # Some code that might fail
+                pass
+            except Exception as e:
+                posthog.capture_exception(e, 'user_distinct_id', properties=additional_properties)
+            ```
+
+        Category:
+            Error Tracking
+        """
         distinct_id = kwargs.get("distinct_id", None)
         properties = kwargs.get("properties", None)
         send_feature_flags = kwargs.get("send_feature_flags", False)
@@ -705,7 +946,15 @@ class Client(object):
             return None
 
     def flush(self):
-        """Forces a flush from the internal queue to the server"""
+        """
+        Force a flush from the internal queue to the server. Do not use directly, call `shutdown()` instead.
+
+        Examples:
+            ```python
+            posthog.capture('event_name')
+            posthog.flush()  # Ensures the event is sent immediately
+            ```
+        """
         queue = self.queue
         size = queue.qsize()
         queue.join()
@@ -713,8 +962,13 @@ class Client(object):
         self.log.debug("successfully flushed about %s items.", size)
 
     def join(self):
-        """Ends the consumer thread once the queue is empty.
-        Blocks execution until finished
+        """
+        End the consumer thread once the queue is empty. Do not use directly, call `shutdown()` instead.
+
+        Examples:
+            ```python
+            posthog.join()
+            ```
         """
         for consumer in self.consumers:
             consumer.pause()
@@ -728,7 +982,14 @@ class Client(object):
             self.poller.stop()
 
     def shutdown(self):
-        """Flush all messages and cleanly shutdown the client"""
+        """
+        Flush all messages and cleanly shutdown the client. Call this before the process ends in serverless environments to avoid data loss.
+
+        Examples:
+            ```python
+            posthog.shutdown()
+            ```
+        """
         self.flush()
         self.join()
 
@@ -801,6 +1062,17 @@ class Client(object):
         self._last_feature_flag_poll = datetime.now(tz=tzutc())
 
     def load_feature_flags(self):
+        """
+        Load feature flags for local evaluation.
+
+        Examples:
+            ```python
+            posthog.load_feature_flags()
+            ```
+
+        Category:
+            Feature Flags
+        """
         if not self.personal_api_key:
             self.log.warning(
                 "[FEATURE FLAGS] You have to specify a personal_api_key to use feature flags."
@@ -882,6 +1154,31 @@ class Client(object):
         send_feature_flag_events=True,
         disable_geoip=None,
     ):
+        """
+        Check if a feature flag is enabled for a user.
+
+        Args:
+            key: The feature flag key.
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            only_evaluate_locally: Whether to only evaluate locally.
+            send_feature_flag_events: Whether to send feature flag events.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            is_my_flag_enabled = posthog.feature_enabled('flag-key', 'distinct_id_of_your_user')
+            if is_my_flag_enabled:
+                # Do something differently for this user
+                # Optional: fetch the payload
+                matched_flag_payload = posthog.get_feature_flag_payload('flag-key', 'distinct_id_of_your_user')
+            ```
+
+        Category:
+            Feature Flags
+        """
         response = self.get_feature_flag(
             key,
             distinct_id,
@@ -1011,8 +1308,29 @@ class Client(object):
         """
         Get a FeatureFlagResult object which contains the flag result and payload for a key by evaluating locally or remotely
         depending on whether local evaluation is enabled and the flag can be locally evaluated.
+        This also captures the `$feature_flag_called` event unless `send_feature_flag_events` is `False`.
+
+        Examples:
+            ```python
+            flag_result = posthog.get_feature_flag_result('flag-key', 'distinct_id_of_your_user')
+            if flag_result and flag_result.get_value() == 'variant-key':
+                # Do something differently for this user
+                # Optional: fetch the payload
+                matched_flag_payload = flag_result.payload
+            ```
 
-        This also captures the $feature_flag_called event unless send_feature_flag_events is False.
+        Args:
+            key: The feature flag key.
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            only_evaluate_locally: Whether to only evaluate locally.
+            send_feature_flag_events: Whether to send feature flag events.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Returns:
+            Optional[FeatureFlagResult]: The feature flag result or None if disabled/not found.
         """
         return self._get_feature_flag_result(
             key,
@@ -1038,11 +1356,29 @@ class Client(object):
         disable_geoip=None,
     ) -> Optional[FlagValue]:
         """
-        Get a feature flag value for a key by evaluating locally or remotely
-        depending on whether local evaluation is enabled and the flag can be
-        locally evaluated.
+        Get multivariate feature flag value for a user.
 
-        This also captures the $feature_flag_called event unless send_feature_flag_events is False.
+        Args:
+            key: The feature flag key.
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            only_evaluate_locally: Whether to only evaluate locally.
+            send_feature_flag_events: Whether to send feature flag events.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            enabled_variant = posthog.get_feature_flag('flag-key', 'distinct_id_of_your_user')
+            if enabled_variant == 'variant-key': # replace 'variant-key' with the key of your variant
+                # Do something differently for this user
+                # Optional: fetch the payload
+                matched_flag_payload = posthog.get_feature_flag_payload('flag-key', 'distinct_id_of_your_user')
+            ```
+
+        Category:
+            Feature Flags
         """
         feature_flag_result = self.get_feature_flag_result(
             key,
@@ -1107,6 +1443,33 @@ class Client(object):
         send_feature_flag_events=True,
         disable_geoip=None,
     ):
+        """
+        Get the payload for a feature flag.
+
+        Args:
+            key: The feature flag key.
+            distinct_id: The distinct ID of the user.
+            match_value: The specific flag value to get payload for.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            only_evaluate_locally: Whether to only evaluate locally.
+            send_feature_flag_events: Whether to send feature flag events.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            is_my_flag_enabled = posthog.feature_enabled('flag-key', 'distinct_id_of_your_user')
+
+            if is_my_flag_enabled:
+                # Do something differently for this user
+                # Optional: fetch the payload
+                matched_flag_payload = posthog.get_feature_flag_payload('flag-key', 'distinct_id_of_your_user')
+            ```
+
+        Category:
+            Feature Flags
+        """
         feature_flag_result = self._get_feature_flag_result(
             key,
             distinct_id,
@@ -1249,6 +1612,25 @@ class Client(object):
         only_evaluate_locally=False,
         disable_geoip=None,
     ) -> Optional[dict[str, Union[bool, str]]]:
+        """
+        Get all feature flags for a user.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            only_evaluate_locally: Whether to only evaluate locally.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            posthog.get_all_flags('distinct_id_of_your_user')
+            ```
+
+        Category:
+            Feature Flags
+        """
         response = self.get_all_flags_and_payloads(
             distinct_id,
             groups=groups,
@@ -1270,6 +1652,25 @@ class Client(object):
         only_evaluate_locally=False,
         disable_geoip=None,
     ) -> FlagsAndPayloads:
+        """
+        Get all feature flags and their payloads for a user.
+
+        Args:
+            distinct_id: The distinct ID of the user.
+            groups: A dictionary of group information.
+            person_properties: A dictionary of person properties.
+            group_properties: A dictionary of group properties.
+            only_evaluate_locally: Whether to only evaluate locally.
+            disable_geoip: Whether to disable GeoIP for this request.
+
+        Examples:
+            ```python
+            posthog.get_all_flags_and_payloads('distinct_id_of_your_user')
+            ```
+
+        Category:
+            Feature Flags
+        """
         if self.disabled:
             return {"featureFlags": None, "featureFlagPayloads": None}