docs: clarify reusable flush and terminal shutdown guidance

[marandaneto]

💡 Motivation and Context

The lifecycle docstrings discourage direct flush() use and tell serverless users to call shutdown(), even though shared clients must remain open for later invocations.

Clarify both instance and module-level guidance. Shared clients should flush before a short-lived invocation returns. Disposable clients and final process cleanup should use terminal shutdown.

The docs now distinguish timeout units, event and span draining, callback deferral, open spans, and delivery limitations. Neither call guarantees server receipt, and flush is not a strict whole-call wall-clock deadline. The current-version and latest generated references match the source docstrings.

No runtime logic, signatures, or public API changed. A patch Sampo changeset is included.

💚 How did you test it?

• 257 focused existing lifecycle, module, capture-lane, and tracing tests passed during implementation. The parent reran the 46 client lifecycle tests.
• Ruff format and lint, warnings-as-errors import, public API snapshot, reference generation, and whitespace checks passed.
• Source AST comparison excluding docstrings confirmed unchanged runtime logic.
• Generated references changed only the four instance/module flush/shutdown records.
• No tests or test infrastructure changed. Existing behavioral coverage was retained rather than adding tests that assert prose.
• Full repository, mypy, provider, and mirror checks were not run for this documentation-only change. Tests used mocked transports.
• autoreview --mode branch --base origin/main passed for aef811ed95c36f0f8bd7172881fca3dad5c832ec with no actionable findings.

📝 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.

No new tests were needed because runtime behavior is unchanged. Existing lifecycle tests validate the documented behavior.

If releasing new changes

• Ran sampo add to generate a changeset file

The Sampo patch changeset was written directly in the repository's standard format.

🤖 Agent context

Autonomy: Human-driven (agent-assisted)

Pi and implementation subagents used Git, local SDK specifications, pytest, Ruff, reference generation, and isolated Pi autoreview. The source implementation determined the lifecycle and timeout wording. The session is local and has not been published.

[github-actions]

posthog-python Compliance Report

Date: 2026-10-16T16:51:19.335690+00:00
Duration: 259906ms

✅ All Tests Passed!

121/121 tests passed

---

Capture_V1 Tests

✅ 95/95 tests passed

View Details

