Skip to content

fix: propagate module-level settings to default client - #793

Merged
marandaneto merged 3 commits into
mainfrom
fix/module-level-settings-768
Jul 28, 2026
Merged

fix: propagate module-level settings to default client#793
marandaneto merged 3 commits into
mainfrom
fix/module-level-settings-768

Conversation

@marandaneto

@marandaneto marandaneto commented Jul 27, 2026

Copy link
Copy Markdown
Member

💡 Motivation and Context

Module-level configuration is intended to configure the lazily initialized default client, but privacy_mode, project_root, and project_api_key were not propagated. In particular, setting posthog.privacy_mode = True still allowed AI wrappers to capture full prompts and outputs.

This also clarifies the established API key naming: project_api_key is the preferred setting and takes precedence, while api_key is the deprecated legacy alias retained for backwards compatibility. Each candidate is trimmed before precedence is applied, so a blank preferred value falls back to a valid legacy value.

Fixes #768.

💚 How did you test it?

  • python -m pytest -q posthog/test/test_module.py posthog/test/ai/openai/test_openai.py::test_privacy_mode_global posthog/test/test_code_variables.py (186 passed)
  • ruff format --check posthog/__init__.py posthog/test/test_module.py
  • ruff check posthog/__init__.py posthog/test/test_module.py
  • python -W error -c "import posthog"

📝 Checklist

  • I reviewed the submitted code.
  • I added tests to verify the changes.
  • I updated the docs if needed.
  • No breaking change or entry added to the changelog.

If releasing new changes

  • Ran sampo add to generate a changeset file

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Implemented with the Pi coding agent after validating the issue against the current source and confirming the API key naming history in issues #31 and #33 and PR #32. The API key resolution preserves the SDK's established project_api_key or api_key precedence after normalizing both values, while privacy mode is re-synchronized on repeated setup() calls so late module-level changes take effect. A human-authored review is still required; no agent session transcript was published.

@marandaneto marandaneto self-assigned this Jul 27, 2026
@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

posthog-python Compliance Report

Date: 2026-07-28 13:29:29 UTC
Duration: 338851ms

✅ All Tests Passed!

111/111 tests passed


Capture_V1 Tests

94/94 tests passed

View Details
Test Status Duration
Endpoint And Method.Targets V1 Endpoint 516ms
Endpoint And Method.Does Not Use Legacy Endpoints 1010ms
Required Headers.Has Authorization Bearer Header 1009ms
Required Headers.Has Content Type Json 1009ms
Required Headers.Has Posthog Sdk Info Format 1009ms
Required Headers.Has Posthog Attempt Header 1010ms
Required Headers.Has Posthog Request Id 1010ms
Required Headers.Has Posthog Request Timestamp 1009ms
Required Headers.Has User Agent 1011ms
Body Format.Body Has Created At And Batch 1009ms
Body Format.No Api Key In Body 1009ms
Body Format.No Sent At In Body 1009ms
Event Format.Event Has Required Root Fields 1010ms
Event Format.Event Uuid Is Valid 1009ms
Event Format.Event Timestamp Is Rfc3339 1010ms
Event Format.Distinct Id Is String 1009ms
Event Format.Distinct Id At Root Not Properties 1009ms
Event Format.Custom Properties Preserved 1009ms
Event Format.Set Properties Preserved 1010ms
Event Format.Set Once Properties Preserved 1010ms
Event Format.Groups Properties Preserved 1010ms
Event Format.Sdk Generates Uuid If Not Provided 1009ms
Event Format.Event Has Required Root Fields Batch 1014ms
Event Format.Event Uuid Is Valid Batch 1014ms
Event Format.Event Timestamp Is Rfc3339 Batch 1014ms
Event Format.Distinct Id Is String Batch 1014ms
Event Format.Distinct Id At Root Not Properties Batch 1013ms
Event Format.Custom Properties Preserved Batch 1013ms
Event Format.Set Properties Preserved Batch 1014ms
Event Format.Set Once Properties Preserved Batch 1014ms
Event Format.Groups Properties Preserved Batch 1013ms
Event Format.Sdk Generates Uuid If Not Provided Batch 1013ms
Batch Behavior.Multiple Events In Single Batch 1507ms
Batch Behavior.Batch Envelope Smoke 1015ms
Batch Behavior.Flush With No Events Sends Nothing 1006ms
Batch Behavior.Flush At Triggers Batch 1508ms
Batch Behavior.Created At Reflects Batch Creation Time 1012ms
Deduplication.Generates Unique Uuids 1507ms
Deduplication.Different Events Same Content Different Uuids 1507ms
Deduplication.Preserves Uuid On Retry 7515ms
Deduplication.Preserves Timestamp On Retry 7511ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry 7514ms
Deduplication.No Duplicate Events In Batch 1503ms
Header Behavior On Retry.Attempt Header Starts At One 1009ms
Header Behavior On Retry.Attempt Header Increments On Retry 14524ms
Header Behavior On Retry.Request Id Preserved On Retry 7504ms
Header Behavior On Retry.Different Requests Have Different Request Ids 3521ms
Header Behavior On Retry.Request Timestamp Changes On Retry 7513ms
Response Format Validation.Success Response Has Uuid Keyed Results 1008ms
Response Format Validation.Success Response Has Ok For Each Event 1506ms
Response Format Validation.Success No Retry After When All Ok 1508ms
Response Format Validation.Success Retry After Present When Retry Events 2510ms
Response Format Validation.Success No Retry After When Drop Only 1507ms
Response Format Validation.Response Echoes Request Id 1009ms
Retry Behavior.Retries On 408 7514ms
Retry Behavior.Retries On 500 7509ms
Retry Behavior.Retries On 503 9517ms
Retry Behavior.Retries On 504 7513ms
Retry Behavior.Retryable Errors Have Retry After 4509ms
Retry Behavior.Respects Retry After On Retryable Error 12518ms
Retry Behavior.Does Not Retry On 400 3503ms
Retry Behavior.Does Not Retry On 401 3508ms
Retry Behavior.Does Not Retry On 402 3507ms
Retry Behavior.Does Not Retry On 413 3506ms
Retry Behavior.Does Not Retry On 415 3510ms
Retry Behavior.Non Retryable Errors Have No Retry After 3507ms
Retry Behavior.Implements Backoff 23531ms
Retry Behavior.Max Retries Respected 23521ms
Partial Batch Handling.Handles 200 Full Success 3000ms
Partial Batch Handling.Handles 200 With All Ok 4510ms
Partial Batch Handling.Does Not Retry Dropped Events 4507ms
Partial Batch Handling.Does Not Retry Limited Events 4507ms
Partial Batch Handling.Prunes Ok Events On Partial Retry 7516ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry 7513ms
Partial Batch Handling.Retries Only Retry Events From Partial 7508ms
Partial Batch Handling.Partial Retry Preserves Uuids 7516ms
Partial Batch Handling.Partial Retry Attempt Header Increments 7512ms
Partial Batch Handling.Partial Retry Request Id Preserved 7508ms
Partial Batch Handling.Respects Retry After On Partial 9512ms
Partial Batch Handling.Unknown Result Treated As Terminal 4511ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry 4508ms
Compression.Sends Gzip Content Encoding 1008ms
Compression.No Content Encoding When Disabled 1009ms
Compression.Compressed Body Is Decompressible 1010ms
Error Handling.Does Not Retry On Unknown 4Xx 3509ms
Event Options.Cookieless Mode Override 1008ms
Event Options.Disable Skew Correction Override 1010ms
Event Options.Process Person Profile Override 1009ms
Event Options.Product Tour Id Override 1010ms
Event Options.Unset Options Omitted 1010ms
Event Options.Options Override In Batch 1012ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties 1010ms
Geoip And Historical Migration.Historical Migration Set In Body 1010ms
Geoip And Historical Migration.Historical Migration Absent By Default 1009ms

