feat(errors): Add manual exception capture (#134)

* feat(errors): Add manual exception capture

* prep release

* use backwards compatible helper

* add tests

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: CI
+
+on:
+    - pull_request
+
+jobs:
+    code-quality:
+        name: Code quality checks
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v2
+              with:
+                  fetch-depth: 1
+
+            - name: Set up Python 3.8
+              uses: actions/setup-python@v2
+              with:
+                  python-version: 3.8
+
+            - uses: actions/cache@v1
+              with:
+                  path: ~/.cache/pip
+                  key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pip-
+
+            - name: Install dev dependencies
+              run: |
+                  python -m pip install -e .[dev]
+              if: steps.cache.outputs.cache-hit != 'true'
+
+            - name: Check formatting with black
+              run: |
+                  black --check .
+            
+            - name: Lint with flake8
+              run: |
+                  flake8 posthog --ignore E501
+
+            - name: Check import order with isort
+              run: |
+                  isort --check-only .
+
+    tests:
+        name: Python tests
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v1
+              with:
+                  fetch-depth: 1
+
+            - name: Set up Python 3.7
+              uses: actions/setup-python@v1
+              with:
+                  python-version: 3.7
+
+            - name: Install requirements.txt dependencies with pip
+              run: |
+                  python -m pip install -e .[test]
+
+            - name: Run posthog tests
+              run: |
+                  pytest --verbose --timeout=30

.github/workflows/release.yaml

@@ -0,0 +1,38 @@
+name: 'Release'
+
+on:
+  - workflow_dispatch
+
+jobs:
+    release:
+        name: Publish release
+        runs-on: ubuntu-20.04
+        env:
+            TWINE_USERNAME: __token__
+            TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        steps:
+            - name: Checkout the repository
+              uses: actions/checkout@v2
+              with:
+                  fetch-depth: 0
+                  token: ${{ secrets.POSTHOG_BOT_GITHUB_TOKEN }}
+
+            - name: Set up Python
+              uses: actions/setup-python@v2
+
+            - name: Detect version
+              run: echo "REPO_VERSION=$(python3 posthog/version.py)" >> $GITHUB_ENV
+
+            - name: Prepare for building release
+              run: pip install -U pip setuptools wheel twine
+
+            - name: Push release to PyPI
+              run: make release && make release_analytics
+
+            - name: Create GitHub release
+              uses: actions/create-release@v1
+              env:
+                  GITHUB_TOKEN: ${{ secrets.POSTHOG_BOT_GITHUB_TOKEN }}
+              with:
+                  tag_name: v${{ env.REPO_VERSION }}
+                  release_name: ${{ env.REPO_VERSION }}

.gitignore

@@ -1,14 +1,17 @@
 **sublime**
 *.pyc
-dist
+dist/
 *.egg-info
-dist
 MANIFEST
-build
-.eggs
+build/
+.eggs/
 .coverage
 .vscode/
-env
+env/
+venv/
 flake8.out
 pylint.out
 posthog-analytics
+.idea
+.python-version
+.coverage

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.7.0
+    hooks:
+      - id: isort

CHANGELOG.md

@@ -0,0 +1,200 @@
+## 3.6.4 - 2024-09-05
+
+1. Add manual exception capture.
+
+## 3.6.3 - 2024-09-03
+
+1. Make sure setup.py for posthoganalytics package also discovers the new exception integration package.
+
+## 3.6.2 - 2024-09-03
+
+1. Make sure setup.py discovers the new exception integration package.
+
+## 3.6.1 - 2024-09-03
+
+1. Adds django integration to exception autocapture in alpha state. This feature is not yet stable and may change in future versions.
+
+## 3.6.0 - 2024-08-28
+
+1. Adds exception autocapture in alpha state. This feature is not yet stable and may change in future versions.
+
+## 3.5.2 - 2024-08-21
+
+1. Guard for None values in local evaluation
+
+## 3.5.1 - 2024-08-13
+
+1. Remove "-api" suffix from ingestion hostnames
+
+## 3.5.0 - 2024-02-29
+
+1. - Adds a new `feature_flags_request_timeout_seconds` timeout parameter for feature flags which defaults to 3 seconds, updated from the default 10s for all other API calls.
+
+## 3.4.2 - 2024-02-20
+
+1. Add `historical_migration` option for bulk migration to PostHog Cloud.
+
+## 3.4.1 - 2024-02-09
+
+1. Use new hosts for event capture as well
+
+## 3.4.0 - 2024-02-05
+
+1. Point given hosts to new ingestion hosts
+
+## 3.3.4 - 2024-01-30
+
+1. Update type hints for module variables to work with newer versions of mypy
+
+## 3.3.3 - 2024-01-26
+
+1. Remove new relative date operators, combine into regular date operators
+
+## 3.3.2 - 2024-01-19
+
+1. Return success/failure with all capture calls from module functions
+
+
+## 3.3.1 - 2024-01-10
+
+1. Make sure we don't override any existing feature flag properties when adding locally evaluated feature flag properties.
+
+## 3.3.0 - 2024-01-09
+
+1. When local evaluation is enabled, we automatically add flag information to all events sent to PostHog, whenever possible. This makes it easier to use these events in experiments.
+
+## 3.2.0 - 2024-01-09
+
+1. Numeric property handling for feature flags now does the expected: When passed in a number, we do a numeric comparison. When passed in a string, we do a string comparison. Previously, we always did a string comparison.
+2. Add support for relative date operators for local evaluation.
+
+## 3.1.0 - 2023-12-04
+
+1. Increase maximum event size and batch size
+
+## 3.0.2 - 2023-08-17
+
+1. Returns the current flag property with $feature_flag_called events, to make it easier to use in experiments
+
+## 3.0.1 - 2023-04-21
+
+1. Restore how feature flags work when the client library is disabled: All requests return `None` and no events are sent when the client is disabled.
+2. Add a `feature_flag_definitions()` debug option, which returns currently loaded feature flag definitions. You can use this to more cleverly decide when to request local evaluation of feature flags.
+## 3.0.0 - 2023-04-14
+
+Breaking change:
+
+All events by default now send the `$geoip_disable` property to disable geoip lookup in app. This is because usually we don't
+want to update person properties to take the server's location.
+
+The same now happens for feature flag requests, where we discard the IP address of the server for matching on geoip properties like city, country, continent.
+
+To restore previous behaviour, you can set the default to False like so:
+
+```python
+posthog.disable_geoip = False
+
+# // and if using client instantiation:
+posthog = Posthog('api_key', disable_geoip=False)
+
+```
+
+## 2.5.0 - 2023-04-10
+
+1. Add option for instantiating separate client object
+
+## 2.4.2 - 2023-03-30
+
+1. Update backoff dependency for posthoganalytics package to be the same as posthog package
+
+## 2.4.1 - 2023-03-17
+
+1. Removes accidental print call left in for decide response
+
+## 2.4.0 - 2023-03-14
+
+1. Support evaluating all cohorts in feature flags for local evaluation
+
+## 2.3.1 - 2023-02-07
+
+1. Log instead of raise error on posthog personal api key errors
+2. Remove upper bound on backoff dependency
+
+
+## 2.3.0 - 2023-01-31
+
+1. Add support for returning payloads of matched feature flags
+
+## 2.2.0 - 2022-11-14
+
+Changes:
+
+1. Add support for feature flag variant overrides with local evaluation
+
+## 2.1.2 - 2022-09-15
+
+Changes:
+
+1. Fixes issues with date comparison.
+## 2.1.1 - 2022-09-14
+
+Changes:
+
+1. Feature flags local evaluation now supports date property filters as well. Accepts both strings and datetime objects.
+
+## 2.1.0 - 2022-08-11
+
+Changes:
+
+1. Feature flag defaults have been removed
+2. Setup logging only when debug mode is enabled.
+## 2.0.1 - 2022-08-04
+
+- Make poll_interval configurable
+- Add `send_feature_flag_events` parameter to feature flag calls, which determine whether the `$feature_flag_called` event should be sent or not.
+- Add `only_evaluate_locally` parameter to feature flag calls, which determines whether the feature flag should only be evaluated locally or not.
+
+## 2.0.0 - 2022-08-02
+
+Breaking changes:
+
+1. The minimum version requirement for PostHog servers is now 1.38. If you're using PostHog Cloud, you satisfy this requirement automatically.
+2. Feature flag defaults apply only when there's an error fetching feature flag results. Earlier, if the default was set to `True`, even if a flag resolved to `False`, the default would override this.
+**Note: These are removed in 2.0.2**
+3. Feature flag remote evaluation doesn't require a personal API key.
+
+New Changes:
+
+1. You can now evaluate feature flags locally (i.e. without sending a request to your PostHog servers) by setting a personal API key, and passing in groups and person properties to `is_feature_enabled` and `get_feature_flag` calls.
+2. Introduces a `get_all_flags` method that returns all feature flags. This is useful for when you want to seed your frontend with some initial flags, given a user ID.
+
+
+
+## 1.4.9 - 2022-06-13
+- Support for sending feature flags with capture calls
+
+## 1.4.8 - 2022-05-12
+- Support multi variate feature flags
+
+## 1.4.7 - 2022-04-25
+- Allow feature flags usage without project_api_key
+
+## 1.4.1 - 2021-05-28
+- Fix packaging issues with Sentry integrations
+
+## 1.4.0 - 2021-05-18
+
+- Improve support for `project_api_key` (#32)
+- Resolve polling issues with feature flags (#29)
+- Add Sentry (and Sentry+Django) integrations (#13)
+- Fix feature flag issue with no percentage rollout (#30)
+
+## 1.3.1 - 2021-05-07
+
+- Add `$set` and `$set_once` support (#23)
+- Add distinct ID to `$create_alias` event (#27)
+- Add `UUID` to `ID_TYPES` (#26)
+
+## 1.2.1 - 2021-02-05
+
+Initial release logged in CHANGELOG.md.

CODEOWNERS

@@ -0,0 +1 @@
+@PostHog/team-feature-success

LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2020 PostHog (part of Hiberly Inc)
+Copyright (c) 2023 PostHog (part of Hiberly Inc)
+
+Copyright (c) 2013 Segment Inc. friends@segment.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,7 +1,10 @@
-test:
+lint:
 	pylint --rcfile=.pylintrc --reports=y --exit-zero analytics | tee pylint.out
 	flake8 --max-complexity=10 --statistics analytics > flake8.out || true
-	coverage run --branch --include=analytics/\* --omit=*/test* setup.py test
+
+test:
+	coverage run -m pytest
+	coverage report
 
 release:
 	rm -rf dist/*
@@ -26,4 +29,8 @@ release_analytics:
 e2e_test:
 	.buildscripts/e2e.sh
 
-.PHONY: test release e2e_test
+django_example:
+	python -m pip install -e ".[sentry]"
+	cd sentry_django_example && python manage.py runserver 8080
+
+.PHONY: test lint release e2e_test

README.md

@@ -1,118 +1,46 @@
 # PostHog Python
 
-Official PostHog Python library to capture and send events to any PostHog instance (including PostHog.com).
+[![PyPI](https://img.shields.io/pypi/v/posthog)](https://pypi.org/project/posthog/)
 
-This library uses an internal queue to make calls non-blocking and fast. It also batches requests and flushes asynchronously, making it perfect to use in any part of your web app or other server side application that needs performance.
 
-## Installation 
+Please see the [Python integration docs](https://posthog.com/docs/integrations/python-integration) for details.
 
-```bash
-pip install posthog
-```
+## Development
 
-In your app, import the posthog library and set your api key **before** making any calls.
+### Testing Locally
 
-```python
-import posthog
+1. Run `python3 -m venv env` (creates virtual environment called "env")
+2. Run `source env/bin/activate` (activates the virtual environment)
+3. Run `python3 -m pip install -e ".[test]"` (installs the package in develop mode, along with test dependencies)
+4. Run `make test`
+  1. To run a specific test do `pytest -k test_no_api_key`
 
-posthog.api_key = 'YOUR API KEY'
-```
+### Running Locally
 
-You can find your key in the /setup page in PostHog.
+Assuming you have a [local version of PostHog](https://posthog.com/docs/developing-locally) running, you can run `python3 example.py` to see the library in action.
 
-To debug, you can set debug mode.
-```python
-posthog.debug = True
-```
+### Running the Django Sentry Integration Locally
 
-## Making calls
+There's a sample Django project included, called `sentry_django_example`, which explains how to use PostHog with Sentry.
 
-### Capture
+There's 2 places of importance (Changes required are all marked with TODO in the sample project directory)
 
-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.
+1. Settings.py
+    1. Input your Sentry DSN
+    2. Input your Sentry Org and ProjectID details into `PosthogIntegration()`
+    3. Add `POSTHOG_DJANGO` to settings.py. This allows the `PosthogDistinctIdMiddleware` to get the distinct_ids
 
-A `capture` call requires
- - `distinct id` which uniquely identifies your user
- - `event name` to make sure 
-   - We recommend using [verb] [noun], like `movie played` or `movie updated` to easily identify what your events mean later on.
+2. urls.py
+    1. This includes the `sentry-debug/` endpoint, which generates an exception
 
-Optionally you can submit
-- `properties`, which can be a dict with any information you'd like to add
+To run things: `make django_example`. This installs the posthog-python library with the sentry-sdk add-on, and then runs the django app.
+Also start the PostHog app locally.
+Then navigate to `http://127.0.0.1:8080/sentry-debug/` and you should get an event in both Sentry and PostHog, with links to each other.
 
-For example:
-```python
-posthog.capture('distinct id', 'movie played', {'movie_id': '123', 'category': 'romcom'})
-```
+### Releasing Versions
 
-### Identify
-Identify lets you add metadata on your users so you can more easily identify who they are in PostHog, and even do things like segment users by these properties.
+Updated are released using GitHub Actions: after bumping `version.py` in `master` and adding to `CHANGELOG.md`, go to [our release workflow's page](https://github.com/PostHog/posthog-python/actions/workflows/release.yaml) and dispatch it manually, using workflow from `master`.
 
-An `identify` call requires
-- `distinct id` which uniquely identifies your user
-- `properties` with a dict with any key: value pairs 
+## Questions?
 
-For example:
-```python
-posthog.capture('distinct id', {
-    'email': 'dwayne@gmail.com',
-    'name': 'Dwayne Johnson'
-})
-```
-
-The most obvious place to make this call is whenever a user signs up, or when they update their information.
-
-### Alias
-
-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?"
-
-In a purely back-end implementation, this means whenever an anonymous user does something, you'll want to send a session ID ([Django](https://stackoverflow.com/questions/526179/in-django-how-can-i-find-out-the-request-session-sessionid-and-use-it-as-a-vari), [Flask](https://stackoverflow.com/questions/15156132/flask-login-how-to-get-session-id)) with the capture call. Then, when that users signs up, you want to do an alias call with the session ID and the newly created user ID.
-
-The same concept applies for when a user logs in.
-
-An `alias` call requires
-- `previous distinct id` the unique ID of the user before
-- `distinct id` the current unique id
-
-For example:
-```python
-posthog.alias('anonymous session id', 'distinct id')
-```
-
-## Django
-
-For Django, you can do the initialisation of the key in the AppConfig, so that it's available everywhere.
-
-in `yourapp/apps.py`
-```python
-from django.apps import AppConfig
-import posthog
-
-class YourAppConfig(AppConfig):
-    def ready(self):
-        posthog.api_key = 'your key'
-```
-
-Then, anywhere else in your app you can do
-```python
-import posthog
-
-def homepage(request):
-    # example capture
-    posthog.capture(request.session.session_key, 'page view', ....)
-```
-
-# Development
-
-## Naming confusion
-
-As our open source project [PostHog](https://github.com/PostHog/posthog) shares the same module name, we create a special `posthog-analytics` package, mostly for internal use to avoid module collision. It is the exact same.
-
-## How to release
-1. Increase `VERSION` in `posthog/version.py`
-2. run `make release` and `make release_analytics`
-3. `git commit -am "Release X.Y.Z."` (where X.Y.Z is the new version)
-4. `git tag -a X.Y.Z -m "Version X.Y.Z"` (where X.Y.Z is the new version).
-
-## Thank you
-
-This library is largely based on the `analytics-python` package.
+### [Join our Slack community.](https://join.slack.com/t/posthogusers/shared_invite/enQtOTY0MzU5NjAwMDY3LTc2MWQ0OTZlNjhkODk3ZDI3NDVjMDE1YjgxY2I4ZjI4MzJhZmVmNjJkN2NmMGJmMzc2N2U3Yjc3ZjI5NGFlZDQ)

example.py

@@ -1,20 +1,101 @@
 # PostHog Python library example
 
 # Import the library
+import time
+
 import posthog
 
+posthog.debug = True
+
 # You can find this key on the /setup page in PostHog
-posthog.api_key = '<your key>'
+posthog.project_api_key = "phc_gtWmTq3Pgl06u4sZY3TRcoQfp42yfuXHKoe8ZVSR6Kh"
+posthog.personal_api_key = "phx_fiRCOQkTA3o2ePSdLrFDAILLHjMu2Mv52vUi8MNruIm"
 
 # Where you host PostHog, with no trailing /.
 # You can remove this line if you're using posthog.com
-posthog.host = 'http://127.0.0.1:8000' 
+posthog.host = "http://localhost:8000"
+posthog.poll_interval = 10
+
+print(
+    posthog.feature_enabled(
+        "person-on-events-enabled",
+        "12345",
+        groups={"organization": str("0182ee91-8ef7-0000-4cb9-fedc5f00926a")},
+        group_properties={
+            "organization": {
+                "id": "0182ee91-8ef7-0000-4cb9-fedc5f00926a",
+                "created_at": "2022-06-30 11:44:52.984121+00:00",
+            }
+        },
+        only_evaluate_locally=True,
+    )
+)
+
 
 # Capture an event
-posthog.capture('distinct_id', 'event', {'property1': 'value', 'property2': 'value'})
+posthog.capture("distinct_id", "event", {"property1": "value", "property2": "value"}, send_feature_flags=True)
 
-# Alias a previous distinct id with a new one
-posthog.alias('distinct_id', 'new_distinct_id')
+print(posthog.feature_enabled("beta-feature", "distinct_id"))
+print(posthog.feature_enabled("beta-feature-groups", "distinct_id", groups={"company": "id:5"}))
 
-# Add properties to the person
-posthog.identify('distinct_id', {'email': 'something@something.com'})
+print(posthog.feature_enabled("beta-feature", "distinct_id"))
+
+# get payload
+print(posthog.get_feature_flag_payload("beta-feature", "distinct_id"))
+print(posthog.get_all_flags_and_payloads("distinct_id"))
+exit()
+# # Alias a previous distinct id with a new one
+
+posthog.alias("distinct_id", "new_distinct_id")
+
+posthog.capture("new_distinct_id", "event2", {"property1": "value", "property2": "value"})
+posthog.capture(
+    "new_distinct_id", "event-with-groups", {"property1": "value", "property2": "value"}, groups={"company": "id:5"}
+)
+
+# # Add properties to the person
+posthog.identify("new_distinct_id", {"email": "something@something.com"})
+
+# Add properties to a group
+posthog.group_identify("company", "id:5", {"employees": 11})
+
+# properties set only once to the person
+posthog.set_once("new_distinct_id", {"self_serve_signup": True})
+
+
+posthog.set_once(
+    "new_distinct_id", {"self_serve_signup": False}
+)  # this will not change the property (because it was already set)
+
+posthog.set("new_distinct_id", {"current_browser": "Chrome"})
+posthog.set("new_distinct_id", {"current_browser": "Firefox"})
+
+
+# #############################################################################
+# Make sure you have a personal API key for the examples below
+
+# Local Evaluation
+
+# If flag has City=Sydney, this call doesn't go to `/decide`
+print(posthog.feature_enabled("test-flag", "distinct_id_random_22", person_properties={"$geoip_city_name": "Sydney"}))
+
+print(
+    posthog.feature_enabled(
+        "test-flag",
+        "distinct_id_random_22",
+        person_properties={"$geoip_city_name": "Sydney"},
+        only_evaluate_locally=True,
+    )
+)
+
+
+print(posthog.get_all_flags("distinct_id_random_22"))
+print(posthog.get_all_flags("distinct_id_random_22", only_evaluate_locally=True))
+print(
+    posthog.get_all_flags(
+        "distinct_id_random_22", person_properties={"$geoip_city_name": "Sydney"}, only_evaluate_locally=True
+    )
+)
+
+
+posthog.shutdown()

posthog/__init__.py

@@ -1,66 +1,229 @@
+import datetime  # noqa: F401
+from typing import Callable, Dict, List, Optional, Tuple  # noqa: F401
 
-from posthog.version import VERSION
 from posthog.client import Client
-from typing import Optional, Dict, Callable
+from posthog.exception_capture import DEFAULT_DISTINCT_ID, Integrations  # noqa: F401
+from posthog.version import VERSION
 
 __version__ = VERSION
 
 """Settings."""
-api_key: str = None
-host: str = None
-on_error: Callable = None
-debug: bool = False
-send: bool = True
-sync_mode:bool = False
+api_key = None  # type: Optional[str]
+host = None  # type: Optional[str]
+on_error = None  # type: Optional[Callable]
+debug = False  # type: bool
+send = True  # type: bool
+sync_mode = False  # type: bool
+disabled = False  # type: bool
+personal_api_key = None  # type: Optional[str]
+project_api_key = None  # type: Optional[str]
+poll_interval = 30  # type: int
+disable_geoip = True  # type: bool
+feature_flags_request_timeout_seconds = 3  # type: int
+# Currently alpha, use at your own risk
+enable_exception_autocapture = False  # type: bool
+exception_autocapture_integrations = []  # type: List[Integrations]
 
-default_client = None
+default_client = None  # type: Optional[Client]
 
 
-def capture(distinct_id: str, event: str, properties: Optional[Dict]=None, context: Optional[Dict]=None,
-              timestamp: Optional[str]=None, message_id: Optional[str]=None) -> None:
+def capture(
+    distinct_id,  # type: str
+    event,  # type: str
+    properties=None,  # type: Optional[Dict]
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    groups=None,  # type: Optional[Dict]
+    send_feature_flags=False,
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> Tuple[bool, dict]
     """
     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
     - `distinct id` which uniquely identifies your user
-    - `event name` to make sure 
+    - `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.
 
     Optionally you can submit
     - `properties`, which can be a dict with any information you'd like to add
+    - `groups`, which is a dict of group type -> group key mappings
 
     For example:
     ```python
+    posthog.capture('distinct id', 'opened app')
     posthog.capture('distinct id', 'movie played', {'movie_id': '123', 'category': 'romcom'})
+
+    posthog.capture('distinct id', 'purchase', groups={'company': 'id:5'})
     ```
     """
-    _proxy('capture', distinct_id=distinct_id, event=event, properties=properties, context=context, timestamp=timestamp, message_id=message_id)
+    return _proxy(
+        "capture",
+        distinct_id=distinct_id,
+        event=event,
+        properties=properties,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        groups=groups,
+        send_feature_flags=send_feature_flags,
+        disable_geoip=disable_geoip,
+    )
 
-def identify(distinct_id: str, properties: Optional[Dict]=None, context: Optional[Dict]=None, timestamp: Optional[str]=None,
-                message_id=None) -> None:
+
+def identify(
+    distinct_id,  # type: str
+    properties=None,  # type: Optional[Dict]
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> Tuple[bool, dict]
     """
     Identify lets you add metadata on your users so you can more easily identify who they are in PostHog, and even do things like segment users by these properties.
 
     An `identify` call requires
     - `distinct id` which uniquely identifies your user
-    - `properties` with a dict with any key: value pairs 
+    - `properties` with a dict with any key: value pairs
 
     For example:
     ```python
-    posthog.capture('distinct id', {
+    posthog.identify('distinct id', {
         'email': 'dwayne@gmail.com',
         'name': 'Dwayne Johnson'
     })
     ```
     """
-    _proxy('identify', distinct_id=distinct_id, properties=properties, context=context, timestamp=timestamp, message_id=message_id)
-
-def group(*args, **kwargs):
-    """Send a group call."""
-    _proxy('group', *args, **kwargs)
+    return _proxy(
+        "identify",
+        distinct_id=distinct_id,
+        properties=properties,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        disable_geoip=disable_geoip,
+    )
 
 
-def alias(previous_id: str, distinct_id: str, context: Optional[Dict]=None, timestamp: Optional[str]=None, message_id: Optional[str]=None) -> None:
+def set(
+    distinct_id,  # type: str
+    properties=None,  # type: Optional[Dict]
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> Tuple[bool, dict]
+    """
+    Set properties on a user record.
+    This will overwrite previous people property values, just like `identify`.
+
+     A `set` call requires
+     - `distinct id` which uniquely identifies your user
+     - `properties` with a dict with any key: value pairs
+
+     For example:
+     ```python
+     posthog.set('distinct id', {
+         'current_browser': 'Chrome',
+     })
+     ```
+    """
+    return _proxy(
+        "set",
+        distinct_id=distinct_id,
+        properties=properties,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        disable_geoip=disable_geoip,
+    )
+
+
+def set_once(
+    distinct_id,  # type: str
+    properties=None,  # type: Optional[Dict]
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> Tuple[bool, dict]
+    """
+    Set properties on a user record, only if they do not yet exist.
+    This will not overwrite previous people property values, unlike `identify`.
+
+     A `set_once` call requires
+     - `distinct id` which uniquely identifies your user
+     - `properties` with a dict with any key: value pairs
+
+     For example:
+     ```python
+     posthog.set_once('distinct id', {
+         'referred_by': 'friend',
+     })
+     ```
+    """
+    return _proxy(
+        "set_once",
+        distinct_id=distinct_id,
+        properties=properties,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        disable_geoip=disable_geoip,
+    )
+
+
+def group_identify(
+    group_type,  # type: str
+    group_key,  # type: str
+    properties=None,  # type: Optional[Dict]
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> Tuple[bool, dict]
+    """
+    Set properties on a group
+
+     A `group_identify` call requires
+     - `group_type` type of your group
+     - `group_key` unique identifier of the group
+     - `properties` with a dict with any key: value pairs
+
+     For example:
+     ```python
+     posthog.group_identify('company', 5, {
+         'employees': 11,
+     })
+     ```
+    """
+    return _proxy(
+        "group_identify",
+        group_type=group_type,
+        group_key=group_key,
+        properties=properties,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        disable_geoip=disable_geoip,
+    )
+
+
+def alias(
+    previous_id,  # type: str
+    distinct_id,  # type: str
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> Tuple[bool, dict]
     """
     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?"
 
@@ -77,42 +240,282 @@ def alias(previous_id: str, distinct_id: str, context: Optional[Dict]=None, time
     posthog.alias('anonymous session id', 'distinct id')
     ```
     """
-    _proxy('alias', previous_id=previous_id, distinct_id=distinct_id, context=context, timestamp=timestamp, message_id=message_id)
+    return _proxy(
+        "alias",
+        previous_id=previous_id,
+        distinct_id=distinct_id,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        disable_geoip=disable_geoip,
+    )
+
+
+def capture_exception(
+    exception=None,  # type: Optional[BaseException]
+    distinct_id=None,  # type: Optional[str]
+    properties=None,  # type: Optional[Dict]
+    context=None,  # type: Optional[Dict]
+    timestamp=None,  # type: Optional[datetime.datetime]
+    uuid=None,  # type: Optional[str]
+    groups=None,  # type: Optional[Dict]
+):
+    # type: (...) -> Tuple[bool, dict]
+    """
+    capture_exception allows you to capture exceptions that happen in your code. This is useful for debugging and understanding what errors your users are encountering.
+    This function never raises an exception, even if it fails to send the event.
+
+    A `capture_exception` call does not require any fields, but we recommend sending:
+    - `distinct id` which uniquely identifies your user for which this exception happens
+    - `exception` to specify the exception to capture. If not provided, the current exception is captured via `sys.exc_info()`
+
+    Optionally you can submit
+    - `properties`, which can be a dict with any information you'd like to add
+    - `groups`, which is a dict of group type -> group key mappings
+
+    For example:
+    ```python
+    try:
+        1 / 0
+    except Exception as e:
+        posthog.capture_exception(e, 'my specific distinct id')
+        posthog.capture_exception(distinct_id='my specific distinct id')
+
+    ```
+    """
+    return _proxy(
+        "capture_exception",
+        exception=exception,
+        distinct_id=distinct_id or DEFAULT_DISTINCT_ID,
+        properties=properties,
+        context=context,
+        timestamp=timestamp,
+        uuid=uuid,
+        groups=groups,
+    )
+
+
+def feature_enabled(
+    key,  # type: str
+    distinct_id,  # type: str
+    groups={},  # type: dict
+    person_properties={},  # type: dict
+    group_properties={},  # type: dict
+    only_evaluate_locally=False,  # type: bool
+    send_feature_flag_events=True,  # type: bool
+    disable_geoip=None,  # type: Optional[bool]
+):
+    # type: (...) -> bool
+    """
+    Use feature flags to enable or disable features for users.
+
+    For example:
+    ```python
+    if posthog.feature_enabled('beta feature', 'distinct id'):
+        # do something
+    if posthog.feature_enabled('groups feature', 'distinct id', groups={"organization": "5"}):
+        # do something
+    ```
+
+    You can call `posthog.load_feature_flags()` before to make sure you're not doing unexpected requests.
+    """
+    return _proxy(
+        "feature_enabled",
+        key=key,
+        distinct_id=distinct_id,
+        groups=groups,
+        person_properties=person_properties,
+        group_properties=group_properties,
+        only_evaluate_locally=only_evaluate_locally,
+        send_feature_flag_events=send_feature_flag_events,
+        disable_geoip=disable_geoip,
+    )
+
+
+def get_feature_flag(
+    key,  # type: str
+    distinct_id,  # type: str
+    groups={},  # type: dict
+    person_properties={},  # type: dict
+    group_properties={},  # type: dict
+    only_evaluate_locally=False,  # type: bool
+    send_feature_flag_events=True,  # type: bool
+    disable_geoip=None,  # type: Optional[bool]
+):
+    """
+    Get feature flag variant for users. Used with experiments.
+    Example:
+    ```python
+    if posthog.get_feature_flag('beta-feature', 'distinct_id') == 'test-variant':
+        # do test variant code
+    if posthog.get_feature_flag('beta-feature', 'distinct_id') == 'control':
+        # do control code
+    ```
+
+    `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:
+
+    ```python
+        group_properties={"organization": {"name": "PostHog", "employees": 11}}
+    ```
+    """
+    return _proxy(
+        "get_feature_flag",
+        key=key,
+        distinct_id=distinct_id,
+        groups=groups,
+        person_properties=person_properties,
+        group_properties=group_properties,
+        only_evaluate_locally=only_evaluate_locally,
+        send_feature_flag_events=send_feature_flag_events,
+        disable_geoip=disable_geoip,
+    )
+
+
+def get_all_flags(
+    distinct_id,  # type: str
+    groups={},  # type: dict
+    person_properties={},  # type: dict
+    group_properties={},  # type: dict
+    only_evaluate_locally=False,  # type: bool
+    disable_geoip=None,  # type: Optional[bool]
+):
+    """
+    Get all flags for a given user.
+    Example:
+    ```python
+    flags = posthog.get_all_flags('distinct_id')
+    ```
+
+    flags are key-value pairs where the key is the flag key and the value is the flag variant, or True, or False.
+    """
+    return _proxy(
+        "get_all_flags",
+        distinct_id=distinct_id,
+        groups=groups,
+        person_properties=person_properties,
+        group_properties=group_properties,
+        only_evaluate_locally=only_evaluate_locally,
+        disable_geoip=disable_geoip,
+    )
+
+
+def get_feature_flag_payload(
+    key,
+    distinct_id,
+    match_value=None,
+    groups={},
+    person_properties={},
+    group_properties={},
+    only_evaluate_locally=False,
+    send_feature_flag_events=True,
+    disable_geoip=None,  # type: Optional[bool]
+):
+    return _proxy(
+        "get_feature_flag_payload",
+        key=key,
+        distinct_id=distinct_id,
+        match_value=match_value,
+        groups=groups,
+        person_properties=person_properties,
+        group_properties=group_properties,
+        only_evaluate_locally=only_evaluate_locally,
+        send_feature_flag_events=send_feature_flag_events,
+        disable_geoip=disable_geoip,
+    )
+
+
+def get_all_flags_and_payloads(
+    distinct_id,
+    groups={},
+    person_properties={},
+    group_properties={},
+    only_evaluate_locally=False,
+    disable_geoip=None,  # type: Optional[bool]
+):
+    return _proxy(
+        "get_all_flags_and_payloads",
+        distinct_id=distinct_id,
+        groups=groups,
+        person_properties=person_properties,
+        group_properties=group_properties,
+        only_evaluate_locally=only_evaluate_locally,
+        disable_geoip=disable_geoip,
+    )
+
+
+def feature_flag_definitions():
+    """Returns loaded feature flags, if any. Helpful for debugging what flag information you have loaded."""
+    return _proxy("feature_flag_definitions")
+
+
+def load_feature_flags():
+    """Load feature flag definitions from PostHog."""
+    return _proxy("load_feature_flags")
 
 
 def page(*args, **kwargs):
     """Send a page call."""
-    _proxy('page', *args, **kwargs)
+    _proxy("page", *args, **kwargs)
 
 
 def screen(*args, **kwargs):
     """Send a screen call."""
-    _proxy('screen', *args, **kwargs)
+    _proxy("screen", *args, **kwargs)
 
 
 def flush():
     """Tell the client to flush."""
-    _proxy('flush')
+    _proxy("flush")
 
 
 def join():
     """Block program until the client clears the queue"""
-    _proxy('join')
+    _proxy("join")
 
 
 def shutdown():
     """Flush all messages and cleanly shutdown the client"""
-    _proxy('flush')
-    _proxy('join')
+    _proxy("flush")
+    _proxy("join")
 
 
 def _proxy(method, *args, **kwargs):
     """Create an analytics client if one doesn't exist and send to it."""
     global default_client
     if not default_client:
-        default_client = Client(api_key, host=host, debug=debug,
-                                on_error=on_error, send=send,
-                                sync_mode=sync_mode)
+        default_client = Client(
+            api_key,
+            host=host,
+            debug=debug,
+            on_error=on_error,
+            send=send,
+            sync_mode=sync_mode,
+            personal_api_key=personal_api_key,
+            project_api_key=project_api_key,
+            poll_interval=poll_interval,
+            disabled=disabled,
+            disable_geoip=disable_geoip,
+            feature_flags_request_timeout_seconds=feature_flags_request_timeout_seconds,
+            # TODO: Currently this monitoring begins only when the Client is initialised (which happens when you do something with the SDK)
+            # This kind of initialisation is very annoying for exception capture. We need to figure out a way around this,
+            # or deprecate this proxy option fully (it's already in the process of deprecation, no new clients should be using this method since like 5-6 months)
+            enable_exception_autocapture=enable_exception_autocapture,
+            exception_autocapture_integrations=exception_autocapture_integrations,
+        )
+
+    # always set incase user changes it
+    default_client.disabled = disabled
+    default_client.debug = debug
 
     fn = getattr(default_client, method)
-    fn(*args, **kwargs)
+    return fn(*args, **kwargs)
+
+
+class Posthog(Client):
+    pass

posthog/client.py

@@ -1,15 +1,20 @@
-from datetime import datetime
-from uuid import uuid4
+import atexit
 import logging
 import numbers
-import atexit
+import sys
+from datetime import datetime, timedelta
+from uuid import UUID
 
 from dateutil.tz import tzutc
 from six import string_types
 
-from posthog.utils import guess_timezone, clean
 from posthog.consumer import Consumer
-from posthog.request import post
+from posthog.exception_capture import DEFAULT_DISTINCT_ID, ExceptionCapture
+from posthog.exception_utils import exc_info_from_error, exceptions_from_error_tuple, handle_in_app
+from posthog.feature_flags import InconclusiveMatchError, match_feature_flag_properties
+from posthog.poller import Poller
+from posthog.request import DEFAULT_HOST, APIError, batch_post, decide, determine_server_host, get
+from posthog.utils import SizeLimitedDict, clean, guess_timezone, remove_trailing_slash
 from posthog.version import VERSION
 
 try:
@@ -18,31 +23,83 @@ except ImportError:
     import Queue as queue
 
 
-ID_TYPES = (numbers.Number, string_types)
+ID_TYPES = (numbers.Number, string_types, UUID)
+MAX_DICT_SIZE = 50_000
 
 
 class Client(object):
     """Create a new PostHog client."""
-    log = logging.getLogger('posthog')
 
-    def __init__(self, api_key=None, host=None, debug=False,
-                 max_queue_size=10000, send=True, on_error=None, flush_at=100,
-                 flush_interval=0.5, gzip=False, max_retries=3,
-                 sync_mode=False, timeout=15, thread=1):
-        require('api_key', api_key, string_types)
+    log = logging.getLogger("posthog")
 
+    def __init__(
+        self,
+        api_key=None,
+        host=None,
+        debug=False,
+        max_queue_size=10000,
+        send=True,
+        on_error=None,
+        flush_at=100,
+        flush_interval=0.5,
+        gzip=False,
+        max_retries=3,
+        sync_mode=False,
+        timeout=15,
+        thread=1,
+        poll_interval=30,
+        personal_api_key=None,
+        project_api_key=None,
+        disabled=False,
+        disable_geoip=True,
+        historical_migration=False,
+        feature_flags_request_timeout_seconds=3,
+        enable_exception_autocapture=False,
+        exception_autocapture_integrations=None,
+    ):
         self.queue = queue.Queue(max_queue_size)
-        self.api_key = api_key
+
+        # api_key: This should be the Team API Key (token), public
+        self.api_key = project_api_key or api_key
+
+        require("api_key", self.api_key, string_types)
+
         self.on_error = on_error
         self.debug = debug
         self.send = send
         self.sync_mode = sync_mode
-        self.host = host
+        # Used for session replay URL generation - we don't want the server host here.
+        self.raw_host = host or DEFAULT_HOST
+        self.host = determine_server_host(host)
         self.gzip = gzip
         self.timeout = timeout
+        self.feature_flags = None
+        self.feature_flags_by_key = None
+        self.group_type_mapping = None
+        self.cohorts = None
+        self.poll_interval = poll_interval
+        self.feature_flags_request_timeout_seconds = feature_flags_request_timeout_seconds
+        self.poller = None
+        self.distinct_ids_feature_flags_reported = SizeLimitedDict(MAX_DICT_SIZE, set)
+        self.disabled = disabled
+        self.disable_geoip = disable_geoip
+        self.historical_migration = historical_migration
+        self.enable_exception_autocapture = enable_exception_autocapture
+        self.exception_autocapture_integrations = exception_autocapture_integrations
+        self.exception_capture = None
 
+        # personal_api_key: This should be a generated Personal API Key, private
+        self.personal_api_key = personal_api_key
         if debug:
+            # Ensures that debug level messages are logged when debug mode is on.
+            # Otherwise, defaults to WARNING level. See https://docs.python.org/3/howto/logging.html#what-happens-if-no-configuration-is-provided
+            logging.basicConfig()
             self.log.setLevel(logging.DEBUG)
+        else:
+            self.log.setLevel(logging.WARNING)
+
+        if self.enable_exception_autocapture:
+            self.exception_capture = ExceptionCapture(self, integrations=self.exception_autocapture_integrations)
 
         if sync_mode:
             self.consumers = None
@@ -58,9 +115,16 @@ class Client(object):
             for n in range(thread):
                 self.consumers = []
                 consumer = Consumer(
-                    self.queue, api_key, host=host, on_error=on_error,
-                    flush_at=flush_at, flush_interval=flush_interval,
-                    gzip=gzip, retries=max_retries, timeout=timeout,
+                    self.queue,
+                    self.api_key,
+                    host=self.host,
+                    on_error=on_error,
+                    flush_at=flush_at,
+                    flush_interval=flush_interval,
+                    gzip=gzip,
+                    retries=max_retries,
+                    timeout=timeout,
+                    historical_migration=historical_migration,
                 )
                 self.consumers.append(consumer)
 
@@ -68,181 +132,334 @@ class Client(object):
                 if send:
                     consumer.start()
 
-    def identify(self, distinct_id=None, properties=None, context=None, timestamp=None,
-                message_id=None):
+    def identify(self, distinct_id=None, properties=None, context=None, timestamp=None, uuid=None, disable_geoip=None):
         properties = properties or {}
         context = context or {}
-        require('distinct_id', distinct_id, ID_TYPES)
-        require('properties', properties, dict)
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("properties", properties, dict)
 
         msg = {
-            'timestamp': timestamp,
-            'context': context,
-            'type': 'identify',
-            'distinct_id': distinct_id,
-            '$set': properties,
-            'event': '$identify',
-            'messageId': message_id,
+            "timestamp": timestamp,
+            "context": context,
+            "distinct_id": distinct_id,
+            "$set": properties,
+            "event": "$identify",
+            "uuid": uuid,
         }
 
-        return self._enqueue(msg)
+        return self._enqueue(msg, disable_geoip)
 
-    def capture(self, distinct_id=None, event=None, properties=None, context=None,
-              timestamp=None, message_id=None):
+    def get_feature_variants(
+        self, distinct_id, groups=None, person_properties=None, group_properties=None, disable_geoip=None
+    ):
+        resp_data = self.get_decide(distinct_id, groups, person_properties, group_properties, disable_geoip)
+        return resp_data["featureFlags"]
+
+    def get_feature_payloads(
+        self, distinct_id, groups=None, person_properties=None, group_properties=None, disable_geoip=None
+    ):
+        resp_data = self.get_decide(distinct_id, groups, person_properties, group_properties, disable_geoip)
+        return resp_data["featureFlagPayloads"]
+
+    def get_decide(self, distinct_id, groups=None, person_properties=None, group_properties=None, disable_geoip=None):
+        require("distinct_id", distinct_id, ID_TYPES)
+
+        if disable_geoip is None:
+            disable_geoip = self.disable_geoip
+
+        if groups:
+            require("groups", groups, dict)
+        else:
+            groups = {}
+
+        request_data = {
+            "distinct_id": distinct_id,
+            "groups": groups,
+            "person_properties": person_properties,
+            "group_properties": group_properties,
+            "disable_geoip": disable_geoip,
+        }
+        resp_data = decide(self.api_key, self.host, timeout=self.feature_flags_request_timeout_seconds, **request_data)
+
+        return resp_data
+
+    def capture(
+        self,
+        distinct_id=None,
+        event=None,
+        properties=None,
+        context=None,
+        timestamp=None,
+        uuid=None,
+        groups=None,
+        send_feature_flags=False,
+        disable_geoip=None,
+    ):
         properties = properties or {}
         context = context or {}
-        require('distinct_id', distinct_id, ID_TYPES)
-        require('properties', properties, dict)
-        require('event', event, string_types)
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("properties", properties, dict)
+        require("event", event, string_types)
 
         msg = {
-            'properties': properties,
-            'timestamp': timestamp,
-            'context': context,
-            'distinct_id': distinct_id,
-            'type': 'capture',
-            'event': event,
-            'messageId': message_id,
+            "properties": properties,
+            "timestamp": timestamp,
+            "context": context,
+            "distinct_id": distinct_id,
+            "event": event,
+            "uuid": uuid,
         }
 
-        return self._enqueue(msg)
+        if groups:
+            require("groups", groups, dict)
+            msg["properties"]["$groups"] = groups
 
-    def alias(self, previous_id=None, distinct_id=None, context=None,
-              timestamp=None, message_id=None):
+        extra_properties = {}
+        feature_variants = {}
+        if send_feature_flags:
+            try:
+                feature_variants = self.get_feature_variants(distinct_id, groups, disable_geoip=disable_geoip)
+            except Exception as e:
+                self.log.exception(f"[FEATURE FLAGS] Unable to get feature variants: {e}")
+
+        elif self.feature_flags:
+            # Local evaluation is enabled, flags are loaded, so try and get all flags we can without going to the server
+            feature_variants = self.get_all_flags(
+                distinct_id, groups=(groups or {}), disable_geoip=disable_geoip, only_evaluate_locally=True
+            )
+
+        for feature, variant in feature_variants.items():
+            extra_properties[f"$feature/{feature}"] = variant
+
+        active_feature_flags = [key for (key, value) in feature_variants.items() if value is not False]
+        if active_feature_flags:
+            extra_properties["$active_feature_flags"] = active_feature_flags
+
+        if extra_properties:
+            msg["properties"] = {**extra_properties, **msg["properties"]}
+
+        return self._enqueue(msg, disable_geoip)
+
+    def set(self, distinct_id=None, properties=None, context=None, timestamp=None, uuid=None, disable_geoip=None):
+        properties = properties or {}
         context = context or {}
-
-        require('previous_id', previous_id, ID_TYPES)
-        require('distinct_id', distinct_id, ID_TYPES)
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("properties", properties, dict)
 
         msg = {
-            'properties': {
-                'distinct_id': previous_id,
-                'alias': distinct_id,
+            "timestamp": timestamp,
+            "context": context,
+            "distinct_id": distinct_id,
+            "$set": properties,
+            "event": "$set",
+            "uuid": uuid,
+        }
+
+        return self._enqueue(msg, disable_geoip)
+
+    def set_once(self, distinct_id=None, properties=None, context=None, timestamp=None, uuid=None, disable_geoip=None):
+        properties = properties or {}
+        context = context or {}
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("properties", properties, dict)
+
+        msg = {
+            "timestamp": timestamp,
+            "context": context,
+            "distinct_id": distinct_id,
+            "$set_once": properties,
+            "event": "$set_once",
+            "uuid": uuid,
+        }
+
+        return self._enqueue(msg, disable_geoip)
+
+    def group_identify(
+        self,
+        group_type=None,
+        group_key=None,
+        properties=None,
+        context=None,
+        timestamp=None,
+        uuid=None,
+        disable_geoip=None,
+    ):
+        properties = properties or {}
+        context = context or {}
+        require("group_type", group_type, ID_TYPES)
+        require("group_key", group_key, ID_TYPES)
+        require("properties", properties, dict)
+
+        msg = {
+            "event": "$groupidentify",
+            "properties": {
+                "$group_type": group_type,
+                "$group_key": group_key,
+                "$group_set": properties,
             },
-            'timestamp': timestamp,
-            'context': context,
-            'type': 'alias',
-            'event': '$create_alias'
+            "distinct_id": "${}_{}".format(group_type, group_key),
+            "timestamp": timestamp,
+            "context": context,
+            "uuid": uuid,
         }
 
-        return self._enqueue(msg)
+        return self._enqueue(msg, disable_geoip)
 
-    def group(self, distinct_id=None, group_id=None, traits=None, context=None,
-              timestamp=None, message_id=None):
-        traits = traits or {}
+    def alias(self, previous_id=None, distinct_id=None, context=None, timestamp=None, uuid=None, disable_geoip=None):
         context = context or {}
 
-        require('distinct_id', distinct_id, ID_TYPES)
-        require('group_id', group_id, ID_TYPES)
-        require('traits', traits, dict)
+        require("previous_id", previous_id, ID_TYPES)
+        require("distinct_id", distinct_id, ID_TYPES)
 
         msg = {
-            'timestamp': timestamp,
-            'groupId': group_id,
-            'context': context,
-            'distinct_id': distinct_id,
-            'traits': traits,
-            'type': 'group',
-            'messageId': message_id,
+            "properties": {
+                "distinct_id": previous_id,
+                "alias": distinct_id,
+            },
+            "timestamp": timestamp,
+            "context": context,
+            "event": "$create_alias",
+            "distinct_id": previous_id,
         }
 
-        return self._enqueue(msg)
+        return self._enqueue(msg, disable_geoip)
 
-    def page(self, distinct_id=None, category=None, name=None, properties=None,
-            context=None, timestamp=None, message_id=None):
+    def page(
+        self, distinct_id=None, url=None, properties=None, context=None, timestamp=None, uuid=None, disable_geoip=None
+    ):
         properties = properties or {}
         context = context or {}
 
-        require('distinct_id', distinct_id, ID_TYPES)
-        require('properties', properties, dict)
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("properties", properties, dict)
 
-        if name:
-            require('name', name, string_types)
-        if category:
-            require('category', category, string_types)
+        require("url", url, string_types)
+        properties["$current_url"] = url
 
         msg = {
-            'properties': properties,
-            'timestamp': timestamp,
-            'category': category,
-            'context': context,
-            'distinct_id': distinct_id,
-            'type': 'page',
-            'name': name,
-            'messageId': message_id,
+            "event": "$pageview",
+            "properties": properties,
+            "timestamp": timestamp,
+            "context": context,
+            "distinct_id": distinct_id,
+            "uuid": uuid,
         }
 
-        return self._enqueue(msg)
+        return self._enqueue(msg, disable_geoip)
 
-    def screen(self, distinct_id=None, category=None, name=None, properties=None,
-               context=None, timestamp=None, message_id=None):
-        properties = properties or {}
-        context = context or {}
+    def capture_exception(
+        self,
+        exception=None,
+        distinct_id=DEFAULT_DISTINCT_ID,
+        properties=None,
+        context=None,
+        timestamp=None,
+        uuid=None,
+        groups=None,
+    ):
+        # this function shouldn't ever throw an error, so it logs exceptions instead of raising them.
+        # this is important to ensure we don't unexpectedly re-raise exceptions in the user's code.
+        try:
+            properties = properties or {}
+            require("distinct_id", distinct_id, ID_TYPES)
+            require("properties", properties, dict)
 
-        require('distinct_id', distinct_id, ID_TYPES)
-        require('properties', properties, dict)
+            if exception is not None:
+                exc_info = exc_info_from_error(exception)
+            else:
+                exc_info = sys.exc_info()
 
-        if name:
-            require('name', name, string_types)
-        if category:
-            require('category', category, string_types)
+            if exc_info is None or exc_info == (None, None, None):
+                self.log.warning("No exception information available")
+                return
 
-        msg = {
+            # Format stack trace like sentry
+            all_exceptions_with_trace = exceptions_from_error_tuple(exc_info)
 
-            'properties': properties,
-            'timestamp': timestamp,
-            'category': category,
-            'context': context,
-            'distinct_id': distinct_id,
-            'type': 'screen',
-            'name': name,
-            'messageId': message_id,
-        }
+            # Add in-app property to frames in the exceptions
+            event = handle_in_app(
+                {
+                    "exception": {
+                        "values": all_exceptions_with_trace,
+                    },
+                }
+            )
+            all_exceptions_with_trace_and_in_app = event["exception"]["values"]
 
-        return self._enqueue(msg)
+            properties = {
+                "$exception_type": all_exceptions_with_trace_and_in_app[0].get("type"),
+                "$exception_message": all_exceptions_with_trace_and_in_app[0].get("value"),
+                "$exception_list": all_exceptions_with_trace_and_in_app,
+                "$exception_personURL": f"{remove_trailing_slash(self.raw_host)}/project/{self.api_key}/person/{distinct_id}",
+                **properties,
+            }
 
-    def _enqueue(self, msg):
+            return self.capture(distinct_id, "$exception", properties, context, timestamp, uuid, groups)
+        except Exception as e:
+            self.log.exception(f"Failed to capture exception: {e}")
+
+    def _enqueue(self, msg, disable_geoip):
         """Push a new `msg` onto the queue, return `(success, msg)`"""
-        timestamp = msg['timestamp']
+
+        if self.disabled:
+            return False, "disabled"
+
+        timestamp = msg["timestamp"]
         if timestamp is None:
             timestamp = datetime.utcnow().replace(tzinfo=tzutc())
-        message_id = msg.get('messageId')
-        if message_id is None:
-            message_id = uuid4()
 
-        require('type', msg['type'], string_types)
-        require('timestamp', timestamp, datetime)
-        require('context', msg['context'], dict)
+        require("timestamp", timestamp, datetime)
+        require("context", msg["context"], dict)
 
         # add common
         timestamp = guess_timezone(timestamp)
-        msg['timestamp'] = timestamp.isoformat()
-        msg['messageId'] = stringify_id(message_id)
-        msg['library'] = 'posthog-python'
-        msg['library_version'] = VERSION
+        msg["timestamp"] = timestamp.isoformat()
 
-        msg['distinct_id'] = stringify_id(msg.get('distinct_id', None))
+        # only send if "uuid" is truthy
+        if "uuid" in msg:
+            uuid = msg.pop("uuid")
+            if uuid:
+                msg["uuid"] = stringify_id(uuid)
+
+        if not msg.get("properties"):
+            msg["properties"] = {}
+        msg["properties"]["$lib"] = "posthog-python"
+        msg["properties"]["$lib_version"] = VERSION
+
+        if disable_geoip is None:
+            disable_geoip = self.disable_geoip
+
+        if disable_geoip:
+            msg["properties"]["$geoip_disable"] = True
+
+        msg["distinct_id"] = stringify_id(msg.get("distinct_id", None))
 
         msg = clean(msg)
-        self.log.debug('queueing: %s', msg)
+        self.log.debug("queueing: %s", msg)
 
         # if send is False, return msg as if it was successfully queued
         if not self.send:
             return True, msg
 
         if self.sync_mode:
-            self.log.debug('enqueued with blocking %s.', msg['type'])
-            post(self.api_key, self.host, gzip=self.gzip,
-                 timeout=self.timeout, batch=[msg])
+            self.log.debug("enqueued with blocking %s.", msg["event"])
+            batch_post(
+                self.api_key,
+                self.host,
+                gzip=self.gzip,
+                timeout=self.timeout,
+                batch=[msg],
+                historical_migration=self.historical_migration,
+            )
 
             return True, msg
 
         try:
             self.queue.put(msg, block=False)
-            self.log.debug('enqueued %s.', msg['type'])
+            self.log.debug("enqueued %s.", msg["event"])
             return True, msg
         except queue.Full:
-            self.log.warning('analytics-python queue is full')
+            self.log.warning("analytics-python queue is full")
             return False, msg
 
     def flush(self):
@@ -251,7 +468,7 @@ class Client(object):
         size = queue.qsize()
         queue.join()
         # Note that this message may not be precise, because of threading.
-        self.log.debug('successfully flushed about %s items.', size)
+        self.log.debug("successfully flushed about %s items.", size)
 
     def join(self):
         """Ends the consumer thread once the queue is empty.
@@ -265,16 +482,393 @@ class Client(object):
                 # consumer thread has not started
                 pass
 
+        if self.poller:
+            self.poller.stop()
+
     def shutdown(self):
         """Flush all messages and cleanly shutdown the client"""
         self.flush()
         self.join()
 
+        if self.exception_capture:
+            self.exception_capture.close()
+
+    def _load_feature_flags(self):
+        try:
+            response = get(
+                self.personal_api_key,
+                f"/api/feature_flag/local_evaluation/?token={self.api_key}&send_cohorts",
+                self.host,
+                timeout=10,
+            )
+
+            self.feature_flags = response["flags"] or []
+            self.feature_flags_by_key = {
+                flag["key"]: flag for flag in self.feature_flags if flag.get("key") is not None
+            }
+            self.group_type_mapping = response["group_type_mapping"] or {}
+            self.cohorts = response["cohorts"] or {}
+
+        except APIError as e:
+            if e.status == 401:
+                self.log.error(
+                    "[FEATURE FLAGS] Error loading feature flags: To use feature flags, please set a valid personal_api_key. More information: https://posthog.com/docs/api/overview"
+                )
+                if self.debug:
+                    raise APIError(
+                        status=401,
+                        message="You are using a write-only key with feature flags. "
+                        "To use feature flags, please set a personal_api_key "
+                        "More information: https://posthog.com/docs/api/overview",
+                    )
+            else:
+                self.log.error(f"[FEATURE FLAGS] Error loading feature flags: {e}")
+        except Exception as e:
+            self.log.warning(
+                "[FEATURE FLAGS] Fetching feature flags failed with following error. We will retry in %s seconds."
+                % self.poll_interval
+            )
+            self.log.warning(e)
+
+        self._last_feature_flag_poll = datetime.utcnow().replace(tzinfo=tzutc())
+
+    def load_feature_flags(self):
+        if not self.personal_api_key:
+            self.log.warning("[FEATURE FLAGS] You have to specify a personal_api_key to use feature flags.")
+            self.feature_flags = []
+            return
+
+        self._load_feature_flags()
+        if not (self.poller and self.poller.is_alive()):
+            self.poller = Poller(interval=timedelta(seconds=self.poll_interval), execute=self._load_feature_flags)
+            self.poller.start()
+
+    def _compute_flag_locally(
+        self,
+        feature_flag,
+        distinct_id,
+        *,
+        groups={},
+        person_properties={},
+        group_properties={},
+        warn_on_unknown_groups=True,
+    ):
+        if feature_flag.get("ensure_experience_continuity", False):
+            raise InconclusiveMatchError("Flag has experience continuity enabled")
+
+        if not feature_flag.get("active"):
+            return False
+
+        flag_filters = feature_flag.get("filters") or {}
+        aggregation_group_type_index = flag_filters.get("aggregation_group_type_index")
+        if aggregation_group_type_index is not None:
+            group_name = self.group_type_mapping.get(str(aggregation_group_type_index))
+
+            if not group_name:
+                self.log.warning(
+                    f"[FEATURE FLAGS] Unknown group type index {aggregation_group_type_index} for feature flag {feature_flag['key']}"
+                )
+                # failover to `/decide/`
+                raise InconclusiveMatchError("Flag has unknown group type index")
+
+            if group_name not in groups:
+                # Group flags are never enabled in `groups` aren't passed in
+                # don't failover to `/decide/`, since response will be the same
+                if warn_on_unknown_groups:
+                    self.log.warning(
+                        f"[FEATURE FLAGS] Can't compute group feature flag: {feature_flag['key']} without group names passed in"
+                    )
+                else:
+                    self.log.debug(
+                        f"[FEATURE FLAGS] Can't compute group feature flag: {feature_flag['key']} without group names passed in"
+                    )
+                return False
+
+            focused_group_properties = group_properties[group_name]
+            return match_feature_flag_properties(feature_flag, groups[group_name], focused_group_properties)
+        else:
+            return match_feature_flag_properties(feature_flag, distinct_id, person_properties, self.cohorts)
+
+    def feature_enabled(
+        self,
+        key,
+        distinct_id,
+        *,
+        groups={},
+        person_properties={},
+        group_properties={},
+        only_evaluate_locally=False,
+        send_feature_flag_events=True,
+        disable_geoip=None,
+    ):
+        response = self.get_feature_flag(
+            key,
+            distinct_id,
+            groups=groups,
+            person_properties=person_properties,
+            group_properties=group_properties,
+            only_evaluate_locally=only_evaluate_locally,
+            send_feature_flag_events=send_feature_flag_events,
+            disable_geoip=disable_geoip,
+        )
+
+        if response is None:
+            return None
+        return bool(response)
+
+    def get_feature_flag(
+        self,
+        key,
+        distinct_id,
+        *,
+        groups={},
+        person_properties={},
+        group_properties={},
+        only_evaluate_locally=False,
+        send_feature_flag_events=True,
+        disable_geoip=None,
+    ):
+        require("key", key, string_types)
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("groups", groups, dict)
+
+        if self.disabled:
+            return None
+
+        person_properties, group_properties = self._add_local_person_and_group_properties(
+            distinct_id, groups, person_properties, group_properties
+        )
+
+        if self.feature_flags is None and self.personal_api_key:
+            self.load_feature_flags()
+        response = None
+
+        # If loading in previous line failed
+        if self.feature_flags:
+            for flag in self.feature_flags:
+                if flag["key"] == key:
+                    try:
+                        response = self._compute_flag_locally(
+                            flag,
+                            distinct_id,
+                            groups=groups,
+                            person_properties=person_properties,
+                            group_properties=group_properties,
+                        )
+                        self.log.debug(f"Successfully computed flag locally: {key} -> {response}")
+                    except InconclusiveMatchError as e:
+                        self.log.debug(f"Failed to compute flag {key} locally: {e}")
+                        continue
+                    except Exception as e:
+                        self.log.exception(f"[FEATURE FLAGS] Error while computing variant locally: {e}")
+                        continue
+
+        flag_was_locally_evaluated = response is not None
+        if not flag_was_locally_evaluated and not only_evaluate_locally:
+            try:
+                feature_flags = self.get_feature_variants(
+                    distinct_id,
+                    groups=groups,
+                    person_properties=person_properties,
+                    group_properties=group_properties,
+                    disable_geoip=disable_geoip,
+                )
+                response = feature_flags.get(key)
+                if response is None:
+                    response = False
+                self.log.debug(f"Successfully computed flag remotely: #{key} -> #{response}")
+            except Exception as e:
+                self.log.exception(f"[FEATURE FLAGS] Unable to get flag remotely: {e}")
+
+        feature_flag_reported_key = f"{key}_{str(response)}"
+        if (
+            feature_flag_reported_key not in self.distinct_ids_feature_flags_reported[distinct_id]
+            and send_feature_flag_events  # noqa: W503
+        ):
+            self.capture(
+                distinct_id,
+                "$feature_flag_called",
+                {
+                    "$feature_flag": key,
+                    "$feature_flag_response": response,
+                    "locally_evaluated": flag_was_locally_evaluated,
+                    f"$feature/{key}": response,
+                },
+                groups=groups,
+                disable_geoip=disable_geoip,
+            )
+            self.distinct_ids_feature_flags_reported[distinct_id].add(feature_flag_reported_key)
+        return response
+
+    def get_feature_flag_payload(
+        self,
+        key,
+        distinct_id,
+        *,
+        match_value=None,
+        groups={},
+        person_properties={},
+        group_properties={},
+        only_evaluate_locally=False,
+        send_feature_flag_events=True,
+        disable_geoip=None,
+    ):
+        if self.disabled:
+            return None
+
+        if match_value is None:
+            match_value = self.get_feature_flag(
+                key,
+                distinct_id,
+                groups=groups,
+                person_properties=person_properties,
+                group_properties=group_properties,
+                send_feature_flag_events=send_feature_flag_events,
+                only_evaluate_locally=True,
+                disable_geoip=disable_geoip,
+            )
+
+        response = None
+
+        if match_value is not None:
+            response = self._compute_payload_locally(key, match_value)
+
+        if response is None and not only_evaluate_locally:
+            decide_payloads = self.get_feature_payloads(
+                distinct_id, groups, person_properties, group_properties, disable_geoip
+            )
+            response = decide_payloads.get(str(key).lower(), None)
+
+        return response
+
+    def _compute_payload_locally(self, key, match_value):
+        payload = None
+
+        if self.feature_flags_by_key is None:
+            return payload
+
+        flag_definition = self.feature_flags_by_key.get(key) or {}
+        flag_filters = flag_definition.get("filters") or {}
+        flag_payloads = flag_filters.get("payloads") or {}
+        payload = flag_payloads.get(str(match_value).lower(), None)
+        return payload
+
+    def get_all_flags(
+        self,
+        distinct_id,
+        *,
+        groups={},
+        person_properties={},
+        group_properties={},
+        only_evaluate_locally=False,
+        disable_geoip=None,
+    ):
+        flags = self.get_all_flags_and_payloads(
+            distinct_id,
+            groups=groups,
+            person_properties=person_properties,
+            group_properties=group_properties,
+            only_evaluate_locally=only_evaluate_locally,
+            disable_geoip=disable_geoip,
+        )
+        return flags["featureFlags"]
+
+    def get_all_flags_and_payloads(
+        self,
+        distinct_id,
+        *,
+        groups={},
+        person_properties={},
+        group_properties={},
+        only_evaluate_locally=False,
+        disable_geoip=None,
+    ):
+        if self.disabled:
+            return {"featureFlags": None, "featureFlagPayloads": None}
+
+        person_properties, group_properties = self._add_local_person_and_group_properties(
+            distinct_id, groups, person_properties, group_properties
+        )
+
+        flags, payloads, fallback_to_decide = self._get_all_flags_and_payloads_locally(
+            distinct_id, groups=groups, person_properties=person_properties, group_properties=group_properties
+        )
+        response = {"featureFlags": flags, "featureFlagPayloads": payloads}
+
+        if fallback_to_decide and not only_evaluate_locally:
+            try:
+                flags_and_payloads = self.get_decide(
+                    distinct_id,
+                    groups=groups,
+                    person_properties=person_properties,
+                    group_properties=group_properties,
+                    disable_geoip=disable_geoip,
+                )
+                response = flags_and_payloads
+            except Exception as e:
+                self.log.exception(f"[FEATURE FLAGS] Unable to get feature flags and payloads: {e}")
+
+        return response
+
+    def _get_all_flags_and_payloads_locally(
+        self, distinct_id, *, groups={}, person_properties={}, group_properties={}, warn_on_unknown_groups=False
+    ):
+        require("distinct_id", distinct_id, ID_TYPES)
+        require("groups", groups, dict)
+
+        if self.feature_flags is None and self.personal_api_key:
+            self.load_feature_flags()
+
+        flags = {}
+        payloads = {}
+        fallback_to_decide = False
+        # If loading in previous line failed
+        if self.feature_flags:
+            for flag in self.feature_flags:
+                try:
+                    flags[flag["key"]] = self._compute_flag_locally(
+                        flag,
+                        distinct_id,
+                        groups=groups,
+                        person_properties=person_properties,
+                        group_properties=group_properties,
+                        warn_on_unknown_groups=warn_on_unknown_groups,
+                    )
+                    matched_payload = self._compute_payload_locally(flag["key"], flags[flag["key"]])
+                    if matched_payload:
+                        payloads[flag["key"]] = matched_payload
+                except InconclusiveMatchError:
+                    # No need to log this, since it's just telling us to fall back to `/decide`
+                    fallback_to_decide = True
+                except Exception as e:
+                    self.log.exception(f"[FEATURE FLAGS] Error while computing variant and payload: {e}")
+                    fallback_to_decide = True
+        else:
+            fallback_to_decide = True
+
+        return flags, payloads, fallback_to_decide
+
+    def feature_flag_definitions(self):
+        return self.feature_flags
+
+    def _add_local_person_and_group_properties(self, distinct_id, groups, person_properties, group_properties):
+        all_person_properties = {"distinct_id": distinct_id, **(person_properties or {})}
+
+        all_group_properties = {}
+        if groups:
+            for group_name in groups:
+                all_group_properties[group_name] = {
+                    "$group_key": groups[group_name],
+                    **(group_properties.get(group_name) or {}),
+                }
+
+        return all_person_properties, all_group_properties
+
 
 def require(name, field, data_type):
     """Require that the named `field` has the right `data_type`"""
     if not isinstance(field, data_type):
-        msg = '{0} must have {1}, got: {2}'.format(name, data_type, field)
+        msg = "{0} must have {1}, got: {2}".format(name, data_type, field)
         raise AssertionError(msg)
 
 

posthog/consumer.py

@@ -1,30 +1,43 @@
+import json
 import logging
 from threading import Thread
-import monotonic
-import backoff
-import json
 
-from posthog.request import post, APIError, DatetimeSerializer
+import backoff
+import monotonic
+
+from posthog.request import APIError, DatetimeSerializer, batch_post
 
 try:
     from queue import Empty
 except ImportError:
     from Queue import Empty
 
-MAX_MSG_SIZE = 32 << 10
 
-# Our servers only accept batches less than 500KB. Here limit is set slightly
-# lower to leave space for extra data that will be added later, eg. "sentAt".
-BATCH_SIZE_LIMIT = 475000
+MAX_MSG_SIZE = 900 * 1024  # 900KiB per event
+
+# The maximum request body size is currently 20MiB, let's be conservative
+# in case we want to lower it in the future.
+BATCH_SIZE_LIMIT = 5 * 1024 * 1024
 
 
 class Consumer(Thread):
     """Consumes the messages from the client's queue."""
-    log = logging.getLogger('posthog')
 
-    def __init__(self, queue, api_key, flush_at=100, host=None,
-                 on_error=None, flush_interval=0.5, gzip=False, retries=10,
-                 timeout=15):
+    log = logging.getLogger("posthog")
+
+    def __init__(
+        self,
+        queue,
+        api_key,
+        flush_at=100,
+        host=None,
+        on_error=None,
+        flush_interval=0.5,
+        gzip=False,
+        retries=10,
+        timeout=15,
+        historical_migration=False,
+    ):
         """Create a consumer thread."""
         Thread.__init__(self)
         # Make consumer a daemon thread so that it doesn't block program exit
@@ -43,14 +56,15 @@ class Consumer(Thread):
         self.running = True
         self.retries = retries
         self.timeout = timeout
+        self.historical_migration = historical_migration
 
     def run(self):
         """Runs the consumer."""
-        self.log.debug('consumer is running...')
+        self.log.debug("consumer is running...")
         while self.running:
             self.upload()
 
-        self.log.debug('consumer exited.')
+        self.log.debug("consumer exited.")
 
     def pause(self):
         """Pause the consumer."""
@@ -67,7 +81,7 @@ class Consumer(Thread):
             self.request(batch)
             success = True
         except Exception as e:
-            self.log.error('error uploading: %s', e)
+            self.log.error("error uploading: %s", e)
             success = False
             if self.on_error:
                 self.on_error(e, batch)
@@ -90,19 +104,15 @@ class Consumer(Thread):
             if elapsed >= self.flush_interval:
                 break
             try:
-                item = queue.get(
-                    block=True, timeout=self.flush_interval - elapsed)
-                item_size = len(json.dumps(
-                    item, cls=DatetimeSerializer).encode())
+                item = queue.get(block=True, timeout=self.flush_interval - elapsed)
+                item_size = len(json.dumps(item, cls=DatetimeSerializer).encode())
                 if item_size > MAX_MSG_SIZE:
-                    self.log.error(
-                        'Item exceeds 32kb limit, dropping. (%s)', str(item))
+                    self.log.error("Item exceeds 900kib limit, dropping. (%s)", str(item))
                     continue
                 items.append(item)
                 total_size += item_size
                 if total_size >= BATCH_SIZE_LIMIT:
-                    self.log.debug(
-                        'hit batch size limit (size: %d)', total_size)
+                    self.log.debug("hit batch size limit (size: %d)", total_size)
                     break
             except Empty:
                 break
@@ -110,25 +120,29 @@ class Consumer(Thread):
         return items
 
     def request(self, batch):
-        """Attempt to upload the batch and retry before raising an error """
+        """Attempt to upload the batch and retry before raising an error"""
 
         def fatal_exception(exc):
             if isinstance(exc, APIError):
                 # retry on server errors and client errors
                 # with 429 status code (rate limited),
                 # don't retry on other client errors
+                if exc.status == "N/A":
+                    return False
                 return (400 <= exc.status < 500) and exc.status != 429
             else:
                 # retry on all other errors (eg. network)
                 return False
 
-        @backoff.on_exception(
-            backoff.expo,
-            Exception,
-            max_tries=self.retries + 1,
-            giveup=fatal_exception)
+        @backoff.on_exception(backoff.expo, Exception, max_tries=self.retries + 1, giveup=fatal_exception)
         def send_request():
-            post(self.api_key, self.host, gzip=self.gzip,
-                 timeout=self.timeout, batch=batch)
+            batch_post(
+                self.api_key,
+                self.host,
+                gzip=self.gzip,
+                timeout=self.timeout,
+                batch=batch,
+                historical_migration=self.historical_migration,
+            )
 
         send_request()

posthog/exception_capture.py

@@ -0,0 +1,74 @@
+import logging
+import sys
+import threading
+from enum import Enum
+from typing import TYPE_CHECKING, List, Optional
+
+if TYPE_CHECKING:
+    from posthog.client import Client
+
+
+class Integrations(str, Enum):
+    Django = "django"
+
+
+DEFAULT_DISTINCT_ID = "python-exceptions"
+
+
+class ExceptionCapture:
+    # TODO: Add client side rate limiting to prevent spamming the server with exceptions
+
+    log = logging.getLogger("posthog")
+
+    def __init__(self, client: "Client", integrations: Optional[List[Integrations]] = None):
+        self.client = client
+        self.original_excepthook = sys.excepthook
+        sys.excepthook = self.exception_handler
+        threading.excepthook = self.thread_exception_handler
+        self.enabled_integrations = []
+
+        for integration in integrations or []:
+            # TODO: Maybe find a better way of enabling integrations
+            # This is very annoying currently if we had to add any configuration per integration
+            if integration == Integrations.Django:
+                try:
+                    from posthog.exception_integrations.django import DjangoIntegration
+
+                    enabled_integration = DjangoIntegration(self.exception_receiver)
+                    self.enabled_integrations.append(enabled_integration)
+                except Exception as e:
+                    self.log.exception(f"Failed to enable Django integration: {e}")
+
+    def close(self):
+        sys.excepthook = self.original_excepthook
+        for integration in self.enabled_integrations:
+            integration.uninstall()
+
+    def exception_handler(self, exc_type, exc_value, exc_traceback):
+        # don't affect default behaviour.
+        self.capture_exception((exc_type, exc_value, exc_traceback))
+        self.original_excepthook(exc_type, exc_value, exc_traceback)
+
+    def thread_exception_handler(self, args):
+        self.capture_exception((args.exc_type, args.exc_value, args.exc_traceback))
+
+    def exception_receiver(self, exc_info, extra_properties):
+        if "distinct_id" in extra_properties:
+            metadata = {"distinct_id": extra_properties["distinct_id"]}
+        else:
+            metadata = None
+        self.capture_exception(exc_info[0], exc_info[1], exc_info[2], metadata)
+
+    def capture_exception(self, exception, metadata=None):
+        try:
+            # if hasattr(sys, "ps1"):
+            #     # Disable the excepthook for interactive Python shells
+            #     return
+
+            distinct_id = metadata.get("distinct_id") if metadata else DEFAULT_DISTINCT_ID
+            # Make sure we have a distinct_id if its empty in metadata
+            distinct_id = distinct_id or DEFAULT_DISTINCT_ID
+
+            self.client.capture_exception(exception, distinct_id)
+        except Exception as e:
+            self.log.exception(f"Failed to capture exception: {e}")

posthog/exception_integrations/__init__.py

@@ -0,0 +1,5 @@
+class IntegrationEnablingError(Exception):
+    """
+    The integration could not be enabled due to a user error like
+    `django` not being installed for the `DjangoIntegration`.
+    """

posthog/exception_integrations/django.py

@@ -0,0 +1,88 @@
+import re
+import sys
+from typing import TYPE_CHECKING
+
+from posthog.exception_integrations import IntegrationEnablingError
+
+try:
+    from django import VERSION as DJANGO_VERSION
+    from django.core import signals
+
+except ImportError:
+    raise IntegrationEnablingError("Django not installed")
+
+
+if TYPE_CHECKING:
+    from typing import Any, Dict  # noqa: F401
+
+    from django.core.handlers.wsgi import WSGIRequest  # noqa: F401
+
+
+class DjangoIntegration:
+    # TODO: Abstract integrations one we have more and can see patterns
+    """
+    Autocapture errors from a Django application.
+    """
+
+    identifier = "django"
+
+    def __init__(self, capture_exception_fn=None):
+
+        if DJANGO_VERSION < (4, 2):
+            raise IntegrationEnablingError("Django 4.2 or newer is required.")
+
+        # TODO: Right now this seems too complicated / overkill for us, but seems like we can automatically plug in middlewares
+        # which is great for users (they don't need to do this) and everything should just work.
+        # We should consider this in the future, but for now we can just use the middleware and signals handlers.
+        # See: https://github.com/getsentry/sentry-python/blob/269d96d6e9821122fbff280e6a26956e5ed03c0b/sentry_sdk/integrations/django/__init__.py
+
+        self.capture_exception_fn = capture_exception_fn
+
+        def _got_request_exception(request=None, **kwargs):
+            # type: (WSGIRequest, **Any) -> None
+
+            extra_props = {}
+            if request is not None:
+                # get headers metadata
+                extra_props = DjangoRequestExtractor(request).extract_person_data()
+
+            self.capture_exception_fn(sys.exc_info(), extra_props)
+
+        signals.got_request_exception.connect(_got_request_exception)
+
+    def uninstall(self):
+        pass
+
+
+class DjangoRequestExtractor:
+
+    def __init__(self, request):
+        # type: (Any) -> None
+        self.request = request
+
+    def extract_person_data(self):
+        headers = self.headers()
+
+        # Extract traceparent and tracestate headers
+        traceparent = headers.get("traceparent")
+        tracestate = headers.get("tracestate")
+
+        # Extract the distinct_id from tracestate
+        distinct_id = None
+        if tracestate:
+            # TODO: Align on the format of the distinct_id in tracestate
+            # We can't have comma or equals in header values here, so maybe we should base64 encode it?
+            match = re.search(r"posthog-distinct-id=([^,]+)", tracestate)
+            if match:
+                distinct_id = match.group(1)
+
+        return {
+            "distinct_id": distinct_id,
+            "ip": headers.get("X-Forwarded-For"),
+            "user_agent": headers.get("User-Agent"),
+            "traceparent": traceparent,
+        }
+
+    def headers(self):
+        # type: () -> Dict[str, str]
+        return dict(self.request.headers)

posthog/exception_utils.py

@@ -0,0 +1,872 @@
+# copied and adapted from https://github.com/getsentry/sentry-python/blob/269d96d6e9821122fbff280e6a26956e5ed03c0b/sentry_sdk/utils.py#L689
+# 💖open source (under MIT License)
+# We want to keep payloads as similar to Sentry as possible for easy interoperability
+
+import linecache
+import os
+import re
+import sys
+from datetime import datetime
+from typing import TYPE_CHECKING
+
+try:
+    # Python 3.11
+    from builtins import BaseExceptionGroup
+except ImportError:
+    # Python 3.10 and below
+    BaseExceptionGroup = None  # type: ignore
+
+
+DEFAULT_MAX_VALUE_LENGTH = 1024
+
+
+if TYPE_CHECKING:
+
+    from types import FrameType, TracebackType
+    from typing import (  # noqa: F401
+        Any,
+        Callable,
+        Dict,
+        Iterator,
+        List,
+        Literal,
+        Optional,
+        Set,
+        Tuple,
+        Type,
+        TypedDict,
+        TypeVar,
+        Union,
+        cast,
+    )
+
+    ExcInfo = Union[
+        Tuple[Type[BaseException], BaseException, Optional[TracebackType]],
+        Tuple[None, None, None],
+    ]
+    LogLevelStr = Literal["fatal", "critical", "error", "warning", "info", "debug"]
+
+    Event = TypedDict(
+        "Event",
+        {
+            "breadcrumbs": Dict[Literal["values"], List[Dict[str, Any]]],  # TODO: We can expand on this type
+            "check_in_id": str,
+            "contexts": Dict[str, Dict[str, object]],
+            "dist": str,
+            "duration": Optional[float],
+            "environment": str,
+            "errors": List[Dict[str, Any]],  # TODO: We can expand on this type
+            "event_id": str,
+            "exception": Dict[Literal["values"], List[Dict[str, Any]]],  # TODO: We can expand on this type
+            # "extra": MutableMapping[str, object],
+            # "fingerprint": List[str],
+            "level": LogLevelStr,
+            # "logentry": Mapping[str, object],
+            "logger": str,
+            # "measurements": Dict[str, MeasurementValue],
+            "message": str,
+            "modules": Dict[str, str],
+            # "monitor_config": Mapping[str, object],
+            "monitor_slug": Optional[str],
+            "platform": Literal["python"],
+            "profile": object,  # Should be sentry_sdk.profiler.Profile, but we can't import that here due to circular imports
+            "release": str,
+            "request": Dict[str, object],
+            # "sdk": Mapping[str, object],
+            "server_name": str,
+            "spans": List[Dict[str, object]],
+            "stacktrace": Dict[str, object],  # We access this key in the code, but I am unsure whether we ever set it
+            "start_timestamp": datetime,
+            "status": Optional[str],
+            # "tags": MutableMapping[
+            #     str, str
+            # ],  # Tags must be less than 200 characters each
+            "threads": Dict[Literal["values"], List[Dict[str, Any]]],  # TODO: We can expand on this type
+            "timestamp": Optional[datetime],  # Must be set before sending the event
+            "transaction": str,
+            # "transaction_info": Mapping[str, Any],  # TODO: We can expand on this type
+            "type": Literal["check_in", "transaction"],
+            "user": Dict[str, object],
+            "_metrics_summary": Dict[str, object],
+        },
+        total=False,
+    )
+
+
+epoch = datetime(1970, 1, 1)
+
+
+BASE64_ALPHABET = re.compile(r"^[a-zA-Z0-9/+=]*$")
+
+SENSITIVE_DATA_SUBSTITUTE = "[Filtered]"
+
+
+def to_timestamp(value):
+    # type: (datetime) -> float
+    return (value - epoch).total_seconds()
+
+
+def format_timestamp(value):
+    # type: (datetime) -> str
+    return value.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+
+
+def event_hint_with_exc_info(exc_info=None):
+    # type: (Optional[ExcInfo]) -> Dict[str, Optional[ExcInfo]]
+    """Creates a hint with the exc info filled in."""
+    if exc_info is None:
+        exc_info = sys.exc_info()
+    else:
+        exc_info = exc_info_from_error(exc_info)
+    if exc_info[0] is None:
+        exc_info = None
+    return {"exc_info": exc_info}
+
+
+class AnnotatedValue:
+    """
+    Meta information for a data field in the event payload.
+    This is to tell Relay that we have tampered with the fields value.
+    See:
+    https://github.com/getsentry/relay/blob/be12cd49a0f06ea932ed9b9f93a655de5d6ad6d1/relay-general/src/types/meta.rs#L407-L423
+    """
+
+    __slots__ = ("value", "metadata")
+
+    def __init__(self, value, metadata):
+        # type: (Optional[Any], Dict[str, Any]) -> None
+        self.value = value
+        self.metadata = metadata
+
+    def __eq__(self, other):
+        # type: (Any) -> bool
+        if not isinstance(other, AnnotatedValue):
+            return False
+
+        return self.value == other.value and self.metadata == other.metadata
+
+    @classmethod
+    def removed_because_raw_data(cls):
+        # type: () -> AnnotatedValue
+        """The value was removed because it could not be parsed. This is done for request body values that are not json nor a form."""
+        return AnnotatedValue(
+            value="",
+            metadata={
+                "rem": [  # Remark
+                    [
+                        "!raw",  # Unparsable raw data
+                        "x",  # The fields original value was removed
+                    ]
+                ]
+            },
+        )
+
+    @classmethod
+    def removed_because_over_size_limit(cls):
+        # type: () -> AnnotatedValue
+        """The actual value was removed because the size of the field exceeded the configured maximum size (specified with the max_request_body_size sdk option)"""
+        return AnnotatedValue(
+            value="",
+            metadata={
+                "rem": [  # Remark
+                    [
+                        "!config",  # Because of configured maximum size
+                        "x",  # The fields original value was removed
+                    ]
+                ]
+            },
+        )
+
+    @classmethod
+    def substituted_because_contains_sensitive_data(cls):
+        # type: () -> AnnotatedValue
+        """The actual value was removed because it contained sensitive information."""
+        return AnnotatedValue(
+            value=SENSITIVE_DATA_SUBSTITUTE,
+            metadata={
+                "rem": [  # Remark
+                    [
+                        "!config",  # Because of SDK configuration (in this case the config is the hard coded removal of certain django cookies)
+                        "s",  # The fields original value was substituted
+                    ]
+                ]
+            },
+        )
+
+
+if TYPE_CHECKING:
+    T = TypeVar("T")
+    Annotated = Union[AnnotatedValue, T]
+
+
+def get_type_name(cls):
+    # type: (Optional[type]) -> Optional[str]
+    return getattr(cls, "__qualname__", None) or getattr(cls, "__name__", None)
+
+
+def get_type_module(cls):
+    # type: (Optional[type]) -> Optional[str]
+    mod = getattr(cls, "__module__", None)
+    if mod not in (None, "builtins", "__builtins__"):
+        return mod
+    return None
+
+
+def should_hide_frame(frame: "FrameType") -> bool:
+    try:
+        mod = frame.f_globals["__name__"]
+        if mod.startswith("sentry_sdk."):
+            return True
+    except (AttributeError, KeyError):
+        pass
+
+    for flag_name in "__traceback_hide__", "__tracebackhide__":
+        try:
+            if frame.f_locals[flag_name]:
+                return True
+        except Exception:
+            pass
+
+    return False
+
+
+def iter_stacks(tb):
+    # type: (Optional[TracebackType]) -> Iterator[TracebackType]
+    tb_ = tb  # type: Optional[TracebackType]
+    while tb_ is not None:
+        if not should_hide_frame(tb_.tb_frame):
+            yield tb_
+        tb_ = tb_.tb_next
+
+
+def get_lines_from_file(
+    filename,  # type: str
+    lineno,  # type: int
+    max_length=None,  # type: Optional[int]
+    loader=None,  # type: Optional[Any]
+    module=None,  # type: Optional[str]
+):
+    # type: (...) -> Tuple[List[Annotated[str]], Optional[Annotated[str]], List[Annotated[str]]]
+    context_lines = 5
+    source = None
+    if loader is not None and hasattr(loader, "get_source"):
+        try:
+            source_str = loader.get_source(module)  # type: Optional[str]
+        except (ImportError, IOError):
+            source_str = None
+        if source_str is not None:
+            source = source_str.splitlines()
+
+    if source is None:
+        try:
+            source = linecache.getlines(filename)
+        except (OSError, IOError):
+            return [], None, []
+
+    if not source:
+        return [], None, []
+
+    lower_bound = max(0, lineno - context_lines)
+    upper_bound = min(lineno + 1 + context_lines, len(source))
+
+    try:
+        pre_context = [strip_string(line.strip("\r\n"), max_length=max_length) for line in source[lower_bound:lineno]]
+        context_line = strip_string(source[lineno].strip("\r\n"), max_length=max_length)
+        post_context = [
+            strip_string(line.strip("\r\n"), max_length=max_length)
+            for line in source[(lineno + 1) : upper_bound]  # noqa: E203
+        ]
+        return pre_context, context_line, post_context
+    except IndexError:
+        # the file may have changed since it was loaded into memory
+        return [], None, []
+
+
+def get_source_context(
+    frame,  # type: FrameType
+    tb_lineno,  # type: int
+    max_value_length=None,  # type: Optional[int]
+):
+    # type: (...) -> Tuple[List[Annotated[str]], Optional[Annotated[str]], List[Annotated[str]]]
+    try:
+        abs_path = frame.f_code.co_filename  # type: Optional[str]
+    except Exception:
+        abs_path = None
+    try:
+        module = frame.f_globals["__name__"]
+    except Exception:
+        return [], None, []
+    try:
+        loader = frame.f_globals["__loader__"]
+    except Exception:
+        loader = None
+    lineno = tb_lineno - 1
+    if lineno is not None and abs_path:
+        return get_lines_from_file(abs_path, lineno, max_value_length, loader=loader, module=module)
+    return [], None, []
+
+
+def safe_str(value):
+    # type: (Any) -> str
+    try:
+        return str(value)
+    except Exception:
+        return safe_repr(value)
+
+
+def safe_repr(value):
+    # type: (Any) -> str
+    try:
+        return repr(value)
+    except Exception:
+        return "<broken repr>"
+
+
+def filename_for_module(module, abs_path):
+    # type: (Optional[str], Optional[str]) -> Optional[str]
+    if not abs_path or not module:
+        return abs_path
+
+    try:
+        if abs_path.endswith(".pyc"):
+            abs_path = abs_path[:-1]
+
+        base_module = module.split(".", 1)[0]
+        if base_module == module:
+            return os.path.basename(abs_path)
+
+        base_module_path = sys.modules[base_module].__file__
+        if not base_module_path:
+            return abs_path
+
+        return abs_path.split(base_module_path.rsplit(os.sep, 2)[0], 1)[-1].lstrip(os.sep)
+    except Exception:
+        return abs_path
+
+
+def serialize_frame(
+    frame,
+    tb_lineno=None,
+    include_local_variables=True,
+    include_source_context=True,
+    max_value_length=None,
+    custom_repr=None,
+):
+    # type: (FrameType, Optional[int], bool, bool, Optional[int], Optional[Callable[..., Optional[str]]]) -> Dict[str, Any]
+    f_code = getattr(frame, "f_code", None)
+    if not f_code:
+        abs_path = None
+        function = None
+    else:
+        abs_path = frame.f_code.co_filename
+        function = frame.f_code.co_name
+    try:
+        module = frame.f_globals["__name__"]
+    except Exception:
+        module = None
+
+    if tb_lineno is None:
+        tb_lineno = frame.f_lineno
+
+    rv = {
+        "filename": filename_for_module(module, abs_path) or None,
+        "abs_path": os.path.abspath(abs_path) if abs_path else None,
+        "function": function or "<unknown>",
+        "module": module,
+        "lineno": tb_lineno,
+    }  # type: Dict[str, Any]
+
+    if include_source_context:
+        rv["pre_context"], rv["context_line"], rv["post_context"] = get_source_context(
+            frame, tb_lineno, max_value_length
+        )
+
+    if include_local_variables:
+        # TODO(nk): Sort out this current invalid import
+        # from sentry_sdk.serializer import serialize
+
+        # rv["vars"] = serialize(
+        #     dict(frame.f_locals), is_vars=True, custom_repr=custom_repr
+        # )
+        pass
+
+    return rv
+
+
+def current_stacktrace(
+    include_local_variables=True,  # type: bool
+    include_source_context=True,  # type: bool
+    max_value_length=None,  # type: Optional[int]
+):
+    # type: (...) -> Dict[str, Any]
+    __tracebackhide__ = True
+    frames = []
+
+    f = sys._getframe()  # type: Optional[FrameType]
+    while f is not None:
+        if not should_hide_frame(f):
+            frames.append(
+                serialize_frame(
+                    f,
+                    include_local_variables=include_local_variables,
+                    include_source_context=include_source_context,
+                    max_value_length=max_value_length,
+                )
+            )
+        f = f.f_back
+
+    frames.reverse()
+
+    return {"frames": frames}
+
+
+def get_errno(exc_value):
+    # type: (BaseException) -> Optional[Any]
+    return getattr(exc_value, "errno", None)
+
+
+def get_error_message(exc_value):
+    # type: (Optional[BaseException]) -> str
+    return getattr(exc_value, "message", "") or getattr(exc_value, "detail", "") or safe_str(exc_value)
+
+
+def single_exception_from_error_tuple(
+    exc_type,  # type: Optional[type]
+    exc_value,  # type: Optional[BaseException]
+    tb,  # type: Optional[TracebackType]
+    client_options=None,  # type: Optional[Dict[str, Any]]
+    mechanism=None,  # type: Optional[Dict[str, Any]]
+    exception_id=None,  # type: Optional[int]
+    parent_id=None,  # type: Optional[int]
+    source=None,  # type: Optional[str]
+):
+    # type: (...) -> Dict[str, Any]
+    """
+    Creates a dict that goes into the events `exception.values` list and is ingestible by Sentry.
+
+    See the Exception Interface documentation for more details:
+    https://develop.sentry.dev/sdk/event-payloads/exception/
+    """
+    exception_value = {}  # type: Dict[str, Any]
+    exception_value["mechanism"] = mechanism.copy() if mechanism else {"type": "generic", "handled": True}
+    if exception_id is not None:
+        exception_value["mechanism"]["exception_id"] = exception_id
+
+    if exc_value is not None:
+        errno = get_errno(exc_value)
+    else:
+        errno = None
+
+    if errno is not None:
+        exception_value["mechanism"].setdefault("meta", {}).setdefault("errno", {}).setdefault("number", errno)
+
+    if source is not None:
+        exception_value["mechanism"]["source"] = source
+
+    is_root_exception = exception_id == 0
+    if not is_root_exception and parent_id is not None:
+        exception_value["mechanism"]["parent_id"] = parent_id
+        exception_value["mechanism"]["type"] = "chained"
+
+    if is_root_exception and "type" not in exception_value["mechanism"]:
+        exception_value["mechanism"]["type"] = "generic"
+
+    is_exception_group = BaseExceptionGroup is not None and isinstance(exc_value, BaseExceptionGroup)
+    if is_exception_group:
+        exception_value["mechanism"]["is_exception_group"] = True
+
+    exception_value["module"] = get_type_module(exc_type)
+    exception_value["type"] = get_type_name(exc_type)
+    exception_value["value"] = get_error_message(exc_value)
+
+    if client_options is None:
+        include_local_variables = True
+        include_source_context = True
+        max_value_length = DEFAULT_MAX_VALUE_LENGTH  # fallback
+        custom_repr = None
+    else:
+        include_local_variables = client_options["include_local_variables"]
+        include_source_context = client_options["include_source_context"]
+        max_value_length = client_options["max_value_length"]
+        custom_repr = client_options.get("custom_repr")
+
+    frames = [
+        serialize_frame(
+            tb.tb_frame,
+            tb_lineno=tb.tb_lineno,
+            include_local_variables=include_local_variables,
+            include_source_context=include_source_context,
+            max_value_length=max_value_length,
+            custom_repr=custom_repr,
+        )
+        for tb in iter_stacks(tb)
+    ]
+
+    if frames:
+        exception_value["stacktrace"] = {"frames": frames}
+
+    return exception_value
+
+
+HAS_CHAINED_EXCEPTIONS = hasattr(Exception, "__suppress_context__")
+
+if HAS_CHAINED_EXCEPTIONS:
+
+    def walk_exception_chain(exc_info):
+        # type: (ExcInfo) -> Iterator[ExcInfo]
+        exc_type, exc_value, tb = exc_info
+
+        seen_exceptions = []
+        seen_exception_ids = set()  # type: Set[int]
+
+        while exc_type is not None and exc_value is not None and id(exc_value) not in seen_exception_ids:
+            yield exc_type, exc_value, tb
+
+            # Avoid hashing random types we don't know anything
+            # about. Use the list to keep a ref so that the `id` is
+            # not used for another object.
+            seen_exceptions.append(exc_value)
+            seen_exception_ids.add(id(exc_value))
+
+            if exc_value.__suppress_context__:
+                cause = exc_value.__cause__
+            else:
+                cause = exc_value.__context__
+            if cause is None:
+                break
+            exc_type = type(cause)
+            exc_value = cause
+            tb = getattr(cause, "__traceback__", None)
+
+else:
+
+    def walk_exception_chain(exc_info):
+        # type: (ExcInfo) -> Iterator[ExcInfo]
+        yield exc_info
+
+
+def exceptions_from_error(
+    exc_type,  # type: Optional[type]
+    exc_value,  # type: Optional[BaseException]
+    tb,  # type: Optional[TracebackType]
+    client_options=None,  # type: Optional[Dict[str, Any]]
+    mechanism=None,  # type: Optional[Dict[str, Any]]
+    exception_id=0,  # type: int
+    parent_id=0,  # type: int
+    source=None,  # type: Optional[str]
+):
+    # type: (...) -> Tuple[int, List[Dict[str, Any]]]
+    """
+    Creates the list of exceptions.
+    This can include chained exceptions and exceptions from an ExceptionGroup.
+
+    See the Exception Interface documentation for more details:
+    https://develop.sentry.dev/sdk/event-payloads/exception/
+    """
+
+    parent = single_exception_from_error_tuple(
+        exc_type=exc_type,
+        exc_value=exc_value,
+        tb=tb,
+        client_options=client_options,
+        mechanism=mechanism,
+        exception_id=exception_id,
+        parent_id=parent_id,
+        source=source,
+    )
+    exceptions = [parent]
+
+    parent_id = exception_id
+    exception_id += 1
+
+    should_supress_context = hasattr(exc_value, "__suppress_context__") and exc_value.__suppress_context__  # type: ignore
+    if should_supress_context:
+        # Add direct cause.
+        # The field `__cause__` is set when raised with the exception (using the `from` keyword).
+        exception_has_cause = exc_value and hasattr(exc_value, "__cause__") and exc_value.__cause__ is not None
+        if exception_has_cause:
+            cause = exc_value.__cause__  # type: ignore
+            (exception_id, child_exceptions) = exceptions_from_error(
+                exc_type=type(cause),
+                exc_value=cause,
+                tb=getattr(cause, "__traceback__", None),
+                client_options=client_options,
+                mechanism=mechanism,
+                exception_id=exception_id,
+                source="__cause__",
+            )
+            exceptions.extend(child_exceptions)
+
+    else:
+        # Add indirect cause.
+        # The field `__context__` is assigned if another exception occurs while handling the exception.
+        exception_has_content = exc_value and hasattr(exc_value, "__context__") and exc_value.__context__ is not None
+        if exception_has_content:
+            context = exc_value.__context__  # type: ignore
+            (exception_id, child_exceptions) = exceptions_from_error(
+                exc_type=type(context),
+                exc_value=context,
+                tb=getattr(context, "__traceback__", None),
+                client_options=client_options,
+                mechanism=mechanism,
+                exception_id=exception_id,
+                source="__context__",
+            )
+            exceptions.extend(child_exceptions)
+
+    # Add exceptions from an ExceptionGroup.
+    is_exception_group = exc_value and hasattr(exc_value, "exceptions")
+    if is_exception_group:
+        for idx, e in enumerate(exc_value.exceptions):  # type: ignore
+            (exception_id, child_exceptions) = exceptions_from_error(
+                exc_type=type(e),
+                exc_value=e,
+                tb=getattr(e, "__traceback__", None),
+                client_options=client_options,
+                mechanism=mechanism,
+                exception_id=exception_id,
+                parent_id=parent_id,
+                source="exceptions[%s]" % idx,
+            )
+            exceptions.extend(child_exceptions)
+
+    return (exception_id, exceptions)
+
+
+def exceptions_from_error_tuple(
+    exc_info,  # type: ExcInfo
+    client_options=None,  # type: Optional[Dict[str, Any]]
+    mechanism=None,  # type: Optional[Dict[str, Any]]
+):
+    # type: (...) -> List[Dict[str, Any]]
+    exc_type, exc_value, tb = exc_info
+
+    is_exception_group = BaseExceptionGroup is not None and isinstance(exc_value, BaseExceptionGroup)
+
+    if is_exception_group:
+        (_, exceptions) = exceptions_from_error(
+            exc_type=exc_type,
+            exc_value=exc_value,
+            tb=tb,
+            client_options=client_options,
+            mechanism=mechanism,
+            exception_id=0,
+            parent_id=0,
+        )
+
+    else:
+        exceptions = []
+        for exc_type, exc_value, tb in walk_exception_chain(exc_info):
+            exceptions.append(single_exception_from_error_tuple(exc_type, exc_value, tb, client_options, mechanism))
+
+    exceptions.reverse()
+
+    return exceptions
+
+
+def to_string(value):
+    # type: (str) -> str
+    try:
+        return str(value)
+    except UnicodeDecodeError:
+        return repr(value)[1:-1]
+
+
+def iter_event_stacktraces(event):
+    # type: (Event) -> Iterator[Dict[str, Any]]
+    if "stacktrace" in event:
+        yield event["stacktrace"]
+    if "threads" in event:
+        for thread in event["threads"].get("values") or ():
+            if "stacktrace" in thread:
+                yield thread["stacktrace"]
+    if "exception" in event:
+        for exception in event["exception"].get("values") or ():
+            if "stacktrace" in exception:
+                yield exception["stacktrace"]
+
+
+def iter_event_frames(event):
+    # type: (Event) -> Iterator[Dict[str, Any]]
+    for stacktrace in iter_event_stacktraces(event):
+        for frame in stacktrace.get("frames") or ():
+            yield frame
+
+
+def handle_in_app(event, in_app_exclude=None, in_app_include=None, project_root=None):
+    # type: (Event, Optional[List[str]], Optional[List[str]], Optional[str]) -> Event
+    for stacktrace in iter_event_stacktraces(event):
+        set_in_app_in_frames(
+            stacktrace.get("frames"),
+            in_app_exclude=in_app_exclude,
+            in_app_include=in_app_include,
+            project_root=project_root,
+        )
+
+    return event
+
+
+def set_in_app_in_frames(frames, in_app_exclude, in_app_include, project_root=None):
+    # type: (Any, Optional[List[str]], Optional[List[str]], Optional[str]) -> Optional[Any]
+    if not frames:
+        return None
+
+    for frame in frames:
+        # if frame has already been marked as in_app, skip it
+        current_in_app = frame.get("in_app")
+        if current_in_app is not None:
+            continue
+
+        module = frame.get("module")
+
+        # check if module in frame is in the list of modules to include
+        if _module_in_list(module, in_app_include):
+            frame["in_app"] = True
+            continue
+
+        # check if module in frame is in the list of modules to exclude
+        if _module_in_list(module, in_app_exclude):
+            frame["in_app"] = False
+            continue
+
+        # if frame has no abs_path, skip further checks
+        abs_path = frame.get("abs_path")
+        if abs_path is None:
+            continue
+
+        if _is_external_source(abs_path):
+            frame["in_app"] = False
+            continue
+
+        if _is_in_project_root(abs_path, project_root):
+            frame["in_app"] = True
+            continue
+
+    return frames
+
+
+def exc_info_from_error(error):
+    # type: (Union[BaseException, ExcInfo]) -> ExcInfo
+    if isinstance(error, tuple) and len(error) == 3:
+        exc_type, exc_value, tb = error
+    elif isinstance(error, BaseException):
+        tb = getattr(error, "__traceback__", None)
+        if tb is not None:
+            exc_type = type(error)
+            exc_value = error
+        else:
+            exc_type, exc_value, tb = sys.exc_info()
+            if exc_value is not error:
+                tb = None
+                exc_value = error
+                exc_type = type(error)
+
+    else:
+        raise ValueError("Expected Exception object to report, got %s!" % type(error))
+
+    exc_info = (exc_type, exc_value, tb)
+
+    if TYPE_CHECKING:
+        # This cast is safe because exc_type and exc_value are either both
+        # None or both not None.
+        exc_info = cast(ExcInfo, exc_info)
+
+    return exc_info
+
+
+def event_from_exception(
+    exc_info,  # type: Union[BaseException, ExcInfo]
+    client_options=None,  # type: Optional[Dict[str, Any]]
+    mechanism=None,  # type: Optional[Dict[str, Any]]
+):
+    # type: (...) -> Tuple[Event, Dict[str, Any]]
+    exc_info = exc_info_from_error(exc_info)
+    hint = event_hint_with_exc_info(exc_info)
+    return (
+        {
+            "level": "error",
+            "exception": {"values": exceptions_from_error_tuple(exc_info, client_options, mechanism)},
+        },
+        hint,
+    )
+
+
+def _module_in_list(name, items):
+    # type: (str, Optional[List[str]]) -> bool
+    if name is None:
+        return False
+
+    if not items:
+        return False
+
+    for item in items:
+        if item == name or name.startswith(item + "."):
+            return True
+
+    return False
+
+
+def _is_external_source(abs_path):
+    # type: (str) -> bool
+    # check if frame is in 'site-packages' or 'dist-packages'
+    external_source = re.search(r"[\\/](?:dist|site)-packages[\\/]", abs_path) is not None
+    return external_source
+
+
+def _is_in_project_root(abs_path, project_root):
+    # type: (str, Optional[str]) -> bool
+    if project_root is None:
+        return False
+
+    # check if path is in the project root
+    if abs_path.startswith(project_root):
+        return True
+
+    return False
+
+
+def _truncate_by_bytes(string, max_bytes):
+    # type: (str, int) -> str
+    """
+    Truncate a UTF-8-encodable string to the last full codepoint so that it fits in max_bytes.
+    """
+    truncated = string.encode("utf-8")[: max_bytes - 3].decode("utf-8", errors="ignore")
+
+    return truncated + "..."
+
+
+def _get_size_in_bytes(value):
+    # type: (str) -> Optional[int]
+    try:
+        return len(value.encode("utf-8"))
+    except (UnicodeEncodeError, UnicodeDecodeError):
+        return None
+
+
+def strip_string(value, max_length=None):
+    # type: (str, Optional[int]) -> Union[AnnotatedValue, str]
+    if not value:
+        return value
+
+    if max_length is None:
+        max_length = DEFAULT_MAX_VALUE_LENGTH
+
+    byte_size = _get_size_in_bytes(value)
+    text_size = len(value)
+
+    if byte_size is not None and byte_size > max_length:
+        # truncate to max_length bytes, preserving code points
+        truncated_value = _truncate_by_bytes(value, max_length)
+    elif text_size is not None and text_size > max_length:
+        # fallback to truncating by string length
+        truncated_value = value[: max_length - 3] + "..."
+    else:
+        return value
+
+    return AnnotatedValue(
+        value=truncated_value,
+        metadata={
+            "len": byte_size or text_size,
+            "rem": [["!limit", "x", max_length - 3, max_length]],
+        },
+    )

posthog/feature_flags.py

@@ -0,0 +1,336 @@
+import datetime
+import hashlib
+import logging
+import re
+from typing import Optional
+
+from dateutil import parser
+from dateutil.relativedelta import relativedelta
+
+from posthog.utils import convert_to_datetime_aware, is_valid_regex
+
+__LONG_SCALE__ = float(0xFFFFFFFFFFFFFFF)
+
+log = logging.getLogger("posthog")
+
+NONE_VALUES_ALLOWED_OPERATORS = ["is_not"]
+
+
+class InconclusiveMatchError(Exception):
+    pass
+
+
+# This function takes a distinct_id and a feature flag key and returns a float between 0 and 1.
+# Given the same distinct_id and key, it'll always return the same float. These floats are
+# uniformly distributed between 0 and 1, so if we want to show this feature to 20% of traffic
+# we can do _hash(key, distinct_id) < 0.2
+def _hash(key, distinct_id, salt=""):
+    hash_key = f"{key}.{distinct_id}{salt}"
+    hash_val = int(hashlib.sha1(hash_key.encode("utf-8")).hexdigest()[:15], 16)
+    return hash_val / __LONG_SCALE__
+
+
+def get_matching_variant(flag, distinct_id):
+    hash_value = _hash(flag["key"], distinct_id, salt="variant")
+    for variant in variant_lookup_table(flag):
+        if hash_value >= variant["value_min"] and hash_value < variant["value_max"]:
+            return variant["key"]
+    return None
+
+
+def variant_lookup_table(feature_flag):
+    lookup_table = []
+    value_min = 0
+    multivariates = ((feature_flag.get("filters") or {}).get("multivariate") or {}).get("variants") or []
+    for variant in multivariates:
+        value_max = value_min + variant["rollout_percentage"] / 100
+        lookup_table.append({"value_min": value_min, "value_max": value_max, "key": variant["key"]})
+        value_min = value_max
+    return lookup_table
+
+
+def match_feature_flag_properties(flag, distinct_id, properties, cohort_properties=None):
+    flag_conditions = (flag.get("filters") or {}).get("groups") or []
+    is_inconclusive = False
+    cohort_properties = cohort_properties or {}
+
+    # Stable sort conditions with variant overrides to the top. This ensures that if overrides are present, they are
+    # evaluated first, and the variant override is applied to the first matching condition.
+    sorted_flag_conditions = sorted(
+        flag_conditions,
+        key=lambda condition: 0 if condition.get("variant") else 1,
+    )
+
+    for condition in sorted_flag_conditions:
+        try:
+            # if any one condition resolves to True, we can shortcircuit and return
+            # the matching variant
+            if is_condition_match(flag, distinct_id, condition, properties, cohort_properties):
+                variant_override = condition.get("variant")
+                # Some filters can be explicitly set to null, which require accessing variants like so
+                flag_variants = ((flag.get("filters") or {}).get("multivariate") or {}).get("variants") or []
+                if variant_override and variant_override in [variant["key"] for variant in flag_variants]:
+                    variant = variant_override
+                else:
+                    variant = get_matching_variant(flag, distinct_id)
+                return variant or True
+        except InconclusiveMatchError:
+            is_inconclusive = True
+
+    if is_inconclusive:
+        raise InconclusiveMatchError("Can't determine if feature flag is enabled or not with given properties")
+
+    # We can only return False when either all conditions are False, or
+    # no condition was inconclusive.
+    return False
+
+
+def is_condition_match(feature_flag, distinct_id, condition, properties, cohort_properties):
+    rollout_percentage = condition.get("rollout_percentage")
+    if len(condition.get("properties") or []) > 0:
+        for prop in condition.get("properties"):
+            property_type = prop.get("type")
+            if property_type == "cohort":
+                matches = match_cohort(prop, properties, cohort_properties)
+            else:
+                matches = match_property(prop, properties)
+            if not matches:
+                return False
+
+        if rollout_percentage is None:
+            return True
+
+    if rollout_percentage is not None and _hash(feature_flag["key"], distinct_id) > (rollout_percentage / 100):
+        return False
+
+    return True
+
+
+def match_property(property, property_values) -> bool:
+    # only looks for matches where key exists in override_property_values
+    # doesn't support operator is_not_set
+    key = property.get("key")
+    operator = property.get("operator") or "exact"
+    value = property.get("value")
+
+    if key not in property_values:
+        raise InconclusiveMatchError("can't match properties without a given property value")
+
+    if operator == "is_not_set":
+        raise InconclusiveMatchError("can't match properties with operator is_not_set")
+
+    override_value = property_values[key]
+
+    if (operator not in NONE_VALUES_ALLOWED_OPERATORS) and override_value is None:
+        return False
+
+    if operator in ("exact", "is_not"):
+
+        def compute_exact_match(value, override_value):
+            if isinstance(value, list):
+                return str(override_value).lower() in [str(val).lower() for val in value]
+            return str(value).lower() == str(override_value).lower()
+
+        if operator == "exact":
+            return compute_exact_match(value, override_value)
+        else:
+            return not compute_exact_match(value, override_value)
+
+    if operator == "is_set":
+        return key in property_values
+
+    if operator == "icontains":
+        return str(value).lower() in str(override_value).lower()
+
+    if operator == "not_icontains":
+        return str(value).lower() not in str(override_value).lower()
+
+    if operator == "regex":
+        return is_valid_regex(str(value)) and re.compile(str(value)).search(str(override_value)) is not None
+
+    if operator == "not_regex":
+        return is_valid_regex(str(value)) and re.compile(str(value)).search(str(override_value)) is None
+
+    if operator in ("gt", "gte", "lt", "lte"):
+        # :TRICKY: We adjust comparison based on the override value passed in,
+        # to make sure we handle both numeric and string comparisons appropriately.
+        def compare(lhs, rhs, operator):
+            if operator == "gt":
+                return lhs > rhs
+            elif operator == "gte":
+                return lhs >= rhs
+            elif operator == "lt":
+                return lhs < rhs
+            elif operator == "lte":
+                return lhs <= rhs
+            else:
+                raise ValueError(f"Invalid operator: {operator}")
+
+        parsed_value = None
+        try:
+            parsed_value = float(value)  # type: ignore
+        except Exception:
+            pass
+
+        if parsed_value is not None and override_value is not None:
+            if isinstance(override_value, str):
+                return compare(override_value, str(value), operator)
+            else:
+                return compare(override_value, parsed_value, operator)
+        else:
+            return compare(str(override_value), str(value), operator)
+
+    if operator in ["is_date_before", "is_date_after"]:
+        try:
+            parsed_date = relative_date_parse_for_feature_flag_matching(str(value))
+
+            if not parsed_date:
+                parsed_date = parser.parse(str(value))
+                parsed_date = convert_to_datetime_aware(parsed_date)
+        except Exception as e:
+            raise InconclusiveMatchError("The date set on the flag is not a valid format") from e
+
+        if not parsed_date:
+            raise InconclusiveMatchError("The date set on the flag is not a valid format")
+
+        if isinstance(override_value, datetime.datetime):
+            override_date = convert_to_datetime_aware(override_value)
+            if operator == "is_date_before":
+                return override_date < parsed_date
+            else:
+                return override_date > parsed_date
+        elif isinstance(override_value, datetime.date):
+            if operator == "is_date_before":
+                return override_value < parsed_date.date()
+            else:
+                return override_value > parsed_date.date()
+        elif isinstance(override_value, str):
+            try:
+                override_date = parser.parse(override_value)
+                override_date = convert_to_datetime_aware(override_date)
+                if operator == "is_date_before":
+                    return override_date < parsed_date
+                else:
+                    return override_date > parsed_date
+            except Exception:
+                raise InconclusiveMatchError("The date provided is not a valid format")
+        else:
+            raise InconclusiveMatchError("The date provided must be a string or date object")
+
+    # if we get here, we don't know how to handle the operator
+    raise InconclusiveMatchError(f"Unknown operator {operator}")
+
+
+def match_cohort(property, property_values, cohort_properties) -> bool:
+    # Cohort properties are in the form of property groups like this:
+    # {
+    #     "cohort_id": {
+    #         "type": "AND|OR",
+    #         "values": [{
+    #            "key": "property_name", "value": "property_value"
+    #        }]
+    #     }
+    # }
+    cohort_id = str(property.get("value"))
+    if cohort_id not in cohort_properties:
+        raise InconclusiveMatchError("can't match cohort without a given cohort property value")
+
+    property_group = cohort_properties[cohort_id]
+    return match_property_group(property_group, property_values, cohort_properties)
+
+
+def match_property_group(property_group, property_values, cohort_properties) -> bool:
+    if not property_group:
+        return True
+
+    property_group_type = property_group.get("type")
+    properties = property_group.get("values")
+
+    if not properties or len(properties) == 0:
+        # empty groups are no-ops, always match
+        return True
+
+    error_matching_locally = False
+
+    if "values" in properties[0]:
+        # a nested property group
+        for prop in properties:
+            try:
+                matches = match_property_group(prop, property_values, cohort_properties)
+                if property_group_type == "AND":
+                    if not matches:
+                        return False
+                else:
+                    # OR group
+                    if matches:
+                        return True
+            except InconclusiveMatchError as e:
+                log.debug(f"Failed to compute property {prop} locally: {e}")
+                error_matching_locally = True
+
+        if error_matching_locally:
+            raise InconclusiveMatchError("Can't match cohort without a given cohort property value")
+        # if we get here, all matched in AND case, or none matched in OR case
+        return property_group_type == "AND"
+
+    else:
+        for prop in properties:
+            try:
+                if prop.get("type") == "cohort":
+                    matches = match_cohort(prop, property_values, cohort_properties)
+                else:
+                    matches = match_property(prop, property_values)
+
+                negation = prop.get("negation", False)
+
+                if property_group_type == "AND":
+                    # if negated property, do the inverse
+                    if not matches and not negation:
+                        return False
+                    if matches and negation:
+                        return False
+                else:
+                    # OR group
+                    if matches and not negation:
+                        return True
+                    if not matches and negation:
+                        return True
+            except InconclusiveMatchError as e:
+                log.debug(f"Failed to compute property {prop} locally: {e}")
+                error_matching_locally = True
+
+        if error_matching_locally:
+            raise InconclusiveMatchError("can't match cohort without a given cohort property value")
+
+        # if we get here, all matched in AND case, or none matched in OR case
+        return property_group_type == "AND"
+
+
+def relative_date_parse_for_feature_flag_matching(value: str) -> Optional[datetime.datetime]:
+    regex = r"^-?(?P<number>[0-9]+)(?P<interval>[a-z])$"
+    match = re.search(regex, value)
+    parsed_dt = datetime.datetime.now(datetime.timezone.utc)
+    if match:
+        number = int(match.group("number"))
+
+        if number >= 10_000:
+            # Guard against overflow, disallow numbers greater than 10_000
+            return None
+
+        interval = match.group("interval")
+        if interval == "h":
+            parsed_dt = parsed_dt - relativedelta(hours=number)
+        elif interval == "d":
+            parsed_dt = parsed_dt - relativedelta(days=number)
+        elif interval == "w":
+            parsed_dt = parsed_dt - relativedelta(weeks=number)
+        elif interval == "m":
+            parsed_dt = parsed_dt - relativedelta(months=number)
+        elif interval == "y":
+            parsed_dt = parsed_dt - relativedelta(years=number)
+        else:
+            return None
+
+        return parsed_dt
+    else:
+        return None

posthog/poller.py

@@ -0,0 +1,20 @@
+import threading
+
+
+class Poller(threading.Thread):
+    def __init__(self, interval, execute, *args, **kwargs):
+        threading.Thread.__init__(self)
+        self.daemon = True  # Make daemon to not interfere with program exit
+        self.stopped = threading.Event()
+        self.interval = interval
+        self.execute = execute
+        self.args = args
+        self.kwargs = kwargs
+
+    def stop(self):
+        self.stopped.set()
+        self.join()
+
+    def run(self):
+        while not self.stopped.wait(self.interval.total_seconds()):
+            self.execute(*self.args, **self.kwargs)

posthog/request.py

@@ -1,69 +1,112 @@
-from datetime import date, datetime
-from dateutil.tz import tzutc
-import logging
 import json
+import logging
+from datetime import date, datetime
 from gzip import GzipFile
-from requests.auth import HTTPBasicAuth
-from requests import sessions
 from io import BytesIO
+from typing import Any, Optional, Union
+
+import requests
+from dateutil.tz import tzutc
 
-from posthog.version import VERSION
 from posthog.utils import remove_trailing_slash
+from posthog.version import VERSION
 
-_session = sessions.Session()
+_session = requests.sessions.Session()
+
+US_INGESTION_ENDPOINT = "https://us.i.posthog.com"
+EU_INGESTION_ENDPOINT = "https://eu.i.posthog.com"
+DEFAULT_HOST = US_INGESTION_ENDPOINT
+USER_AGENT = "posthog-python/" + VERSION
 
 
-def post(api_key, host=None, gzip=False, timeout=15, **kwargs):
+def determine_server_host(host: Optional[str]) -> str:
+    """Determines the server host to use."""
+    host_or_default = host or DEFAULT_HOST
+    trimmed_host = remove_trailing_slash(host_or_default)
+    if trimmed_host in ("https://app.posthog.com", "https://us.posthog.com"):
+        return US_INGESTION_ENDPOINT
+    elif trimmed_host == "https://eu.posthog.com":
+        return EU_INGESTION_ENDPOINT
+    else:
+        return host_or_default
+
+
+def post(
+    api_key: str, host: Optional[str] = None, path=None, gzip: bool = False, timeout: int = 15, **kwargs
+) -> requests.Response:
     """Post the `kwargs` to the API"""
-    log = logging.getLogger('posthog')
+    log = logging.getLogger("posthog")
     body = kwargs
     body["sentAt"] = datetime.utcnow().replace(tzinfo=tzutc()).isoformat()
-    url = remove_trailing_slash(host or 'https://t.posthog.com') + '/batch/'
-    body['api_key'] = api_key
+    url = remove_trailing_slash(host or DEFAULT_HOST) + path
+    body["api_key"] = api_key
     data = json.dumps(body, cls=DatetimeSerializer)
-    log.debug('making request: %s', data)
-    headers = {
-        'Content-Type': 'application/json',
-        'User-Agent': 'analytics-python/' + VERSION
-    }
+    log.debug("making request: %s", data)
+    headers = {"Content-Type": "application/json", "User-Agent": USER_AGENT}
     if gzip:
-        headers['Content-Encoding'] = 'gzip'
+        headers["Content-Encoding"] = "gzip"
         buf = BytesIO()
-        with GzipFile(fileobj=buf, mode='w') as gz:
+        with GzipFile(fileobj=buf, mode="w") as gz:
             # 'data' was produced by json.dumps(),
             # whose default encoding is utf-8.
-            gz.write(data.encode('utf-8'))
+            gz.write(data.encode("utf-8"))
         data = buf.getvalue()
 
-    res = _session.post(url, data=data,
-                        headers=headers, timeout=timeout)
+    res = _session.post(url, data=data, headers=headers, timeout=timeout)
 
     if res.status_code == 200:
-        log.debug('data uploaded successfully')
-        return res
+        log.debug("data uploaded successfully")
 
+    return res
+
+
+def _process_response(
+    res: requests.Response, success_message: str, *, return_json: bool = True
+) -> Union[requests.Response, Any]:
+    log = logging.getLogger("posthog")
+    if res.status_code == 200:
+        log.debug(success_message)
+        return res.json() if return_json else res
     try:
         payload = res.json()
-        log.debug('received response: %s', payload)
-        raise APIError(res.status_code, payload['code'], payload['message'])
-    except ValueError:
-        raise APIError(res.status_code, 'unknown', res.text)
+        log.debug("received response: %s", payload)
+        raise APIError(res.status_code, payload["detail"])
+    except (KeyError, ValueError):
+        raise APIError(res.status_code, res.text)
+
+
+def decide(api_key: str, host: Optional[str] = None, gzip: bool = False, timeout: int = 15, **kwargs) -> Any:
+    """Post the `kwargs to the decide API endpoint"""
+    res = post(api_key, host, "/decide/?v=3", gzip, timeout, **kwargs)
+    return _process_response(res, success_message="Feature flags decided successfully")
+
+
+def batch_post(
+    api_key: str, host: Optional[str] = None, gzip: bool = False, timeout: int = 15, **kwargs
+) -> requests.Response:
+    """Post the `kwargs` to the batch API endpoint for events"""
+    res = post(api_key, host, "/batch/", gzip, timeout, **kwargs)
+    return _process_response(res, success_message="data uploaded successfully", return_json=False)
+
+
+def get(api_key: str, url: str, host: Optional[str] = None, timeout: Optional[int] = None) -> requests.Response:
+    url = remove_trailing_slash(host or DEFAULT_HOST) + url
+    res = requests.get(url, headers={"Authorization": "Bearer %s" % api_key, "User-Agent": USER_AGENT}, timeout=timeout)
+    return _process_response(res, success_message=f"GET {url} completed successfully")
 
 
 class APIError(Exception):
-
-    def __init__(self, status, code, message):
+    def __init__(self, status: Union[int, str], message: str):
         self.message = message
         self.status = status
-        self.code = code
 
     def __str__(self):
-        msg = "[PostHog] {0}: {1} ({2})"
-        return msg.format(self.code, self.message, self.status)
+        msg = "[PostHog] {0} ({1})"
+        return msg.format(self.message, self.status)
 
 
 class DatetimeSerializer(json.JSONEncoder):
-    def default(self, obj):
+    def default(self, obj: Any):
         if isinstance(obj, (date, datetime)):
             return obj.isoformat()
 

posthog/sentry/__init__.py

@@ -0,0 +1 @@
+POSTHOG_ID_TAG = "posthog_distinct_id"

posthog/sentry/django.py

@@ -0,0 +1,28 @@
+from django.conf import settings
+from sentry_sdk import configure_scope
+
+from posthog.sentry import POSTHOG_ID_TAG
+
+GET_DISTINCT_ID = getattr(settings, "POSTHOG_DJANGO", {}).get("distinct_id")
+
+
+def get_distinct_id(request):
+    if not GET_DISTINCT_ID:
+        return None
+    try:
+        return GET_DISTINCT_ID(request)
+    except:  # noqa: E722
+        return None
+
+
+class PosthogDistinctIdMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        with configure_scope() as scope:
+            distinct_id = get_distinct_id(request)
+            if distinct_id:
+                scope.set_tag(POSTHOG_ID_TAG, distinct_id)
+            response = self.get_response(request)
+        return response

posthog/sentry/posthog_integration.py

@@ -0,0 +1,52 @@
+from sentry_sdk._types import MYPY
+from sentry_sdk.hub import Hub
+from sentry_sdk.integrations import Integration
+from sentry_sdk.scope import add_global_event_processor
+from sentry_sdk.utils import Dsn
+
+import posthog
+from posthog.request import DEFAULT_HOST
+from posthog.sentry import POSTHOG_ID_TAG
+
+if MYPY:
+    from typing import Optional  # noqa: F401
+
+    from sentry_sdk._types import Event, Hint  # noqa: F401
+
+
+class PostHogIntegration(Integration):
+    identifier = "posthog-python"
+    organization = None  # The Sentry organization, used to send a direct link from PostHog to Sentry
+    project_id = None  # The Sentry project id, used to send a direct link from PostHog to Sentry
+    prefix = "https://sentry.io/organizations/"  # URL of a hosted sentry instance (default: https://sentry.io/organizations/)
+
+    @staticmethod
+    def setup_once():
+        @add_global_event_processor
+        def processor(event, hint):
+            # type: (Event, Optional[Hint]) -> Optional[Event]
+            if Hub.current.get_integration(PostHogIntegration) is not None:
+                if event.get("level") != "error":
+                    return event
+
+                if event.get("tags", {}).get(POSTHOG_ID_TAG):
+                    posthog_distinct_id = event["tags"][POSTHOG_ID_TAG]
+                    event["tags"]["PostHog URL"] = f"{posthog.host or DEFAULT_HOST}/person/{posthog_distinct_id}"
+
+                    properties = {
+                        "$sentry_event_id": event["event_id"],
+                        "$sentry_exception": event["exception"],
+                    }
+
+                    if PostHogIntegration.organization:
+                        project_id = PostHogIntegration.project_id or (
+                            not not Hub.current.client.dsn and Dsn(Hub.current.client.dsn).project_id
+                        )
+                        if project_id:
+                            properties["$sentry_url"] = (
+                                f"{PostHogIntegration.prefix}{PostHogIntegration.organization}/issues/?project={project_id}&query={event['event_id']}"
+                            )
+
+                    posthog.capture(posthog_distinct_id, "$exception", properties)
+
+            return event

posthog/test/__init__.py

@@ -1,12 +1,12 @@
-import unittest
-import pkgutil
 import logging
+import pkgutil
 import sys
+import unittest
 
 
 def all_names():
     for _, modname, _ in pkgutil.iter_modules(__path__):
-        yield 'analytics.test.' + modname
+        yield "posthog.test." + modname
 
 
 def all():

posthog/test/client.py

@@ -1,316 +0,0 @@
-from datetime import date, datetime
-import unittest
-import six
-import mock
-import time
-
-from posthog.version import VERSION
-from posthog.client import Client
-
-
-class TestClient(unittest.TestCase):
-
-    def fail(self, e, batch):
-        """Mark the failure handler"""
-        self.failed = True
-
-    def setUp(self):
-        self.failed = False
-        self.client = Client('testsecret', on_error=self.fail)
-
-    def test_requires_api_key(self):
-        self.assertRaises(AssertionError, Client)
-
-    def test_empty_flush(self):
-        self.client.flush()
-
-    def test_basic_track(self):
-        client = self.client
-        success, msg = client.track('distinct_id', 'python test event')
-        client.flush()
-        self.assertTrue(success)
-        self.assertFalse(self.failed)
-
-        self.assertEqual(msg['event'], 'python test event')
-        self.assertTrue(isinstance(msg['timestamp'], str))
-        self.assertTrue(isinstance(msg['messageId'], str))
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['properties'], {})
-        self.assertEqual(msg['type'], 'track')
-
-    def test_stringifies_distinct_id(self):
-        # A large number that loses precision in node:
-        # node -e "console.log(157963456373623802 + 1)" > 157963456373623800
-        client = self.client
-        success, msg = client.track(
-            distinct_id=157963456373623802, event='python test event')
-        client.flush()
-        self.assertTrue(success)
-        self.assertFalse(self.failed)
-
-        self.assertEqual(msg['distinct_id'], '157963456373623802')
-
-    def test_advanced_track(self):
-        client = self.client
-        success, msg = client.track(
-            'distinct_id', 'python test event', {'property': 'value'},
-            {'ip': '192.168.0.1'}, datetime(2014, 9, 3),
-            'messageId')
-
-        self.assertTrue(success)
-
-        self.assertEqual(msg['timestamp'], '2014-09-03T00:00:00+00:00')
-        self.assertEqual(msg['properties'], {'property': 'value'})
-        self.assertEqual(msg['context']['ip'], '192.168.0.1')
-        self.assertEqual(msg['event'], 'python test event')
-        self.assertEqual(msg['context']['library'], {
-            'name': 'analytics-python',
-            'version': VERSION
-        })
-        self.assertEqual(msg['messageId'], 'messageId')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'track')
-
-    def test_basic_identify(self):
-        client = self.client
-        success, msg = client.identify('distinct_id', {'trait': 'value'})
-        client.flush()
-        self.assertTrue(success)
-        self.assertFalse(self.failed)
-
-        self.assertEqual(msg['traits'], {'trait': 'value'})
-        self.assertTrue(isinstance(msg['timestamp'], str))
-        self.assertTrue(isinstance(msg['messageId'], str))
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'identify')
-
-    def test_advanced_identify(self):
-        client = self.client
-        success, msg = client.identify(
-            'distinct_id', {'trait': 'value'}, {'ip': '192.168.0.1'},
-            datetime(2014, 9, 3), 'messageId')
-
-        self.assertTrue(success)
-
-        self.assertEqual(msg['timestamp'], '2014-09-03T00:00:00+00:00')
-        self.assertEqual(msg['context']['ip'], '192.168.0.1')
-        self.assertEqual(msg['traits'], {'trait': 'value'})
-        self.assertEqual(msg['context']['library'], {
-            'name': 'analytics-python',
-            'version': VERSION
-        })
-        self.assertTrue(isinstance(msg['timestamp'], str))
-        self.assertEqual(msg['messageId'], 'messageId')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'identify')
-
-    def test_basic_group(self):
-        client = self.client
-        success, msg = client.group('distinct_id', 'groupId')
-        client.flush()
-        self.assertTrue(success)
-        self.assertFalse(self.failed)
-
-        self.assertEqual(msg['groupId'], 'groupId')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'group')
-
-    def test_advanced_group(self):
-        client = self.client
-        success, msg = client.group(
-            'distinct_id', 'groupId', {'trait': 'value'}, {'ip': '192.168.0.1'},
-            datetime(2014, 9, 3), 'messageId')
-
-        self.assertTrue(success)
-
-        self.assertEqual(msg['timestamp'], '2014-09-03T00:00:00+00:00')
-        self.assertEqual(msg['context']['ip'], '192.168.0.1')
-        self.assertEqual(msg['traits'], {'trait': 'value'})
-        self.assertEqual(msg['context']['library'], {
-            'name': 'analytics-python',
-            'version': VERSION
-        })
-        self.assertTrue(isinstance(msg['timestamp'], str))
-        self.assertEqual(msg['messageId'], 'messageId')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'group')
-
-    def test_basic_alias(self):
-        client = self.client
-        success, msg = client.alias('previousId', 'distinct_id')
-        client.flush()
-        self.assertTrue(success)
-        self.assertFalse(self.failed)
-        self.assertEqual(msg['previousId'], 'previousId')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-
-    def test_basic_page(self):
-        client = self.client
-        success, msg = client.page('distinct_id', name='name')
-        self.assertFalse(self.failed)
-        client.flush()
-        self.assertTrue(success)
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'page')
-        self.assertEqual(msg['name'], 'name')
-
-    def test_advanced_page(self):
-        client = self.client
-        success, msg = client.page(
-            'distinct_id', 'category', 'name', {'property': 'value'},
-            {'ip': '192.168.0.1'}, datetime(2014, 9, 3), 'messageId')
-
-        self.assertTrue(success)
-
-        self.assertEqual(msg['timestamp'], '2014-09-03T00:00:00+00:00')
-        self.assertEqual(msg['context']['ip'], '192.168.0.1')
-        self.assertEqual(msg['properties'], {'property': 'value'})
-        self.assertEqual(msg['context']['library'], {
-            'name': 'analytics-python',
-            'version': VERSION
-        })
-        self.assertEqual(msg['category'], 'category')
-        self.assertTrue(isinstance(msg['timestamp'], str))
-        self.assertEqual(msg['messageId'], 'messageId')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'page')
-        self.assertEqual(msg['name'], 'name')
-
-    def test_basic_screen(self):
-        client = self.client
-        success, msg = client.screen('distinct_id', name='name')
-        client.flush()
-        self.assertTrue(success)
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'screen')
-        self.assertEqual(msg['name'], 'name')
-
-    def test_advanced_screen(self):
-        client = self.client
-        success, msg = client.screen(
-            'distinct_id', 'category', 'name', {'property': 'value'},
-            {'ip': '192.168.0.1'}, datetime(2014, 9, 3), 'messageId')
-
-        self.assertTrue(success)
-
-        self.assertEqual(msg['timestamp'], '2014-09-03T00:00:00+00:00')
-        self.assertEqual(msg['context']['ip'], '192.168.0.1')
-        self.assertEqual(msg['properties'], {'property': 'value'})
-        self.assertEqual(msg['context']['library'], {
-            'name': 'analytics-python',
-            'version': VERSION
-        })
-        self.assertTrue(isinstance(msg['timestamp'], str))
-        self.assertEqual(msg['messageId'], 'messageId')
-        self.assertEqual(msg['category'], 'category')
-        self.assertEqual(msg['distinct_id'], 'distinct_id')
-        self.assertEqual(msg['type'], 'screen')
-        self.assertEqual(msg['name'], 'name')
-
-    def test_flush(self):
-        client = self.client
-        # set up the consumer with more requests than a single batch will allow
-        for i in range(1000):
-            success, msg = client.identify('distinct_id', {'trait': 'value'})
-        # We can't reliably assert that the queue is non-empty here; that's
-        # a race condition. We do our best to load it up though.
-        client.flush()
-        # Make sure that the client queue is empty after flushing
-        self.assertTrue(client.queue.empty())
-
-    def test_shutdown(self):
-        client = self.client
-        # set up the consumer with more requests than a single batch will allow
-        for i in range(1000):
-            success, msg = client.identify('distinct_id', {'trait': 'value'})
-        client.shutdown()
-        # we expect two things after shutdown:
-        # 1. client queue is empty
-        # 2. consumer thread has stopped
-        self.assertTrue(client.queue.empty())
-        for consumer in client.consumers:
-            self.assertFalse(consumer.is_alive())
-
-    def test_synchronous(self):
-        client = Client('testsecret', sync_mode=True)
-
-        success, message = client.identify('distinct_id')
-        self.assertFalse(client.consumers)
-        self.assertTrue(client.queue.empty())
-        self.assertTrue(success)
-
-    def test_overflow(self):
-        client = Client('testsecret', max_queue_size=1)
-        # Ensure consumer thread is no longer uploading
-        client.join()
-
-        for i in range(10):
-            client.identify('distinct_id')
-
-        success, msg = client.identify('distinct_id')
-        # Make sure we are informed that the queue is at capacity
-        self.assertFalse(success)
-
-    def test_success_on_invalid_api_key(self):
-        client = Client('bad_key', on_error=self.fail)
-        client.track('distinct_id', 'event')
-        client.flush()
-        self.assertFalse(self.failed)
-
-    def test_unicode(self):
-        Client(six.u('unicode_key'))
-
-    def test_numeric_distinct_id(self):
-        self.client.track(1234, 'python event')
-        self.client.flush()
-        self.assertFalse(self.failed)
-
-    def test_debug(self):
-        Client('bad_key', debug=True)
-
-    def test_identify_with_date_object(self):
-        client = self.client
-        success, msg = client.identify(
-            'distinct_id',
-            {
-                'birthdate': date(1981, 2, 2),
-            },
-        )
-        client.flush()
-        self.assertTrue(success)
-        self.assertFalse(self.failed)
-
-        self.assertEqual(msg['traits'], {'birthdate': date(1981, 2, 2)})
-
-    def test_gzip(self):
-        client = Client('testsecret', on_error=self.fail, gzip=True)
-        for _ in range(10):
-            client.identify('distinct_id', {'trait': 'value'})
-        client.flush()
-        self.assertFalse(self.failed)
-
-    def test_user_defined_flush_at(self):
-        client = Client('testsecret', on_error=self.fail,
-                        flush_at=10, flush_interval=3)
-
-        def mock_post_fn(*args, **kwargs):
-            self.assertEquals(len(kwargs['batch']), 10)
-
-        # the post function should be called 2 times, with a batch size of 10
-        # each time.
-        with mock.patch('analytics.consumer.post', side_effect=mock_post_fn) \
-                as mock_post:
-            for _ in range(20):
-                client.identify('distinct_id', {'trait': 'value'})
-            time.sleep(1)
-            self.assertEquals(mock_post.call_count, 2)
-
-    def test_user_defined_timeout(self):
-        client = Client('testsecret', timeout=10)
-        for consumer in client.consumers:
-            self.assertEquals(consumer.timeout, 10)
-
-    def test_default_timeout_15(self):
-        client = Client('testsecret')
-        for consumer in client.consumers:
-            self.assertEquals(consumer.timeout, 15)

posthog/test/exception_integrations/__init__.py

@@ -0,0 +1,3 @@
+import pytest
+
+pytest.importorskip("django")

posthog/test/exception_integrations/test_django.py

@@ -0,0 +1,68 @@
+from posthog.exception_integrations.django import DjangoRequestExtractor
+
+DEFAULT_USER_AGENT = (
+    "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3"
+)
+
+
+def mock_request_factory(override_headers):
+    class Request:
+        META = {}
+        # TRICKY: Actual django request dict object has case insensitive matching, and strips http from the names
+        headers = {
+            "User-Agent": DEFAULT_USER_AGENT,
+            "Referrer": "http://example.com",
+            "X-Forwarded-For": "193.4.5.12",
+            **(override_headers or {}),
+        }
+
+    return Request()
+
+
+def test_request_extractor_with_no_trace():
+    request = mock_request_factory(None)
+    extractor = DjangoRequestExtractor(request)
+    assert extractor.extract_person_data() == {
+        "ip": "193.4.5.12",
+        "user_agent": DEFAULT_USER_AGENT,
+        "traceparent": None,
+        "distinct_id": None,
+    }
+
+
+def test_request_extractor_with_trace():
+    request = mock_request_factory({"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01"})
+    extractor = DjangoRequestExtractor(request)
+    assert extractor.extract_person_data() == {
+        "ip": "193.4.5.12",
+        "user_agent": DEFAULT_USER_AGENT,
+        "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
+        "distinct_id": None,
+    }
+
+
+def test_request_extractor_with_tracestate():
+    request = mock_request_factory(
+        {
+            "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
+            "tracestate": "posthog-distinct-id=1234",
+        }
+    )
+    extractor = DjangoRequestExtractor(request)
+    assert extractor.extract_person_data() == {
+        "ip": "193.4.5.12",
+        "user_agent": DEFAULT_USER_AGENT,
+        "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
+        "distinct_id": "1234",
+    }
+
+
+def test_request_extractor_with_complicated_tracestate():
+    request = mock_request_factory({"tracestate": "posthog-distinct-id=alohaMountainsXUYZ,rojo=00f067aa0ba902b7"})
+    extractor = DjangoRequestExtractor(request)
+    assert extractor.extract_person_data() == {
+        "ip": "193.4.5.12",
+        "user_agent": DEFAULT_USER_AGENT,
+        "traceparent": None,
+        "distinct_id": "alohaMountainsXUYZ",
+    }

posthog/test/module.py

@@ -1,49 +0,0 @@
-import unittest
-
-import analytics
-
-
-class TestModule(unittest.TestCase):
-
-    def failed(self):
-        self.failed = True
-
-    def setUp(self):
-        self.failed = False
-        analytics.api_key = 'testsecret'
-        analytics.on_error = self.failed
-
-    def test_no_api_key(self):
-        analytics.api_key = None
-        self.assertRaises(Exception, analytics.track)
-
-    def test_no_host(self):
-        analytics.host = None
-        self.assertRaises(Exception, analytics.track)
-
-    def test_track(self):
-        analytics.track('distinct_id', 'python module event')
-        analytics.flush()
-
-    def test_identify(self):
-        analytics.identify('distinct_id', {'email': 'user@email.com'})
-        analytics.flush()
-
-    def test_group(self):
-        analytics.group('distinct_id', 'groupId')
-        analytics.flush()
-
-    def test_alias(self):
-        analytics.alias('previousId', 'distinct_id')
-        analytics.flush()
-
-    def test_page(self):
-        analytics.page('distinct_id')
-        analytics.flush()
-
-    def test_screen(self):
-        analytics.screen('distinct_id')
-        analytics.flush()
-
-    def test_flush(self):
-        analytics.flush()

posthog/test/request.py

@@ -1,53 +0,0 @@
-from datetime import datetime, date
-import unittest
-import json
-import requests
-
-from posthog.request import post, DatetimeSerializer
-
-
-class TestRequests(unittest.TestCase):
-
-    def test_valid_request(self):
-        res = post(batch=[{
-            'distinct_id': 'distinct_id',
-            'event': 'python event',
-            'type': 'track'
-        }])
-        self.assertEqual(res.status_code, 200)
-
-    def test_invalid_request_error(self):
-        self.assertRaises(Exception, post, 'testsecret',
-                          'https://t.posthog.com', False, '[{]')
-
-    def test_invalid_host(self):
-        self.assertRaises(Exception, post, 'testsecret',
-                          't.posthog.com/', batch=[])
-
-    def test_datetime_serialization(self):
-        data = {'created': datetime(2012, 3, 4, 5, 6, 7, 891011)}
-        result = json.dumps(data, cls=DatetimeSerializer)
-        self.assertEqual(result, '{"created": "2012-03-04T05:06:07.891011"}')
-
-    def test_date_serialization(self):
-        today = date.today()
-        data = {'created': today}
-        result = json.dumps(data, cls=DatetimeSerializer)
-        expected = '{"created": "%s"}' % today.isoformat()
-        self.assertEqual(result, expected)
-
-    def test_should_not_timeout(self):
-        res = post(batch=[{
-            'distinct_id': 'distinct_id',
-            'event': 'python event',
-            'type': 'track'
-        }], timeout=15)
-        self.assertEqual(res.status_code, 200)
-
-    def test_should_timeout(self):
-        with self.assertRaises(requests.ReadTimeout):
-            post(batch=[{
-                'distinct_id': 'distinct_id',
-                'event': 'python event',
-                'type': 'track'
-            }], timeout=0.0001)

posthog/test/test_consumer.py

@@ -1,22 +1,23 @@
-import unittest
-import mock
-import time
 import json
+import time
+import unittest
+
+import mock
 
 try:
     from queue import Queue
 except ImportError:
     from Queue import Queue
 
-from posthog.consumer import Consumer, MAX_MSG_SIZE
+from posthog.consumer import MAX_MSG_SIZE, Consumer
 from posthog.request import APIError
+from posthog.test.test_utils import TEST_API_KEY
 
 
 class TestConsumer(unittest.TestCase):
-
     def test_next(self):
         q = Queue()
-        consumer = Consumer(q, '')
+        consumer = Consumer(q, "")
         q.put(1)
         next = consumer.next()
         self.assertEqual(next, [1])
@@ -24,7 +25,7 @@ class TestConsumer(unittest.TestCase):
     def test_next_limit(self):
         q = Queue()
         flush_at = 50
-        consumer = Consumer(q, '', flush_at)
+        consumer = Consumer(q, "", flush_at)
         for i in range(10000):
             q.put(i)
         next = consumer.next()
@@ -32,8 +33,8 @@ class TestConsumer(unittest.TestCase):
 
     def test_dropping_oversize_msg(self):
         q = Queue()
-        consumer = Consumer(q, '')
-        oversize_msg = {'m': 'x' * MAX_MSG_SIZE}
+        consumer = Consumer(q, "")
+        oversize_msg = {"m": "x" * MAX_MSG_SIZE}
         q.put(oversize_msg)
         next = consumer.next()
         self.assertEqual(next, [])
@@ -41,12 +42,8 @@ class TestConsumer(unittest.TestCase):
 
     def test_upload(self):
         q = Queue()
-        consumer = Consumer(q, 'testsecret')
-        track = {
-            'type': 'track',
-            'event': 'python event',
-            'distinct_id': 'distinct_id'
-        }
+        consumer = Consumer(q, TEST_API_KEY)
+        track = {"type": "track", "event": "python event", "distinct_id": "distinct_id"}
         q.put(track)
         success = consumer.upload()
         self.assertTrue(success)
@@ -57,16 +54,11 @@ class TestConsumer(unittest.TestCase):
         # The consumer should upload _n_ times.
         q = Queue()
         flush_interval = 0.3
-        consumer = Consumer(q, 'testsecret', flush_at=10,
-                            flush_interval=flush_interval)
-        with mock.patch('analytics.consumer.post') as mock_post:
+        consumer = Consumer(q, TEST_API_KEY, flush_at=10, flush_interval=flush_interval)
+        with mock.patch("posthog.consumer.batch_post") as mock_post:
             consumer.start()
             for i in range(0, 3):
-                track = {
-                    'type': 'track',
-                    'event': 'python event %d' % i,
-                    'distinct_id': 'distinct_id'
-                }
+                track = {"type": "track", "event": "python event %d" % i, "distinct_id": "distinct_id"}
                 q.put(track)
                 time.sleep(flush_interval * 1.1)
             self.assertEqual(mock_post.call_count, 3)
@@ -77,45 +69,30 @@ class TestConsumer(unittest.TestCase):
         q = Queue()
         flush_interval = 0.5
         flush_at = 10
-        consumer = Consumer(q, 'testsecret', flush_at=flush_at,
-                            flush_interval=flush_interval)
-        with mock.patch('analytics.consumer.post') as mock_post:
+        consumer = Consumer(q, TEST_API_KEY, flush_at=flush_at, flush_interval=flush_interval)
+        with mock.patch("posthog.consumer.batch_post") as mock_post:
             consumer.start()
             for i in range(0, flush_at * 2):
-                track = {
-                    'type': 'track',
-                    'event': 'python event %d' % i,
-                    'distinct_id': 'distinct_id'
-                }
+                track = {"type": "track", "event": "python event %d" % i, "distinct_id": "distinct_id"}
                 q.put(track)
             time.sleep(flush_interval * 1.1)
             self.assertEqual(mock_post.call_count, 2)
 
     def test_request(self):
-        consumer = Consumer(None, 'testsecret')
-        track = {
-            'type': 'track',
-            'event': 'python event',
-            'distinct_id': 'distinct_id'
-        }
+        consumer = Consumer(None, TEST_API_KEY)
+        track = {"type": "track", "event": "python event", "distinct_id": "distinct_id"}
         consumer.request([track])
 
-    def _test_request_retry(self, consumer,
-                            expected_exception, exception_count):
-
+    def _test_request_retry(self, consumer, expected_exception, exception_count):
         def mock_post(*args, **kwargs):
             mock_post.call_count += 1
             if mock_post.call_count <= exception_count:
                 raise expected_exception
+
         mock_post.call_count = 0
 
-        with mock.patch('analytics.consumer.post',
-                        mock.Mock(side_effect=mock_post)):
-            track = {
-                'type': 'track',
-                'event': 'python event',
-                'distinct_id': 'distinct_id'
-            }
+        with mock.patch("posthog.consumer.batch_post", mock.Mock(side_effect=mock_post)):
+            track = {"type": "track", "event": "python event", "distinct_id": "distinct_id"}
             # request() should succeed if the number of exceptions raised is
             # less than the retries paramater.
             if exception_count <= consumer.retries:
@@ -130,69 +107,63 @@ class TestConsumer(unittest.TestCase):
                     self.assertEqual(exc, expected_exception)
                 else:
                     self.fail(
-                        "request() should raise an exception if still failing "
-                        "after %d retries" % consumer.retries)
+                        "request() should raise an exception if still failing after %d retries" % consumer.retries
+                    )
 
     def test_request_retry(self):
         # we should retry on general errors
-        consumer = Consumer(None, 'testsecret')
-        self._test_request_retry(consumer, Exception('generic exception'), 2)
+        consumer = Consumer(None, TEST_API_KEY)
+        self._test_request_retry(consumer, Exception("generic exception"), 2)
 
         # we should retry on server errors
-        consumer = Consumer(None, 'testsecret')
-        self._test_request_retry(consumer, APIError(
-            500, 'code', 'Internal Server Error'), 2)
+        consumer = Consumer(None, TEST_API_KEY)
+        self._test_request_retry(consumer, APIError(500, "Internal Server Error"), 2)
 
         # we should retry on HTTP 429 errors
-        consumer = Consumer(None, 'testsecret')
-        self._test_request_retry(consumer, APIError(
-            429, 'code', 'Too Many Requests'), 2)
+        consumer = Consumer(None, TEST_API_KEY)
+        self._test_request_retry(consumer, APIError(429, "Too Many Requests"), 2)
 
         # we should NOT retry on other client errors
-        consumer = Consumer(None, 'testsecret')
-        api_error = APIError(400, 'code', 'Client Errors')
+        consumer = Consumer(None, TEST_API_KEY)
+        api_error = APIError(400, "Client Errors")
         try:
             self._test_request_retry(consumer, api_error, 1)
         except APIError:
             pass
         else:
-            self.fail('request() should not retry on client errors')
+            self.fail("request() should not retry on client errors")
 
         # test for number of exceptions raise > retries value
-        consumer = Consumer(None, 'testsecret', retries=3)
-        self._test_request_retry(consumer, APIError(
-            500, 'code', 'Internal Server Error'), 3)
+        consumer = Consumer(None, TEST_API_KEY, retries=3)
+        self._test_request_retry(consumer, APIError(500, "Internal Server Error"), 3)
 
     def test_pause(self):
-        consumer = Consumer(None, 'testsecret')
+        consumer = Consumer(None, TEST_API_KEY)
         consumer.pause()
         self.assertFalse(consumer.running)
 
     def test_max_batch_size(self):
         q = Queue()
-        consumer = Consumer(
-            q, 'testsecret', flush_at=100000, flush_interval=3)
-        track = {
-            'type': 'track',
-            'event': 'python event',
-            'distinct_id': 'distinct_id'
-        }
+        consumer = Consumer(q, TEST_API_KEY, flush_at=100000, flush_interval=3)
+        properties = {}
+        for n in range(0, 500):
+            properties[str(n)] = "one_long_property_value_to_build_a_big_event"
+        track = {"type": "track", "event": "python event", "distinct_id": "distinct_id", "properties": properties}
         msg_size = len(json.dumps(track).encode())
-        # number of messages in a maximum-size batch
-        n_msgs = int(475000 / msg_size)
+        # Let's capture 8MB of data to trigger two batches
+        n_msgs = int(8_000_000 / msg_size)
 
         def mock_post_fn(_, data, **kwargs):
             res = mock.Mock()
             res.status_code = 200
-            self.assertTrue(len(data.encode()) < 500000,
-                            'batch size (%d) exceeds 500KB limit'
-                            % len(data.encode()))
+            request_size = len(data.encode())
+            # Batches close after the first message bringing it bigger than BATCH_SIZE_LIMIT, let's add 10% of margin
+            self.assertTrue(request_size < (5 * 1024 * 1024) * 1.1, "batch size (%d) higher than limit" % request_size)
             return res
 
-        with mock.patch('analytics.request._session.post',
-                        side_effect=mock_post_fn) as mock_post:
+        with mock.patch("posthog.request._session.post", side_effect=mock_post_fn) as mock_post:
             consumer.start()
             for _ in range(0, n_msgs + 2):
                 q.put(track)
             q.join()
-            self.assertEquals(mock_post.call_count, 2)
+            self.assertEqual(mock_post.call_count, 2)

posthog/test/test_exception_capture.py

@@ -0,0 +1,63 @@
+import subprocess
+import sys
+from textwrap import dedent
+
+import pytest
+
+
+def test_excepthook(tmpdir):
+    app = tmpdir.join("app.py")
+    app.write(
+        dedent(
+            """
+    from posthog import Posthog
+    posthog = Posthog('phc_x', host='https://eu.i.posthog.com', enable_exception_autocapture=True, debug=True, on_error=lambda e, batch: print('error handling batch: ', e, batch))
+
+    # frame_value = "LOL"
+
+    1/0
+    """
+        )
+    )
+
+    with pytest.raises(subprocess.CalledProcessError) as excinfo:
+        subprocess.check_output([sys.executable, str(app)], stderr=subprocess.STDOUT)
+
+    output = excinfo.value.output
+
+    assert b"ZeroDivisionError" in output
+    assert b"LOL" in output
+    assert b"DEBUG:posthog:data uploaded successfully" in output
+    assert (
+        b'"$exception_list": [{"mechanism": {"type": "generic", "handled": true}, "module": null, "type": "ZeroDivisionError", "value": "division by zero", "stacktrace": {"frames": [{"filename": "app.py", "abs_path"'
+        in output
+    )
+
+
+def test_trying_to_use_django_integration(tmpdir):
+    app = tmpdir.join("app.py")
+    app.write(
+        dedent(
+            """
+    from posthog import Posthog, Integrations
+    posthog = Posthog('phc_x', host='https://eu.i.posthog.com', enable_exception_autocapture=True, exception_autocapture_integrations=[Integrations.Django], debug=True, on_error=lambda e, batch: print('error handling batch: ', e, batch))
+
+    # frame_value = "LOL"
+
+    1/0
+    """
+        )
+    )
+
+    with pytest.raises(subprocess.CalledProcessError) as excinfo:
+        subprocess.check_output([sys.executable, str(app)], stderr=subprocess.STDOUT)
+
+    output = excinfo.value.output
+
+    assert b"ZeroDivisionError" in output
+    assert b"LOL" in output
+    assert b"DEBUG:posthog:data uploaded successfully" in output
+    assert (
+        b'"$exception_list": [{"mechanism": {"type": "generic", "handled": true}, "module": null, "type": "ZeroDivisionError", "value": "division by zero", "stacktrace": {"frames": [{"filename": "app.py", "abs_path"'
+        in output
+    )

posthog/test/test_module.py

@@ -0,0 +1,48 @@
+import unittest
+
+from posthog import Posthog
+
+
+class TestModule(unittest.TestCase):
+    posthog = None
+
+    def _assert_enqueue_result(self, result):
+        self.assertEqual(type(result[0]), bool)
+        self.assertEqual(type(result[1]), dict)
+
+    def failed(self):
+        self.failed = True
+
+    def setUp(self):
+        self.failed = False
+        self.posthog = Posthog("testsecret", host="http://localhost:8000", on_error=self.failed)
+
+    def test_no_api_key(self):
+        self.posthog.api_key = None
+        self.assertRaises(Exception, self.posthog.capture)
+
+    def test_no_host(self):
+        self.posthog.host = None
+        self.assertRaises(Exception, self.posthog.capture)
+
+    def test_track(self):
+        res = self.posthog.capture("distinct_id", "python module event")
+        self._assert_enqueue_result(res)
+        self.posthog.flush()
+
+    def test_identify(self):
+        res = self.posthog.identify("distinct_id", {"email": "user@email.com"})
+        self._assert_enqueue_result(res)
+        self.posthog.flush()
+
+    def test_alias(self):
+        res = self.posthog.alias("previousId", "distinct_id")
+        self._assert_enqueue_result(res)
+        self.posthog.flush()
+
+    def test_page(self):
+        self.posthog.page("distinct_id", "https://posthog.com/contact")
+        self.posthog.flush()
+
+    def test_flush(self):
+        self.posthog.flush()

posthog/test/test_request.py

@@ -0,0 +1,68 @@
+import json
+import unittest
+from datetime import date, datetime
+
+import pytest
+import requests
+
+from posthog.request import DatetimeSerializer, batch_post, determine_server_host
+from posthog.test.test_utils import TEST_API_KEY
+
+
+class TestRequests(unittest.TestCase):
+    def test_valid_request(self):
+        res = batch_post(TEST_API_KEY, batch=[{"distinct_id": "distinct_id", "event": "python event", "type": "track"}])
+        self.assertEqual(res.status_code, 200)
+
+    def test_invalid_request_error(self):
+        self.assertRaises(Exception, batch_post, "testsecret", "https://t.posthog.com", False, "[{]")
+
+    def test_invalid_host(self):
+        self.assertRaises(Exception, batch_post, "testsecret", "t.posthog.com/", batch=[])
+
+    def test_datetime_serialization(self):
+        data = {"created": datetime(2012, 3, 4, 5, 6, 7, 891011)}
+        result = json.dumps(data, cls=DatetimeSerializer)
+        self.assertEqual(result, '{"created": "2012-03-04T05:06:07.891011"}')
+
+    def test_date_serialization(self):
+        today = date.today()
+        data = {"created": today}
+        result = json.dumps(data, cls=DatetimeSerializer)
+        expected = '{"created": "%s"}' % today.isoformat()
+        self.assertEqual(result, expected)
+
+    def test_should_not_timeout(self):
+        res = batch_post(
+            TEST_API_KEY, batch=[{"distinct_id": "distinct_id", "event": "python event", "type": "track"}], timeout=15
+        )
+        self.assertEqual(res.status_code, 200)
+
+    def test_should_timeout(self):
+        with self.assertRaises(requests.ReadTimeout):
+            batch_post(
+                "key", batch=[{"distinct_id": "distinct_id", "event": "python event", "type": "track"}], timeout=0.0001
+            )
+
+
+@pytest.mark.parametrize(
+    "host, expected",
+    [
+        ("https://t.posthog.com", "https://t.posthog.com"),
+        ("https://t.posthog.com/", "https://t.posthog.com/"),
+        ("t.posthog.com", "t.posthog.com"),
+        ("t.posthog.com/", "t.posthog.com/"),
+        ("https://us.posthog.com.rg.proxy.com", "https://us.posthog.com.rg.proxy.com"),
+        ("app.posthog.com", "app.posthog.com"),
+        ("eu.posthog.com", "eu.posthog.com"),
+        ("https://app.posthog.com", "https://us.i.posthog.com"),
+        ("https://eu.posthog.com", "https://eu.i.posthog.com"),
+        ("https://us.posthog.com", "https://us.i.posthog.com"),
+        ("https://app.posthog.com/", "https://us.i.posthog.com"),
+        ("https://eu.posthog.com/", "https://eu.i.posthog.com"),
+        ("https://us.posthog.com/", "https://us.i.posthog.com"),
+        (None, "https://us.i.posthog.com"),
+    ],
+)
+def test_routing_to_custom_host(host, expected):
+    assert determine_server_host(host) == expected

posthog/test/test_utils.py

@@ -0,0 +1,101 @@
+import unittest
+from datetime import date, datetime, timedelta
+from decimal import Decimal
+from uuid import UUID
+
+import six
+from dateutil.tz import tzutc
+
+from posthog import utils
+
+TEST_API_KEY = "kOOlRy2QlMY9jHZQv0bKz0FZyazBUoY8Arj0lFVNjs4"
+FAKE_TEST_API_KEY = "random_key"
+
+
+class TestUtils(unittest.TestCase):
+    def test_timezone_utils(self):
+        now = datetime.now()
+        utcnow = datetime.now(tz=tzutc())
+        self.assertTrue(utils.is_naive(now))
+        self.assertFalse(utils.is_naive(utcnow))
+
+        fixed = utils.guess_timezone(now)
+        self.assertFalse(utils.is_naive(fixed))
+
+        shouldnt_be_edited = utils.guess_timezone(utcnow)
+        self.assertEqual(utcnow, shouldnt_be_edited)
+
+    def test_clean(self):
+        simple = {
+            "decimal": Decimal("0.142857"),
+            "unicode": six.u("woo"),
+            "date": datetime.now(),
+            "long": 200000000,
+            "integer": 1,
+            "float": 2.0,
+            "bool": True,
+            "str": "woo",
+            "none": None,
+        }
+
+        complicated = {
+            "exception": Exception("This should show up"),
+            "timedelta": timedelta(microseconds=20),
+            "list": [1, 2, 3],
+        }
+
+        combined = dict(simple.items())
+        combined.update(complicated.items())
+
+        pre_clean_keys = combined.keys()
+
+        utils.clean(combined)
+        self.assertEqual(combined.keys(), pre_clean_keys)
+
+        # test UUID separately, as the UUID object doesn't equal its string representation according to Python
+        self.assertEqual(utils.clean(UUID("12345678123456781234567812345678")), "12345678-1234-5678-1234-567812345678")
+
+    def test_clean_with_dates(self):
+        dict_with_dates = {
+            "birthdate": date(1980, 1, 1),
+            "registration": datetime.utcnow(),
+        }
+        self.assertEqual(dict_with_dates, utils.clean(dict_with_dates))
+
+    def test_bytes(self):
+        if six.PY3:
+            item = bytes(10)
+        else:
+            item = bytearray(10)
+
+        utils.clean(item)
+
+    def test_clean_fn(self):
+        cleaned = utils.clean({"fn": lambda x: x, "number": 4})
+        self.assertEqual(cleaned["number"], 4)
+        # TODO: fixme, different behavior on python 2 and 3
+        if "fn" in cleaned:
+            self.assertEqual(cleaned["fn"], None)
+
+    def test_remove_slash(self):
+        self.assertEqual("http://posthog.io", utils.remove_trailing_slash("http://posthog.io/"))
+        self.assertEqual("http://posthog.io", utils.remove_trailing_slash("http://posthog.io"))
+
+
+class TestSizeLimitedDict(unittest.TestCase):
+    def test_size_limited_dict(self):
+        size = 10
+        values = utils.SizeLimitedDict(size, lambda _: -1)
+
+        for i in range(100):
+            values[i] = i
+
+            self.assertEqual(values[i], i)
+            self.assertEqual(len(values), i % size + 1)
+
+            if i % size == 0:
+                # old numbers should've been removed
+                self.assertIsNone(values.get(i - 1))
+                self.assertIsNone(values.get(i - 3))
+                self.assertIsNone(values.get(i - 5))
+                self.assertIsNone(values.get(i - 9))

posthog/test/utils.py

@@ -1,78 +0,0 @@
-from datetime import date, datetime, timedelta
-from decimal import Decimal
-import unittest
-
-from dateutil.tz import tzutc
-import six
-
-from posthog import utils
-
-
-class TestUtils(unittest.TestCase):
-
-    def test_timezone_utils(self):
-        now = datetime.now()
-        utcnow = datetime.now(tz=tzutc())
-        self.assertTrue(utils.is_naive(now))
-        self.assertFalse(utils.is_naive(utcnow))
-
-        fixed = utils.guess_timezone(now)
-        self.assertFalse(utils.is_naive(fixed))
-
-        shouldnt_be_edited = utils.guess_timezone(utcnow)
-        self.assertEqual(utcnow, shouldnt_be_edited)
-
-    def test_clean(self):
-        simple = {
-            'decimal': Decimal('0.142857'),
-            'unicode': six.u('woo'),
-            'date': datetime.now(),
-            'long': 200000000,
-            'integer': 1,
-            'float': 2.0,
-            'bool': True,
-            'str': 'woo',
-            'none': None
-        }
-
-        complicated = {
-            'exception': Exception('This should show up'),
-            'timedelta': timedelta(microseconds=20),
-            'list': [1, 2, 3]
-        }
-
-        combined = dict(simple.items())
-        combined.update(complicated.items())
-
-        pre_clean_keys = combined.keys()
-
-        utils.clean(combined)
-        self.assertEqual(combined.keys(), pre_clean_keys)
-
-    def test_clean_with_dates(self):
-        dict_with_dates = {
-            'birthdate': date(1980, 1, 1),
-            'registration': datetime.utcnow(),
-        }
-        self.assertEqual(dict_with_dates, utils.clean(dict_with_dates))
-
-    def test_bytes(self):
-        if six.PY3:
-            item = bytes(10)
-        else:
-            item = bytearray(10)
-
-        utils.clean(item)
-
-    def test_clean_fn(self):
-        cleaned = utils.clean({'fn': lambda x: x, 'number': 4})
-        self.assertEqual(cleaned['number'], 4)
-        # TODO: fixme, different behavior on python 2 and 3
-        if 'fn' in cleaned:
-            self.assertEqual(cleaned['fn'], None)
-
-    def test_remove_slash(self):
-        self.assertEqual('http://posthog.io',
-                         utils.remove_trailing_slash('http://posthog.io/'))
-        self.assertEqual('http://posthog.io',
-                         utils.remove_trailing_slash('http://posthog.io'))

posthog/utils.py

@@ -1,12 +1,15 @@
-from dateutil.tz import tzlocal, tzutc
-from datetime import date, datetime
-from decimal import Decimal
 import logging
 import numbers
+import re
+from collections import defaultdict
+from datetime import date, datetime, timezone
+from decimal import Decimal
+from uuid import UUID
 
 import six
+from dateutil.tz import tzlocal, tzutc
 
-log = logging.getLogger('posthog')
+log = logging.getLogger("posthog")
 
 
 def is_naive(dt):
@@ -17,8 +20,7 @@ def is_naive(dt):
 def total_seconds(delta):
     """Determines total seconds with python < 2.7 compat."""
     # http://stackoverflow.com/questions/3694835/python-2-6-5-divide-timedelta-with-timedelta
-    return (delta.microseconds
-            + (delta.seconds + delta.days * 24 * 3600) * 1e6) / 1e6
+    return (delta.microseconds + (delta.seconds + delta.days * 24 * 3600) * 1e6) / 1e6
 
 
 def guess_timezone(dt):
@@ -39,7 +41,7 @@ def guess_timezone(dt):
 
 
 def remove_trailing_slash(host):
-    if host.endswith('/'):
+    if host.endswith("/"):
         return host[:-1]
     return host
 
@@ -47,8 +49,9 @@ def remove_trailing_slash(host):
 def clean(item):
     if isinstance(item, Decimal):
         return float(item)
-    elif isinstance(item, (six.string_types, bool, numbers.Number, datetime,
-                           date, type(None))):
+    if isinstance(item, UUID):
+        return str(item)
+    elif isinstance(item, (six.string_types, bool, numbers.Number, datetime, date, type(None))):
         return item
     elif isinstance(item, (set, list, tuple)):
         return _clean_list(item)
@@ -69,9 +72,10 @@ def _clean_dict(dict_):
             data[k] = clean(v)
         except TypeError:
             log.warning(
-                'Dictionary values must be serializeable to '
-                'JSON "%s" value %s of type %s is unsupported.',
-                k, v, type(v),
+                'Dictionary values must be serializeable to JSON "%s" value %s of type %s is unsupported.',
+                k,
+                v,
+                type(v),
             )
     return data
 
@@ -82,6 +86,32 @@ def _coerce_unicode(cmplx):
     except AttributeError as exception:
         item = ":".join(exception)
         item.decode("utf-8", "strict")
-        log.warning('Error decoding: %s', item)
+        log.warning("Error decoding: %s", item)
         return None
     return item
+
+
+def is_valid_regex(value) -> bool:
+    try:
+        re.compile(value)
+        return True
+    except re.error:
+        return False
+
+
+class SizeLimitedDict(defaultdict):
+    def __init__(self, max_size, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.max_size = max_size
+
+    def __setitem__(self, key, value):
+        if len(self) >= self.max_size:
+            self.clear()
+
+        super().__setitem__(key, value)
+
+
+def convert_to_datetime_aware(date_obj):
+    if date_obj.tzinfo is None:
+        date_obj = date_obj.replace(tzinfo=timezone.utc)
+    return date_obj

posthog/version.py

@@ -1 +1,4 @@
-VERSION = '1.0.6'
+VERSION = "3.6.4"
+
+if __name__ == "__main__":
+    print(VERSION, end="")  # noqa: T201

pyproject.toml

@@ -0,0 +1,10 @@
+[tool.black]
+line-length = 120
+
+[tool.isort]
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 8
+ensure_newline_before_comments = true
+line_length = 120
+virtual_env = "env"

sentry_django_example/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sentry_django_example.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

sentry_django_example/sentry_django_example/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for sentry_django_example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sentry_django_example.settings")
+
+application = get_asgi_application()

sentry_django_example/sentry_django_example/settings.py

@@ -0,0 +1,167 @@
+"""
+Django settings for sentry_django_example project.
+
+Generated by 'django-admin startproject' using Django 3.2.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+from pathlib import Path
+from uuid import uuid4
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-4kzfiq7vb(t0+jbl#vq)u=%06ouf)n*=l%730c8=tk(wkm9i9o"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# PostHog Setup (can be a separate app)
+import posthog
+
+# You can find this key on the /setup page in PostHog
+posthog.api_key = "LXP6nQXvo-2TCqGVrWvPah8uJIyVykoMmhnEkEBi5PA"  # TODO: replace with your api key
+
+posthog.personal_api_key = ""
+
+# Where you host PostHog, with no trailing /.
+# You can remove this line if you're using posthog.com
+posthog.host = "http://127.0.0.1:8000"
+
+from posthog.sentry.posthog_integration import PostHogIntegration
+
+PostHogIntegration.organization = "posthog"  # TODO: your sentry organization
+# PostHogIntegration.prefix = # TODO: your self hosted Sentry url. (default: https://sentry.io/organizations/)
+
+# Since Sentry doesn't allow Integrations configuration (see https://github.com/getsentry/sentry-python/blob/master/sentry_sdk/integrations/__init__.py#L171-L183)
+# we work around this by setting static class variables beforehand
+
+# Sentry Setup
+import sentry_sdk
+from sentry_sdk.integrations.django import DjangoIntegration
+
+sentry_sdk.init(
+    dsn="https://27ac54f7f4cf484abf1335436b0c52e5@o344752.ingest.sentry.io/5624115",  # TODO: your Sentry DSN here
+    integrations=[DjangoIntegration(), PostHogIntegration()],
+    # Set traces_sample_rate to 1.0 to capture 100%
+    # of transactions for performance monitoring.
+    # We recommend adjusting this value in production.
+    traces_sample_rate=1.0,
+    # If you wish to associate users to errors (assuming you are using
+    # django.contrib.auth) you may enable sending PII data.
+    send_default_pii=True,
+)
+
+POSTHOG_DJANGO = {
+    "distinct_id": lambda request: str(uuid4())  # TODO: your logic for generating unique ID, given the request object
+}
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "posthog.sentry.django.PosthogDistinctIdMiddleware",
+]
+
+ROOT_URLCONF = "sentry_django_example.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "sentry_django_example.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+
+STATIC_URL = "/static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

sentry_django_example/sentry_django_example/urls.py

@@ -0,0 +1,28 @@
+"""sentry_django_example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+
+
+def trigger_error(request):
+    division_by_zero = 1 / 0
+
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("sentry-debug/", trigger_error),
+]

sentry_django_example/sentry_django_example/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for sentry_django_example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sentry_django_example.settings")
+
+application = get_wsgi_application()

setup.py

@@ -1,4 +1,3 @@
-
 import os
 import sys
 
@@ -8,39 +7,41 @@ except ImportError:
     from distutils.core import setup
 
 # Don't import analytics-python module here, since deps may not be installed
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'posthog'))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "posthog"))
 from version import VERSION
 
-long_description = '''
+long_description = """
 PostHog is developer-friendly, self-hosted product analytics. posthog-python is the python package.
-'''
+"""
 
-install_requires = [
-    "requests>=2.7,<3.0",
-    "six>=1.5",
-    "monotonic>=1.5",
-    "backoff==1.6.0",
-    "python-dateutil>2.1"
-]
+install_requires = ["requests>=2.7,<3.0", "six>=1.5", "monotonic>=1.5", "backoff>=1.10.0", "python-dateutil>2.1"]
 
-tests_require = [
-    "mock>=2.0.0"
-]
+extras_require = {
+    "dev": [
+        "black",
+        "isort",
+        "flake8",
+        "flake8-print",
+        "pre-commit",
+    ],
+    "test": ["mock>=2.0.0", "freezegun==0.3.15", "pylint", "flake8", "coverage", "pytest", "pytest-timeout", "django"],
+    "sentry": ["sentry-sdk", "django"],
+}
 
 setup(
-    name='posthog',
+    name="posthog",
     version=VERSION,
-    url='https://github.com/posthog/posthog-python',
-    author='Posthog',
-    author_email='hey@posthog.com',
-    maintainer='PostHog',
-    maintainer_email='hey@posthog.com',
-    test_suite='posthog.test.all',
-    packages=['posthog', 'posthog.test'],
-    license='MIT License',
+    url="https://github.com/posthog/posthog-python",
+    author="Posthog",
+    author_email="hey@posthog.com",
+    maintainer="PostHog",
+    maintainer_email="hey@posthog.com",
+    test_suite="posthog.test.all",
+    packages=["posthog", "posthog.test", "posthog.sentry", "posthog.exception_integrations"],
+    license="MIT License",
     install_requires=install_requires,
-    tests_require=tests_require,
-    description='Integrate PostHog into any python application.',
+    extras_require=extras_require,
+    description="Integrate PostHog into any python application.",
     long_description=long_description,
     classifiers=[
         "Development Status :: 5 - Production/Stable",

setup_analytics.py

@@ -1,4 +1,3 @@
-
 import os
 import sys
 
@@ -8,39 +7,39 @@ except ImportError:
     from distutils.core import setup
 
 # Don't import module here, since deps may not be installed
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'posthoganalytics'))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "posthoganalytics"))
 from version import VERSION
 
-long_description = '''
+long_description = """
 PostHog is developer-friendly, self-hosted product analytics. posthog-python is the python package.
-'''
+"""
 
-install_requires = [
-    "requests>=2.7,<3.0",
-    "six>=1.5",
-    "monotonic>=1.5",
-    "backoff==1.6.0",
-    "python-dateutil>2.1"
-]
+install_requires = ["requests>=2.7,<3.0", "six>=1.5", "monotonic>=1.5", "backoff>=1.10.0", "python-dateutil>2.1"]
 
-tests_require = [
-    "mock>=2.0.0"
-]
+tests_require = ["mock>=2.0.0"]
 
 setup(
-    name='posthoganalytics',
+    name="posthoganalytics",
     version=VERSION,
-    url='https://github.com/posthog/posthog-python',
-    author='Posthog',
-    author_email='hey@posthog.com',
-    maintainer='PostHog',
-    maintainer_email='hey@posthog.com',
-    test_suite='posthoganalytics.test.all',
-    packages=['posthoganalytics', 'posthoganalytics.test'],
-    license='MIT License',
+    url="https://github.com/posthog/posthog-python",
+    author="Posthog",
+    author_email="hey@posthog.com",
+    maintainer="PostHog",
+    maintainer_email="hey@posthog.com",
+    test_suite="posthoganalytics.test.all",
+    packages=[
+        "posthoganalytics",
+        "posthoganalytics.test",
+        "posthoganalytics.sentry",
+        "posthoganalytics.exception_integrations",
+    ],
+    license="MIT License",
     install_requires=install_requires,
     tests_require=tests_require,
-    description='Integrate PostHog into any python application.',
+    extras_require={
+        "sentry": ["sentry-sdk", "django"],
+    },
+    description="Integrate PostHog into any python application.",
     long_description=long_description,
     classifiers=[
         "Development Status :: 5 - Production/Stable",

simulator.py

@@ -1,42 +1,39 @@
-import analytics
 import argparse
 import json
 import logging
 
-__name__ = 'simulator.py'
-__version__ = '0.0.1'
-__description__ = 'scripting simulator'
+import posthog
+
+__name__ = "simulator.py"
+__version__ = "0.0.1"
+__description__ = "scripting simulator"
 
 
 def json_hash(str):
     if str:
         return json.loads(str)
 
-# analytics -method=<method> -posthog-write-key=<posthogWriteKey> [options]
+
+# posthog -method=<method> -posthog-write-key=<posthogWriteKey> [options]
 
 
-parser = argparse.ArgumentParser(description='send a posthog message')
+parser = argparse.ArgumentParser(description="send a posthog message")
 
-parser.add_argument('--writeKey', help='the posthog writeKey')
-parser.add_argument('--type', help='The posthog message type')
+parser.add_argument("--writeKey", help="the posthog writeKey")
+parser.add_argument("--type", help="The posthog message type")
 
-parser.add_argument('--distinct_id', help='the user id to send the event as')
-parser.add_argument(
-    '--anonymousId', help='the anonymous user id to send the event as')
-parser.add_argument(
-    '--context', help='additional context for the event (JSON-encoded)')
+parser.add_argument("--distinct_id", help="the user id to send the event as")
+parser.add_argument("--anonymousId", help="the anonymous user id to send the event as")
+parser.add_argument("--context", help="additional context for the event (JSON-encoded)")
 
-parser.add_argument('--event', help='the event name to send with the event')
-parser.add_argument(
-    '--properties', help='the event properties to send (JSON-encoded)')
+parser.add_argument("--event", help="the event name to send with the event")
+parser.add_argument("--properties", help="the event properties to send (JSON-encoded)")
 
-parser.add_argument(
-    '--name', help='name of the screen or page to send with the message')
+parser.add_argument("--name", help="name of the screen or page to send with the message")
 
-parser.add_argument(
-    '--traits', help='the identify/group traits to send (JSON-encoded)')
+parser.add_argument("--traits", help="the identify/group traits to send (JSON-encoded)")
 
-parser.add_argument('--groupId', help='the group id')
+parser.add_argument("--groupId", help="the group id")
 
 options = parser.parse_args()
 
@@ -45,55 +42,69 @@ def failed(status, msg):
     raise Exception(msg)
 
 
-def track():
-    analytics.track(options.distinct_id, options.event, anonymous_id=options.anonymousId,
-                    properties=json_hash(options.properties), context=json_hash(options.context))
+def capture():
+    posthog.capture(
+        options.distinct_id,
+        options.event,
+        anonymous_id=options.anonymousId,
+        properties=json_hash(options.properties),
+        context=json_hash(options.context),
+    )
 
 
 def page():
-    analytics.page(options.distinct_id, name=options.name, anonymous_id=options.anonymousId,
-                   properties=json_hash(options.properties), context=json_hash(options.context))
-
-
-def screen():
-    analytics.screen(options.distinct_id, name=options.name, anonymous_id=options.anonymousId,
-                     properties=json_hash(options.properties), context=json_hash(options.context))
+    posthog.page(
+        options.distinct_id,
+        name=options.name,
+        anonymous_id=options.anonymousId,
+        properties=json_hash(options.properties),
+        context=json_hash(options.context),
+    )
 
 
 def identify():
-    analytics.identify(options.distinct_id, anonymous_id=options.anonymousId,
-                       traits=json_hash(options.traits), context=json_hash(options.context))
+    posthog.identify(
+        options.distinct_id,
+        anonymous_id=options.anonymousId,
+        traits=json_hash(options.traits),
+        context=json_hash(options.context),
+    )
 
 
-def group():
-    analytics.group(options.distinct_id, options.groupId, json_hash(options.traits),
-                    json_hash(options.context), anonymous_id=options.anonymousId)
+def set_once():
+    posthog.set_once(
+        options.distinct_id,
+        properties=json_hash(options.traits),
+        context=json_hash(options.context),
+    )
+
+
+def set():
+    posthog.set(
+        options.distinct_id,
+        properties=json_hash(options.traits),
+        context=json_hash(options.context),
+    )
 
 
 def unknown():
     print()
 
 
-analytics.api_key = options.writeKey
-analytics.on_error = failed
-analytics.debug = True
+posthog.api_key = options.writeKey
+posthog.on_error = failed
+posthog.debug = True
 
-log = logging.getLogger('posthog')
+log = logging.getLogger("posthog")
 ch = logging.StreamHandler()
 ch.setLevel(logging.DEBUG)
 log.addHandler(ch)
 
-switcher = {
-    "track": track,
-    "page": page,
-    "screen": screen,
-    "identify": identify,
-    "group": group
-}
+switcher = {"capture": capture, "page": page, "identify": identify, "set_once": set_once, "set": set}
 
 func = switcher.get(options.type)
 if func:
     func()
-    analytics.shutdown()
+    posthog.shutdown()
 else:
     print("Invalid Message Type " + options.type)