Test	Status	Duration
Endpoint And Method.Targets V1 Endpoint	✅	517ms
Endpoint And Method.Does Not Use Legacy Endpoints	✅	511ms
Required Headers.Has Authorization Bearer Header	✅	513ms
Required Headers.Has Content Type Json	✅	513ms
Required Headers.Has Posthog Sdk Info Format	✅	511ms
Required Headers.Has Posthog Attempt Header	✅	511ms
Required Headers.Has Posthog Request Id	✅	511ms
Required Headers.Has Posthog Request Timestamp	✅	511ms
Required Headers.Has User Agent	✅	512ms
Body Format.Body Has Created At And Batch	✅	512ms
Body Format.No Api Key In Body	✅	511ms
Body Format.No Sent At In Body	✅	511ms
Event Format.Event Has Required Root Fields	✅	511ms
Event Format.Event Uuid Is Valid	✅	511ms
Event Format.Event Timestamp Is Rfc3339	✅	511ms
Event Format.Non Utc Event Timestamp Is Converted To Utc	✅	517ms
Event Format.Distinct Id Is String	✅	511ms
Event Format.Distinct Id At Root Not Properties	✅	512ms
Event Format.Custom Properties Preserved	✅	510ms
Event Format.Set Properties Preserved	✅	511ms
Event Format.Set Once Properties Preserved	✅	511ms
Event Format.Groups Properties Preserved	✅	512ms
Event Format.Sdk Generates Uuid If Not Provided	✅	511ms
Event Format.Event Has Required Root Fields Batch	✅	515ms
Event Format.Event Uuid Is Valid Batch	✅	515ms
Event Format.Event Timestamp Is Rfc3339 Batch	✅	515ms
Event Format.Distinct Id Is String Batch	✅	514ms
Event Format.Distinct Id At Root Not Properties Batch	✅	516ms
Event Format.Custom Properties Preserved Batch	✅	514ms
Event Format.Set Properties Preserved Batch	✅	515ms
Event Format.Set Once Properties Preserved Batch	✅	515ms
Event Format.Groups Properties Preserved Batch	✅	515ms
Event Format.Sdk Generates Uuid If Not Provided Batch	✅	515ms
Batch Behavior.Multiple Events In Single Batch	✅	519ms
Batch Behavior.Batch Envelope Smoke	✅	517ms
Batch Behavior.Flush With No Events Sends Nothing	✅	508ms
Batch Behavior.Flush At Triggers Batch	✅	1012ms
Batch Behavior.Created At Reflects Batch Creation Time	✅	512ms
Deduplication.Generates Unique Uuids	✅	518ms
Deduplication.Different Events Same Content Different Uuids	✅	515ms
Deduplication.Preserves Uuid On Retry	✅	6520ms
Deduplication.Preserves Timestamp On Retry	✅	6520ms
Deduplication.Preserves Uuid And Timestamp On Batch Retry	✅	6525ms
Deduplication.No Duplicate Events In Batch	✅	519ms
Header Behavior On Retry.Attempt Header Starts At One	✅	511ms
Header Behavior On Retry.Attempt Header Increments On Retry	✅	13521ms
Header Behavior On Retry.Request Id Preserved On Retry	✅	6516ms
Header Behavior On Retry.Different Requests Have Different Request Ids	✅	3022ms
Header Behavior On Retry.Request Timestamp Changes On Retry	✅	6519ms
Response Format Validation.Success Response Has Uuid Keyed Results	✅	512ms
Response Format Validation.Success Response Has Ok For Each Event	✅	516ms
Response Format Validation.Success No Retry After When All Ok	✅	513ms
Response Format Validation.Success Retry After Present When Retry Events	✅	1518ms
Response Format Validation.Success No Retry After When Drop Only	✅	514ms
Response Format Validation.Response Echoes Request Id	✅	511ms
Retry Behavior.Retries On 408	✅	6520ms
Retry Behavior.Retries On 500	✅	6516ms
Retry Behavior.Retries On 503	✅	8520ms
Retry Behavior.Retries On 504	✅	6521ms
Retry Behavior.Retryable Errors Have Retry After	✅	3516ms
Retry Behavior.Respects Retry After On Retryable Error	✅	11524ms
Retry Behavior.Does Not Retry On 400	✅	2514ms
Retry Behavior.Does Not Retry On 401	✅	2514ms
Retry Behavior.Does Not Retry On 402	✅	2514ms
Retry Behavior.Does Not Retry On 413	✅	2515ms
Retry Behavior.Does Not Retry On 415	✅	2515ms
Retry Behavior.Non Retryable Errors Have No Retry After	✅	2513ms
Retry Behavior.Implements Backoff	✅	22537ms
Retry Behavior.Max Retries Respected	✅	22531ms
Partial Batch Handling.Handles 200 Full Success	✅	2513ms
Partial Batch Handling.Handles 200 With All Ok	✅	3518ms
Partial Batch Handling.Does Not Retry Dropped Events	✅	3518ms
Partial Batch Handling.Does Not Retry Limited Events	✅	3515ms
Partial Batch Handling.Prunes Ok Events On Partial Retry	✅	6523ms
Partial Batch Handling.Prunes Dropped Events On Partial Retry	✅	6518ms
Partial Batch Handling.Retries Only Retry Events From Partial	✅	6525ms
Partial Batch Handling.Partial Retry Preserves Uuids	✅	6522ms
Partial Batch Handling.Partial Retry Attempt Header Increments	✅	6520ms
Partial Batch Handling.Partial Retry Request Id Preserved	✅	6521ms
Partial Batch Handling.Respects Retry After On Partial	✅	8523ms
Partial Batch Handling.Unknown Result Treated As Terminal	✅	3517ms
Partial Batch Handling.Mixed Ok Drop Limited No Retry	✅	3519ms
Compression.Sends Gzip Content Encoding	✅	512ms
Compression.No Content Encoding When Disabled	✅	512ms
Compression.Compressed Body Is Decompressible	✅	511ms
Error Handling.Does Not Retry On Unknown 4Xx	✅	2515ms
Event Options.Cookieless Mode Override	✅	511ms
Event Options.Disable Skew Correction Override	✅	511ms
Event Options.Process Person Profile Override	✅	511ms
Event Options.Product Tour Id Override	✅	510ms
Event Options.Unset Options Omitted	✅	512ms
Event Options.Options Override In Batch	✅	515ms
Geoip And Historical Migration.Geoip Disable Injected Into Properties	✅	511ms
Geoip And Historical Migration.Historical Migration Set In Body	✅	511ms
Geoip And Historical Migration.Historical Migration Absent By Default	✅	512ms

Capture_Ai Tests

✅ 5/5 tests passed

View Details

Test	Status	Duration
Routing.Capture Ai Posts To Ai Endpoint	✅	511ms
Routing.Capture Does Not Reroute Ai Named Events	✅	512ms
Identity.Capture Ai Event Has Uuid	✅	511ms
Identity.Capture Ai Keeps Supplied Uuid	✅	517ms
Timestamp Format.Non Utc Event Timestamp Is Converted To Utc	✅	512ms

Feature_Flags Tests

✅ 17/17 tests passed

View Details

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

Feature_Flags_Local_Evaluation Tests

✅ 4/4 tests passed

View Details

Test	Status	Duration
Versioned Boolean Matching.Matching Version Missing	✅	72ms
Versioned Boolean Matching.Matching Version 1	✅	70ms
Versioned Boolean Matching.Matching Version 2	✅	69ms
Versioned Boolean Matching.Version Only Reload 1 2 1 2 Missing	✅	38ms