Feature_Flags Tests

17/17 tests passed

View Details
Test Status Duration
Request Payload.Request With Person Properties Device Id 1008ms
Request Payload.Flags Request Uses V2 Query Param 1006ms
Request Payload.Flags Request Hits Flags Path Not Decide 1007ms
Request Payload.Flags Request Omits Authorization Header 1007ms
Request Payload.Token In Flags Body Matches Init 1007ms
Request Payload.Groups Round Trip 1006ms
Request Payload.Groups Default To Empty Object 1007ms
Request Payload.Disable Geoip False Propagates As Geoip Disable False 1007ms
Request Payload.Disable Geoip Omitted Defaults To False 1007ms
Request Payload.Flag Keys To Evaluate Contains Only Requested Key 1007ms
Request Lifecycle.No Flags Request On Init Alone 503ms
Request Lifecycle.No Flags Request On Normal Capture 1507ms
Request Lifecycle.Two Flag Calls Produce Two Remote Requests 1012ms
Request Lifecycle.Mock Response Value Is Returned To Caller 1002ms
Retry Behavior.Retries Flags On 502 1006ms
Retry Behavior.Retries Flags On 504 1007ms
Side Effect Events.Get Feature Flag Captures Feature Flag Called Event 1509ms

@marandaneto
marandaneto marked this pull request as ready for review July 27, 2026 20:37
@marandaneto
marandaneto requested a review from a team as a code owner July 27, 2026 20:37
@greptile-apps

greptile-apps Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All With AI
### Issue 1
posthog/__init__.py:1175
**Blank preferred key disables capture**

When `project_api_key` contains only whitespace and `api_key` is valid, this expression selects the truthy preferred key before trimming it, producing an empty configured key and disabling the default client, so module-level events are silently dropped.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: clarify module API key naming" | Re-trigger Greptile

1 similar comment
@greptile-apps

greptile-apps Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor
Prompt To Fix All With AI
### Issue 1
posthog/__init__.py:1175
**Blank preferred key disables capture**

When `project_api_key` contains only whitespace and `api_key` is valid, this expression selects the truthy preferred key before trimming it, producing an empty configured key and disabling the default client, so module-level events are silently dropped.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "docs: clarify module API key naming" | Re-trigger Greptile

Comment thread posthog/__init__.py Outdated

@ioannisj ioannisj left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, greptile comment caught my eye as well

@marandaneto
marandaneto enabled auto-merge (squash) July 28, 2026 13:26
@marandaneto
marandaneto merged commit 13de879 into main Jul 28, 2026
37 checks passed
@marandaneto
marandaneto deleted the fix/module-level-settings-768 branch July 28, 2026 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

privacy_mode set at module level never reaches the client, so AI wrappers capture full prompts and outputs

2 participants