vybekiit 0.4.0 → 0.6.0

package/dist/global-skills/instrument-product-analytics/references/posthog-python.md

@@ -0,0 +1,1675 @@
+# PostHog Python SDK
+
+**SDK Version:** 7.22.1
+
+Integrate PostHog into any python application.
+
+## Categories
+
+- Initialization
+- Identification
+- Capture
+- Error Tracking
+- Feature flags
+- Contexts
+- Events
+- Client management
+
+## PostHog
+
+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.  For long-running applications, create one client during application startup and reuse it for the lifetime of the process. This keeps background queues predictable and makes shutdown flushing straightforward. Multiple clients are still supported for intentional multi-project or multi-host setups.
+
+### Initialization methods
+
+#### Client()
+
+**Release Tag:** public
+
+Initialize a new PostHog client instance.
+
+### Parameters
+
+- **`project_api_key?`** (`str`) - PostHog project API key/token.
+- **`host`** (`any`) - PostHog host. Defaults to the US ingestion endpoint when not         set. App hosts such as ``https://us.posthog.com`` are mapped to         the corresponding ingestion host.
+- **`debug`** (`bool`) - Enable verbose SDK logging and re-raise errors from public         API methods.
+- **`max_queue_size`** (`int`) - Maximum number of events buffered before upload.
+- **`send`** (`bool`) - If False, queueing succeeds but events are not sent.
+- **`on_error`** (`any`) - Optional callback invoked by background consumers when an         upload fails.
+- **`flush_at`** (`int`) - Number of queued events that triggers a batch upload.
+- **`flush_interval`** (`float`) - Maximum seconds a background consumer waits before         flushing a partial batch.
+- **`gzip`** (`bool`) - Whether to gzip event upload payloads.
+- **`max_retries`** (`int`) - Number of upload retries for background consumers.
+- **`sync_mode`** (`bool`) - If True, send each event synchronously instead of using         background worker threads.
+- **`timeout`** (`int`) - HTTP request timeout in seconds for event uploads.
+- **`thread`** (`int`) - Number of background consumer threads.
+- **`poll_interval`** (`int`) - Seconds between local feature flag definition refreshes.
+- **`personal_api_key`** (`any`) - Deprecated alias for ``secret_key``. Still honored         for backwards compatibility; prefer ``secret_key``, which also         accepts a Project Secret API Key.
+- **`disabled`** (`bool`) - If True, disable captures and API requests. Useful in tests.
+- **`disable_geoip`** (`bool`) - Whether to disable server-side GeoIP enrichment.         Defaults to True.
+- **`is_server`** (`bool`) - Whether events are emitted from a server-side runtime.         Defaults to True; set to False when using the SDK as a client/CLI         so the device OS is attributed to the person normally.
+- **`historical_migration`** (`bool`) - Mark events as historical migration imports.
+- **`feature_flags_request_timeout_seconds`** (`int`) - Timeout in seconds for feature         flag and remote config requests.
+- **`feature_flags_request_max_retries`** (`int`) - Number of retries for feature flag         requests after network, transport, or timeout failures. Defaults         to 1. Set to 0 to disable retries.
+- **`super_properties`** (`any`) - Properties merged into every captured event.
+- **`enable_exception_autocapture`** (`bool`) - Automatically capture uncaught         exceptions.
+- **`log_captured_exceptions`** (`bool`) - Also log exceptions captured by error         tracking.
+- **`project_root`** (`any`) - Root path used to determine in-app stack frames for         captured exceptions. Defaults to the current working directory.
+- **`privacy_mode`** (`bool`) - For AI observability, capture usage metadata without         prompt inputs or outputs.
+- **`before_send`** (`any`) - Optional callback that can modify or drop events before         upload. Return ``None`` to drop an event.
+- **`flag_fallback_cache_url`** (`any`) - Optional feature flag fallback cache URL,         such as ``memory://local/?ttl=300&size=10000`` or a Redis URL.
+- **`enable_local_evaluation`** (`bool`) - Whether to poll feature flag definitions for         local evaluation when a personal API key is configured.
+- **`flag_definition_cache_provider?`** (`FlagDefinitionCacheProvider`) - Optional external cache provider for         sharing feature flag definitions across workers.
+- **`capture_exception_code_variables`** (`bool`) - Capture local variable values on         exception stack frames.
+- **`code_variables_mask_patterns`** (`any`) - Variable-name patterns to mask when         capturing code variables.
+- **`code_variables_ignore_patterns`** (`any`) - Variable-name patterns to omit when         capturing code variables.
+- **`code_variables_mask_url_credentials`** (`any`) - Scrub credentials embedded in         URLs/DSNs (e.g. ``user:pass@host``) from captured code variables,         regardless of the surrounding variable name. Defaults to True.
+- **`code_variables_detect_secrets`** (`any`) - Last-resort entropy-based detection that         redacts high-entropy secret-looking values (API keys, tokens, strong         passwords) sitting in innocuously-named variables, after the name and         URL checks. Skips structured ids (UUIDs, ObjectIds, hashes). Defaults         to True.
+- **`in_app_modules`** (`UnionType[list[str], any]`) - Module/package prefixes treated as in-app frames in         captured exceptions.
+- **`enable_exception_autocapture_rate_limiting`** (`bool`) - Rate limit         autocaptured exceptions client-side with a token bucket per         exception type. Disabled by default.
+- **`exception_autocapture_bucket_size`** (`int`) - Maximum burst of autocaptured         exceptions allowed per exception type (token bucket size,         clamped to 0-100).
+- **`exception_autocapture_refill_rate`** (`int`) - Tokens restored per refill         interval for each exception type's bucket.
+- **`exception_autocapture_refill_interval_seconds`** (`int`) - Seconds between         token refills for autocaptured exception rate limiting.
+- **`capture_mode`** (`CaptureMode`) - Capture wire protocol to use. Defaults to         ``CaptureMode.V0`` (legacy ``/batch/``). Set ``CaptureMode.V1``         (or pass the string ``"v1"``) to opt into         ``/i/v1/analytics/events``. When omitted, the         ``POSTHOG_CAPTURE_MODE`` env var is consulted, then ``V0``.
+- **`capture_compression`** (`CaptureCompression`) - Request-body compression for capture-v1 uploads         (ignored in V0, which uses ``gzip``). ``CaptureCompression.GZIP``         or ``DEFLATE`` (or the strings ``"gzip"``/``"deflate"``). When         omitted, the ``POSTHOG_CAPTURE_COMPRESSION`` env var is consulted,         then the legacy ``gzip`` flag, then no compression.
+- **`secret_key`** (`any`) - A Personal API Key or Project Secret API Key, used to         authenticate local feature flag evaluation, remote config         payloads, and decrypted flag payloads. Example::              posthog.Client(project_api_key, secret_key="phx_...")
+- **`_dedicated_ai_endpoint`** (`bool`)
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import Posthog
+
+posthog = Posthog('<ph_project_api_key>', host='<ph_app_host>')
+```
+
+---
+
+### Identification methods
+
+#### alias()
+
+**Release Tag:** public
+
+Create an alias between two distinct IDs.
+
+### Parameters
+
+- **`previous_id?`** (`str`) - The previous distinct ID.
+- **`distinct_id?`** (`str`) - The new distinct ID to alias to.
+- **`timestamp`** (`datetime`) - The timestamp of the event.
+- **`uuid?`** (`str`) - A unique identifier for the event. If provided, it must be a         valid UUID string or uuid.UUID instance; invalid values are         ignored and replaced with a newly generated UUID.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this event.
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+posthog.alias(previous_id='distinct_id', distinct_id='alias_id')
+```
+
+---
+
+#### group_identify()
+
+**Release Tag:** public
+
+Identify a group and set its properties.
+
+### Parameters
+
+- **`group_type?`** (`str`) - The type of group (e.g., 'company', 'team').
+- **`group_key?`** (`str`) - The unique identifier for the group.
+- **`properties?`** (`dict[str, Any]`) - A dictionary of properties to set on the group.
+- **`timestamp`** (`datetime`) - The timestamp of the event.
+- **`uuid`** (`str`) - A unique identifier for the event. If provided, it must be a         valid UUID string or uuid.UUID instance; invalid values are         ignored and replaced with a newly generated UUID.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this event.
+- **`distinct_id`** (`Number`) - The distinct ID of the user performing the action.
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+posthog.group_identify('company', 'company_id_in_your_db', {
+    'name': 'Awesome Inc.',
+    'employees': 11
+})
+```
+
+---
+
+#### set()
+
+**Release Tag:** public
+
+Set properties on a person profile.
+
+### Parameters
+
+- **`kwargs?`** (`Unpack[OptionalSetArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+# Set with distinct id
+posthog.set(distinct_id='user123', properties={'name': 'Max Hedgehog'})
+```
+
+---
+
+#### set_once()
+
+**Release Tag:** public
+
+Set properties on a person profile only if they haven't been set before.
+
+### Parameters
+
+- **`kwargs?`** (`Unpack[OptionalSetArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+posthog.set_once(distinct_id='user123', properties={'initial_signup_date': '2024-01-01'})
+```
+
+---
+
+### Capture methods
+
+#### capture()
+
+**Release Tag:** public
+
+Captures an event manually. [Learn about capture best practices](https://posthog.com/docs/product-analytics/capture-events)
+
+### Parameters
+
+- **`event?`** (`str`) - The event name to capture.
+- **`kwargs?`** (`Unpack[OptionalCaptureArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+#### Anonymous event
+
+```python
+# Anonymous event
+posthog.capture('some-anon-event')
+```
+
+#### Context usage
+
+```python
+# Context usage
+from posthog 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')
+```
+
+#### Set event properties
+
+```python
+# Set event properties
+posthog.capture(
+    "user_signed_up",
+    distinct_id="distinct_id_of_the_user",
+    properties={
+        "login_type": "email",
+        "is_free_trial": "true"
+    }
+)
+```
+
+#### Page view event
+
+```python
+# Page view event
+posthog.capture('$pageview', distinct_id="distinct_id_of_the_user", properties={'$current_url': 'https://example.com'})
+```
+
+---
+
+### Error Tracking methods
+
+#### capture_exception()
+
+**Release Tag:** public
+
+Capture an exception for error tracking.
+
+### Parameters
+
+- **`exception?`** (`BaseException`) - The exception to capture.
+- **`kwargs?`** (`Unpack[OptionalCaptureArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+try:
+    # Some code that might fail
+    pass
+except Exception as e:
+    posthog.capture_exception(e, 'user_distinct_id', properties=additional_properties)
+```
+
+---
+
+### Feature flags methods
+
+#### evaluate_flags()
+
+**Release Tag:** public
+
+Evaluate all feature flags for a user in a single call and return a :class:`FeatureFlagEvaluations` snapshot. Branch on ``.is_enabled()`` / ``.get_flag()`` and pass the same snapshot to :meth:`capture` via the ``flags`` option so events carry the exact flag values the code branched on.  Prefer this over repeated ``get_feature_flag()`` calls and over ``capture(send_feature_flags=True)`` — it consolidates flag evaluation into a single ``/flags`` request per incoming request.  Local evaluation is transparent: when the poller resolves a flag, the snapshot's ``$feature_flag_called`` events are tagged ``locally_evaluated=True`` and reason ``"Evaluated locally"``.
+
+### Parameters
+
+- **`distinct_id`** (`Number`) - The user's distinct ID. If ``None``, falls back to the         context distinct_id. If still unresolvable, returns an empty snapshot.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Mapping of group type to group key.
+- **`person_properties?`** (`dict[str, Any]`) - Person properties to use for evaluation.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties keyed by group type.
+- **`only_evaluate_locally`** (`bool`) - If True, never fall back to remote evaluation —         flags that can't be evaluated locally are simply omitted from the snapshot.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup.
+- **`flag_keys?`** (`list[str]`) - Optional list of flag keys to scope the underlying ``/flags``         request to a subset.
+- **`device_id?`** (`str`) - Optional device ID override. If not provided, falls back to the         context device_id (which may be set via tracing headers). Used by         experience-continuity flags to match users across distinct_id changes.
+
+### Returns
+
+- `FeatureFlagEvaluations`
+
+### Examples
+
+```python
+flags = posthog.evaluate_flags(
+    "user_123",
+    person_properties={"plan": "enterprise"},
+)
+if flags.is_enabled("new-dashboard"):
+    render_new_dashboard()
+posthog.capture("page_viewed", distinct_id="user_123", flags=flags)
+```
+
+---
+
+#### feature_enabled()
+
+**Release Tag:** public
+
+Check if a feature flag is enabled for a user.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key.
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`only_evaluate_locally`** (`bool`) - Whether to only evaluate locally.
+- **`send_feature_flag_events`** (`bool`) - Whether to send feature flag events.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `Optional[bool]`
+
+### 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')
+```
+
+---
+
+#### feature_flag_definitions()
+
+**Release Tag:** public
+
+Return feature flag definitions loaded for local evaluation.  Returns:     The currently loaded feature flag definitions, or ``None`` before     local evaluation has loaded definitions.
+
+### Returns
+
+- `None`
+
+---
+
+#### get_all_flags()
+
+**Release Tag:** public
+
+Get all feature flags for a user.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`only_evaluate_locally`** (`bool`) - Whether to only evaluate locally.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - A list of specific flag keys to evaluate. If provided,         only these flags will be evaluated, improving performance.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `Optional[dict[str, Union[bool, str]]]`
+
+### Examples
+
+```python
+posthog.get_all_flags('distinct_id_of_your_user')
+```
+
+---
+
+#### get_all_flags_and_payloads()
+
+**Release Tag:** public
+
+Get all feature flags and their payloads for a user.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`only_evaluate_locally`** (`bool`) - Whether to only evaluate locally.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - A list of specific flag keys to evaluate. If provided,         only these flags will be evaluated, improving performance.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `FlagsAndPayloads`
+
+### Examples
+
+```python
+posthog.get_all_flags_and_payloads('distinct_id_of_your_user')
+```
+
+---
+
+#### get_feature_flag()
+
+**Release Tag:** public
+
+Get multivariate feature flag value for a user.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key.
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`only_evaluate_locally`** (`bool`) - Whether to only evaluate locally.
+- **`send_feature_flag_events`** (`bool`) - Whether to send feature flag events.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `Union[bool, str, any]`
+
+### 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')
+```
+
+---
+
+#### get_feature_flag_payload()
+
+**Release Tag:** public
+
+Get the payload for a feature flag.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key.
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`match_value`** (`bool`) - The specific flag value to get payload for.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`only_evaluate_locally`** (`bool`) - Whether to only evaluate locally.
+- **`send_feature_flag_events`** (`bool`) - Deprecated. Use get_feature_flag() instead if you need events.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `Optional[object]`
+
+### 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')
+```
+
+---
+
+#### get_feature_flags_and_payloads()
+
+**Release Tag:** public
+
+Get feature flags and payloads for a user.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - A list of specific flag keys to evaluate. If provided,         only these flags will be evaluated, improving performance.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `FlagsAndPayloads`
+
+### Examples
+
+```python
+result = posthog.get_feature_flags_and_payloads('<distinct_id>')
+```
+
+---
+
+#### get_feature_payloads()
+
+**Release Tag:** public
+
+Get feature flag payloads for a user.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - A list of specific flag keys to evaluate. If provided,         only these flags will be evaluated, improving performance.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `dict[str, str]`
+
+### Examples
+
+```python
+payloads = posthog.get_feature_payloads('<distinct_id>')
+```
+
+---
+
+#### get_feature_variants()
+
+**Release Tag:** public
+
+Get feature flag variants for a user.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - A list of specific flag keys to evaluate. If provided,         only these flags will be evaluated, improving performance.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `dict[str, Union[bool, str]]`
+
+---
+
+#### get_flags_decision()
+
+**Release Tag:** public
+
+Get feature flags decision.
+
+### Parameters
+
+- **`distinct_id`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - A list of specific flag keys to evaluate. If provided,         only these flags will be evaluated, improving performance.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `FlagsResponse`
+
+### Examples
+
+```python
+decision = posthog.get_flags_decision('user123')
+```
+
+---
+
+#### get_remote_config_payload()
+
+**Release Tag:** public
+
+Get the payload for a remote config feature flag.
+
+### Parameters
+
+- **`key?`** (`str`) - The remote config feature flag key.
+
+### Returns
+
+- `None`
+
+---
+
+#### load_feature_flags()
+
+**Release Tag:** public
+
+Load feature flags for local evaluation.
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+posthog.load_feature_flags()
+```
+
+---
+
+### Other methods
+
+#### flush()
+
+**Release Tag:** public
+
+Force a flush from the internal queue to the server. Do not use directly, call `shutdown()` instead.
+
+### Parameters
+
+- **`timeout_seconds?`** (`float`) - Maximum seconds to wait for the queue to flush.         Defaults to 10 seconds. Pass ``None`` to wait indefinitely.
+
+### Returns
+
+- `any`
+
+### Examples
+
+```python
+posthog.capture('event_name')
+posthog.flush()  # Ensures the event is sent immediately
+```
+
+---
+
+#### get_feature_flag_result()
+
+**Release Tag:** public
+
+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`.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key.
+- **`distinct_id?`** (`Number`) - The distinct ID of the user.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - A dictionary of group information.
+- **`person_properties?`** (`dict[str, Any]`) - A dictionary of person properties.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - A dictionary of group properties.
+- **`only_evaluate_locally`** (`bool`) - Whether to only evaluate locally.
+- **`send_feature_flag_events`** (`bool`) - Whether to send feature flag events.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP for this request.
+- **`device_id?`** (`str`) - The device ID for this request.
+
+### Returns
+
+- `Optional[FeatureFlagResult]`
+
+### 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
+```
+
+---
+
+#### join()
+
+**Release Tag:** public
+
+End the consumer thread once the queue is empty. Do not use directly, call `shutdown()` instead.
+
+### Returns
+
+- `any`
+
+### Examples
+
+```python
+posthog.join()
+```
+
+---
+
+#### shutdown()
+
+**Release Tag:** public
+
+Flush all messages and cleanly shutdown the client. Call this before the process ends in serverless environments to avoid data loss.
+
+### Returns
+
+- `any`
+
+### Examples
+
+```python
+posthog.shutdown()
+```
+
+---
+
+### Contexts methods
+
+#### get_tags()
+
+**Release Tag:** public
+
+Get all tags from the current context.  Returns:     Dict of all tags in the current context.
+
+### Returns
+
+- `dict[str, Any]`
+
+---
+
+#### identify_context()
+
+**Release Tag:** public
+
+Identify the current context with a distinct ID.
+
+### Parameters
+
+- **`distinct_id?`** (`str`) - The distinct ID to associate with the current context and its children.
+
+### Returns
+
+- `any`
+
+---
+
+#### new_context()
+
+**Release Tag:** public
+
+Create a new context for managing shared state. Learn more about [contexts](/docs/libraries/python#contexts).
+
+### Parameters
+
+- **`fresh`** (`bool`) - Whether to create a fresh context that doesn't inherit from parent.
+- **`capture_exceptions?`** (`bool`) - Whether to automatically capture exceptions in this context. If omitted, defaults to this client's exception autocapture setting.
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+with client.new_context():
+    client.identify_context('<distinct_id>')
+    client.capture('event_name')
+```
+
+---
+
+#### scoped()
+
+**Release Tag:** public
+
+Decorator that creates a new context for the wrapped function using this client.
+
+### Parameters
+
+- **`fresh`** (`bool`) - Whether to create a fresh context that doesn't inherit from parent.
+- **`capture_exceptions?`** (`bool`) - Whether to automatically capture exceptions in this context. If omitted, defaults to this client's exception autocapture setting.
+
+### Returns
+
+- `None`
+
+---
+
+#### set_context_device_id()
+
+**Release Tag:** public
+
+Set the device ID for the current context.
+
+### Parameters
+
+- **`device_id?`** (`str`) - The device ID to associate with the current context and its children.
+
+### Returns
+
+- `any`
+
+---
+
+#### set_context_session()
+
+**Release Tag:** public
+
+Set the session ID for the current context.
+
+### Parameters
+
+- **`session_id?`** (`str`) - The session ID to associate with the current context and its children.
+
+### Returns
+
+- `any`
+
+---
+
+#### tag()
+
+**Release Tag:** public
+
+Add a tag to the current context.
+
+### Parameters
+
+- **`name?`** (`str`) - The tag key.
+- **`value?`** (`Any`) - The tag value.
+
+### Returns
+
+- `any`
+
+---
+
+## PostHog Module Functions
+
+Global functions available in the PostHog module
+
+### Identification methods
+
+#### alias()
+
+**Release Tag:** public
+
+Associate user behaviour before and after they e.g. register, login, or perform some other identifying action.
+
+**Notes:**
+
+To marry up whatever a user does before they sign up or log in with what they do after you need to make an alias call. This will allow you to answer questions like "Which marketing channels leads to users churning after a month?" or "What do users do on our website before signing up?". Particularly useful for associating user behaviour before and after they e.g. register, login, or perform some other identifying action.
+
+### Parameters
+
+- **`previous_id?`** (`str`) - The unique ID of the user before
+- **`distinct_id?`** (`str`) - The current unique id
+- **`timestamp?`** (`datetime`) - Optional timestamp for the event
+- **`uuid?`** (`str`) - Optional UUID for the event
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+# Alias user
+from posthog import alias
+alias(previous_id='distinct_id', distinct_id='alias_id')
+```
+
+---
+
+#### group_identify()
+
+**Release Tag:** public
+
+Set properties on a group.
+
+### Parameters
+
+- **`group_type?`** (`str`) - Type of your group
+- **`group_key?`** (`str`) - Unique identifier of the group
+- **`properties?`** (`dict[str, Any]`) - Properties to set on the group
+- **`timestamp?`** (`datetime`) - Optional timestamp for the event
+- **`uuid?`** (`str`) - Optional UUID for the event
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup
+- **`distinct_id`** (`Number`) - Optional distinct ID of the user performing the action
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+# Group identify
+from posthog import group_identify
+group_identify('company', 'company_id_in_your_db', {
+    'name': 'Awesome Inc.',
+    'employees': 11
+})
+```
+
+---
+
+#### identify_context()
+
+**Release Tag:** public
+
+Identify the current context with a distinct ID.
+
+### Parameters
+
+- **`distinct_id?`** (`str`) - The distinct ID to associate with the current context and its children
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import identify_context
+identify_context("user_123")
+```
+
+---
+
+#### set()
+
+**Release Tag:** public
+
+Set properties on a user record.
+
+**Notes:**
+
+This will overwrite previous people property values. Generally operates similar to `capture`, with distinct_id being an optional argument, defaulting to the current context's distinct ID. If there is no context-level distinct ID, and no override distinct_id is passed, this function will do nothing. Context tags are folded into $set properties, so tagging the current context and then calling `set` will cause those tags to be set on the user (unlike capture, which causes them to just be set on the event).
+
+### Parameters
+
+- **`kwargs?`** (`Unpack[OptionalSetArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+# Set person properties
+from posthog import set
+set(distinct_id='distinct_id', properties={'name': 'Max Hedgehog'})
+```
+
+---
+
+#### set_once()
+
+**Release Tag:** public
+
+Set properties on a user record, only if they do not yet exist.
+
+**Notes:**
+
+This will not overwrite previous people property values, unlike `set`. Otherwise, operates in an identical manner to `set`.
+
+### Parameters
+
+- **`kwargs?`** (`Unpack[OptionalSetArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+# Set property once
+from posthog import set_once
+set_once(distinct_id='distinct_id', properties={'initial_url': '/blog'})
+```
+
+---
+
+### Events methods
+
+#### capture()
+
+**Release Tag:** public
+
+Capture anything a user does within your system.
+
+**Notes:**
+
+Capture allows you to capture anything a user does within your system, which you can later use in PostHog to find patterns in usage, work out which features to improve or where people are giving up. A capture call requires an event name to specify the event. We recommend using [verb] [noun], like `movie played` or `movie updated` to easily identify what your events mean later on. Capture takes a number of optional arguments, which are defined by the `OptionalCaptureArgs` type.
+
+### Parameters
+
+- **`event?`** (`str`) - The event name to specify the event     **kwargs: Optional arguments including:
+- **`kwargs?`** (`Unpack[OptionalCaptureArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+#### Context and capture usage
+
+```python
+# Context and capture usage
+from posthog import new_context, identify_context, tag_context, capture
+# Enter a new context (e.g. a request/response cycle, an instance of a background job, etc)
+with new_context():
+    # Associate this context with some user, by distinct_id
+    identify_context('some user')
+
+    # Capture an event, associated with the context-level distinct ID ('some user')
+    capture('movie started')
+
+    # Capture an event associated with some other user (overriding the context-level distinct ID)
+    capture('movie joined', distinct_id='some-other-user')
+
+    # Capture an event with some properties
+    capture('movie played', properties={'movie_id': '123', 'category': 'romcom'})
+
+    # Capture an event with some properties
+    capture('purchase', properties={'product_id': '123', 'category': 'romcom'})
+    # Capture an event with some associated group
+    capture('purchase', groups={'company': 'id:5'})
+
+    # Adding a tag to the current context will cause it to appear on all subsequent events
+    tag_context('some-tag', 'some-value')
+
+    capture('another-event') # Will be captured with `'some-tag': 'some-value'` in the properties dict
+```
+
+#### Set event properties
+
+```python
+# Set event properties
+from posthog import capture
+capture(
+    "user_signed_up",
+    distinct_id="distinct_id_of_the_user",
+    properties={
+        "login_type": "email",
+        "is_free_trial": "true"
+    }
+)
+```
+
+---
+
+#### capture_exception()
+
+**Release Tag:** public
+
+Capture exceptions that happen in your code.
+
+**Notes:**
+
+Capture exception is idempotent - if it is called twice with the same exception instance, only a occurrence will be tracked in posthog. This is because, generally, contexts will cause exceptions to be captured automatically. However, to ensure you track an exception, if you catch and do not re-raise it, capturing it manually is recommended, unless you are certain it will have crossed a context boundary (e.g. by existing a `with posthog.new_context():` block already). If the passed exception was raised and caught, the captured stack trace will consist of every frame between where the exception was raised and the point at which it is captured (the "traceback"). If the passed exception was never raised, e.g. if you call `posthog.capture_exception(ValueError("Some Error"))`, the stack trace captured will be the full stack trace at the moment the exception was captured. Note that heavy use of contexts will lead to truncated stack traces, as the exception will be captured by the context entered most recently, which may not be the point you catch the exception for the final time in your code. It's recommended to use contexts sparingly, for this reason. `capture_exception` takes the same set of optional arguments as `capture`.
+
+### Parameters
+
+- **`exception`** (`BaseException`) - The exception to capture. If not provided, the current exception is captured via `sys.exc_info()`     **kwargs: Optional capture arguments including distinct_id, properties,         timestamp, uuid, groups, flags, send_feature_flags, and disable_geoip.
+- **`kwargs?`** (`Unpack[OptionalCaptureArgs]`)
+
+### Returns
+
+- `Optional[str]`
+
+### Examples
+
+```python
+# Capture exception
+from posthog import capture_exception
+try:
+    risky_operation()
+except Exception as e:
+    capture_exception(e)
+```
+
+---
+
+### Feature flags methods
+
+#### evaluate_flags()
+
+**Release Tag:** public
+
+Evaluate all feature flags for a user in a single call and return a :class:`FeatureFlagEvaluations` snapshot. Branch on ``.is_enabled()`` / ``.get_flag()`` and pass the same snapshot to ``capture()`` via the ``flags`` option so events carry the exact flag values the code branched on.  Prefer this over repeated ``get_feature_flag()`` calls and over ``capture(send_feature_flags=True)`` — it consolidates flag evaluation into a single ``/flags`` request per incoming request.
+
+### Parameters
+
+- **`distinct_id`** (`Number`) - The user's distinct ID. If ``None``, falls back to the context         distinct_id. If still unresolvable, returns an empty snapshot.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Mapping of group type to group key.
+- **`person_properties?`** (`dict[str, Any]`) - Person properties to use for evaluation.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties keyed by group type.
+- **`only_evaluate_locally`** (`bool`) - If ``True``, never fall back to remote evaluation.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup.
+- **`flag_keys?`** (`list[str]`) - Optional list of flag keys. When provided, only these flags are         evaluated — the underlying ``/flags`` request asks the server for just         this subset, which makes the response smaller and the request cheaper.         Use this when you only need a handful of flags out of many.
+- **`device_id?`** (`str`) - Optional device ID override. If not provided, falls back to the         context device_id (which may be set via tracing headers). Used by         experience-continuity flags to match users across distinct_id changes.
+
+### Returns
+
+- `FeatureFlagEvaluations`
+
+### Examples
+
+```python
+from posthog import evaluate_flags, capture
+flags = evaluate_flags("user_123", person_properties={"plan": "enterprise"})
+if flags.is_enabled("new-dashboard"):
+    render_new_dashboard()
+capture("page_viewed", distinct_id="user_123", flags=flags)
+```
+
+---
+
+#### feature_enabled()
+
+**Release Tag:** public
+
+Use feature flags to enable or disable features for users.
+
+**Notes:**
+
+You can call `posthog.load_feature_flags()` before to make sure you're not doing unexpected requests.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key
+- **`distinct_id?`** (`Number`) - The user's distinct ID
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Groups mapping
+- **`person_properties?`** (`dict[str, Any]`) - Person properties
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties
+- **`only_evaluate_locally`** (`bool`) - Whether to evaluate only locally
+- **`send_feature_flag_events`** (`bool`) - Whether to send feature flag events
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup
+- **`device_id?`** (`str`) - Optional device ID override for experience-continuity flags
+
+### Returns
+
+- `Optional[bool]`
+
+### Examples
+
+```python
+# Boolean feature flag
+from posthog import feature_enabled, get_feature_flag_payload
+is_my_flag_enabled = feature_enabled('flag-key', 'distinct_id_of_your_user')
+if is_my_flag_enabled:
+    matched_flag_payload = get_feature_flag_payload('flag-key', 'distinct_id_of_your_user')
+```
+
+---
+
+#### feature_flag_definitions()
+
+**Release Tag:** public
+
+Returns loaded feature flags.
+
+**Notes:**
+
+Returns loaded feature flags, if any. Helpful for debugging what flag information you have loaded.
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import feature_flag_definitions
+definitions = feature_flag_definitions()
+```
+
+---
+
+#### get_all_flags()
+
+**Release Tag:** public
+
+Get all flags for a given user.
+
+**Notes:**
+
+Flags are key-value pairs where the key is the flag key and the value is the flag variant, or True, or False.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The user's distinct ID
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Groups mapping
+- **`person_properties?`** (`dict[str, Any]`) - Person properties
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties
+- **`only_evaluate_locally`** (`bool`) - Whether to evaluate only locally
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup
+- **`device_id?`** (`str`) - Optional device ID override for experience-continuity flags
+- **`flag_keys_to_evaluate?`** (`list[str]`) - Optional list of flag keys to evaluate (evaluates all if None)
+
+### Returns
+
+- `Optional[dict[str, Union[bool, str]]]`
+
+### Examples
+
+```python
+# All flags for user
+from posthog import get_all_flags
+get_all_flags('distinct_id_of_your_user')
+```
+
+---
+
+#### get_all_flags_and_payloads()
+
+**Release Tag:** public
+
+Get all feature flag values and payloads for a user.
+
+### Parameters
+
+- **`distinct_id?`** (`Number`) - The user's distinct ID.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Mapping of group type to group key.
+- **`person_properties?`** (`dict[str, Any]`) - Person properties to use for evaluation.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties keyed by group type.
+- **`only_evaluate_locally`** (`bool`) - Whether to evaluate only locally.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup.
+- **`device_id?`** (`str`) - Optional device ID override for experience-continuity flags.
+- **`flag_keys_to_evaluate?`** (`list[str]`) - Optional list of flag keys to evaluate. Evaluates         all flags when omitted.
+
+### Returns
+
+- `FlagsAndPayloads`
+
+---
+
+#### get_feature_flag()
+
+**Release Tag:** public
+
+Get feature flag variant for users. Used with experiments.
+
+**Notes:**
+
+`groups` are a mapping from group type to group key. So, if you have a group type of "organization" and a group key of "5", you would pass groups={"organization": "5"}. `group_properties` take the format: { group_type_name: { group_properties } }. So, for example, if you have the group type "organization" and the group key "5", with the properties name, and employee count, you'll send these as: group_properties={"organization": {"name": "PostHog", "employees": 11}}.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key
+- **`distinct_id?`** (`Number`) - The user's distinct ID
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Groups mapping from group type to group key
+- **`person_properties?`** (`dict[str, Any]`) - Person properties
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties in format { group_type_name: { group_properties } }
+- **`only_evaluate_locally`** (`bool`) - Whether to evaluate only locally
+- **`send_feature_flag_events`** (`bool`) - Whether to send feature flag events
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup
+- **`device_id?`** (`str`) - Optional device ID override for experience-continuity flags
+
+### Returns
+
+- `Union[bool, str, any]`
+
+### Examples
+
+```python
+# Multivariate feature flag
+from posthog import get_feature_flag, get_feature_flag_payload
+enabled_variant = get_feature_flag('flag-key', 'distinct_id_of_your_user')
+if enabled_variant == 'variant-key':
+    matched_flag_payload = get_feature_flag_payload('flag-key', 'distinct_id_of_your_user')
+```
+
+---
+
+#### get_feature_flag_payload()
+
+**Release Tag:** public
+
+Get the payload associated with a feature flag value.  Deprecated for new code. Prefer ``evaluate_flags()`` and ``flags.get_flag_payload(key)`` so flag evaluation happens once per request.
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key.
+- **`distinct_id?`** (`Number`) - The user's distinct ID.
+- **`match_value`** (`bool`) - Optional flag value to use when selecting a payload.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Mapping of group type to group key.
+- **`person_properties?`** (`dict[str, Any]`) - Person properties to use for evaluation.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties keyed by group type.
+- **`only_evaluate_locally`** (`bool`) - Whether to evaluate only locally.
+- **`send_feature_flag_events`** (`bool`) - Whether to send a $feature_flag_called event.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup.
+- **`device_id?`** (`str`) - Optional device ID override for experience-continuity flags.
+
+### Returns
+
+- `Optional[object]`
+
+---
+
+#### load_feature_flags()
+
+**Release Tag:** public
+
+Load feature flag definitions from PostHog.
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import load_feature_flags
+load_feature_flags()
+```
+
+---
+
+### Client management methods
+
+#### flush()
+
+**Release Tag:** public
+
+Tell the client to flush all queued events.
+
+### Parameters
+
+- **`timeout_seconds?`** (`float`) - Maximum seconds to wait for the queue to flush.         Defaults to 10 seconds. Pass ``None`` to wait indefinitely.
+
+### Returns
+
+- `any`
+
+### Examples
+
+```python
+from posthog import flush
+flush()
+```
+
+---
+
+#### join()
+
+**Release Tag:** public
+
+Block program until the client clears the queue. Used during program shutdown. You should use `shutdown()` directly in most cases.
+
+### Returns
+
+- `any`
+
+### Examples
+
+```python
+from posthog import join
+join()
+```
+
+---
+
+#### shutdown()
+
+**Release Tag:** public
+
+Flush all messages and cleanly shutdown the client.
+
+### Returns
+
+- `any`
+
+### Examples
+
+```python
+from posthog import shutdown
+shutdown()
+```
+
+---
+
+### Other methods
+
+#### get_feature_flag_result()
+
+**Release Tag:** public
+
+Get a FeatureFlagResult object which contains the flag result and payload.  This method evaluates a feature flag and returns a FeatureFlagResult object containing: - enabled: Whether the flag is enabled - variant: The variant value if the flag has variants - payload: The payload associated with the flag (automatically deserialized from JSON) - key: The flag key - reason: Why the flag was enabled/disabled
+
+### Parameters
+
+- **`key?`** (`str`) - The feature flag key.
+- **`distinct_id?`** (`Number`) - The user's distinct ID.
+- **`groups?`** (`Mapping[str, Union[str, int]]`) - Mapping of group type to group key.
+- **`person_properties?`** (`dict[str, Any]`) - Person properties to use for evaluation.
+- **`group_properties?`** (`dict[str, dict[str, Any]]`) - Group properties keyed by group type.
+- **`only_evaluate_locally`** (`bool`) - Whether to evaluate only locally.
+- **`send_feature_flag_events`** (`bool`) - Whether to send a $feature_flag_called event.
+- **`disable_geoip?`** (`bool`) - Whether to disable GeoIP lookup.
+- **`device_id?`** (`str`) - Optional device ID override for experience-continuity flags.
+
+### Returns
+
+- `Optional[FeatureFlagResult]`
+
+---
+
+#### get_remote_config_payload()
+
+**Release Tag:** public
+
+Get the payload for a remote config feature flag.
+
+### Parameters
+
+- **`key?`** (`str`) - The key of the feature flag
+
+### Returns
+
+- `None`
+
+---
+
+#### set_code_variables_mask_url_credentials_context()
+
+**Release Tag:** public
+
+Whether to scrub credentials embedded in URLs/DSNs (e.g. user:pass@host) from captured code variables for the current context.
+
+### Parameters
+
+- **`enabled?`** (`bool`)
+
+### Returns
+
+- `None`
+
+---
+
+### Contexts methods
+
+#### get_tags()
+
+**Release Tag:** public
+
+Get all tags from the current context.  Returns:     Dict of all tags in the current context
+
+### Returns
+
+- `dict[str, Any]`
+
+---
+
+#### new_context()
+
+**Release Tag:** public
+
+Create a new context scope that will be active for the duration of the with block.
+
+### Parameters
+
+- **`fresh`** (`bool`) - Whether to start with a fresh context (default: False)
+- **`capture_exceptions?`** (`bool`) - Whether to capture exceptions raised within the context. If omitted, defaults to the relevant client's exception autocapture setting.
+- **`client?`** (`Client`) - Optional Posthog client instance to use for this context (default: None)
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import new_context, tag, capture
+with new_context():
+    tag("request_id", "123")
+    capture("event_name", properties={"property": "value"})
+```
+
+---
+
+#### scoped()
+
+**Release Tag:** public
+
+Decorator that creates a new context for the function.
+
+### Parameters
+
+- **`fresh`** (`bool`) - Whether to start with a fresh context (default: False)
+- **`capture_exceptions?`** (`bool`) - Whether to capture and track exceptions with posthog error tracking. If omitted, defaults to the global exception autocapture setting.
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import scoped, tag, capture
+@scoped()
+def process_payment(payment_id):
+    tag("payment_id", payment_id)
+    capture("payment_started")
+```
+
+---
+
+#### set_capture_exception_code_variables_context()
+
+**Release Tag:** public
+
+Override code-variable capture for exceptions in the current context.
+
+### Parameters
+
+- **`enabled?`** (`bool`) - Whether exceptions captured in this context should include local         variable values from stack frames.
+
+### Returns
+
+- `None`
+
+---
+
+#### set_code_variables_detect_secrets_context()
+
+**Release Tag:** public
+
+Whether to apply entropy-based secret detection as a last-resort redaction of high-entropy values (API keys, tokens, strong passwords) in captured code variables for the current context.
+
+### Parameters
+
+- **`enabled?`** (`bool`)
+
+### Returns
+
+- `None`
+
+---
+
+#### set_code_variables_ignore_patterns_context()
+
+**Release Tag:** public
+
+Override code-variable ignore patterns for exceptions in the current context.
+
+### Parameters
+
+- **`ignore_patterns?`** (`list[str]`) - Variable-name patterns that should be omitted entirely         when code variables are captured.
+
+### Returns
+
+- `None`
+
+---
+
+#### set_code_variables_mask_patterns_context()
+
+**Release Tag:** public
+
+Override code-variable mask patterns for exceptions in the current context.
+
+### Parameters
+
+- **`mask_patterns?`** (`list[str]`) - Variable-name patterns whose values should be replaced         with ``***`` when code variables are captured.
+
+### Returns
+
+- `None`
+
+---
+
+#### set_context_device_id()
+
+**Release Tag:** public
+
+Set the device ID for the current context, associating all feature flag requests in this or child contexts with the given device ID.
+
+### Parameters
+
+- **`device_id?`** (`str`) - The device ID to associate with the current context and its children
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import set_context_device_id
+set_context_device_id("device_123")
+```
+
+---
+
+#### set_context_session()
+
+**Release Tag:** public
+
+Set the session ID for the current context.
+
+### Parameters
+
+- **`session_id?`** (`str`) - The session ID to associate with the current context and its children
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import set_context_session
+set_context_session("session_123")
+```
+
+---
+
+#### tag()
+
+**Release Tag:** public
+
+Add a tag to the current context.
+
+### Parameters
+
+- **`name?`** (`str`) - The tag key
+- **`value?`** (`Any`) - The tag value
+
+### Returns
+
+- `None`
+
+### Examples
+
+```python
+from posthog import tag
+tag("user_id", "123")
+```
+
+---
+
+### Initialization methods
+
+#### setup()
+
+**Release Tag:** public
+
+Create or return the global PostHog client configured by module settings.  Most applications should either instantiate ``Posthog`` directly or set ``posthog.api_key``/other module settings before calling top-level helpers. ``setup()`` is called automatically by global APIs such as ``capture()``.  Returns:     The global ``Client`` instance. If ``api_key`` is missing or blank,     the client is disabled and module-level calls become no-ops.
+
+### Returns
+
+- `Client`
+
+---