Skip to content

python(feat): Add better report creation and wait_until_complete to SiftClient#475

Merged
nathan-sift merged 23 commits intomainfrom
python/add-job-report-wait-until-complete
Feb 24, 2026
Merged

python(feat): Add better report creation and wait_until_complete to SiftClient#475
nathan-sift merged 23 commits intomainfrom
python/add-job-report-wait-until-complete

Conversation

@nathan-sift
Copy link
Contributor

@nathan-sift nathan-sift commented Feb 13, 2026

Updates reports to return the Job for the pending report, and adds wait_until_complete to the Reports and Jobs API.

Returning a Job upon report creation provides a better indication to users that the report is in a "pending" state and likely does not have annotations generated yet. In addition to the job_id, users can obtain the report_id as a property of the job.

wait_until_complete is provided for the reports and jobs API, and polls the job status until it is in a completed state. Behavior is similar to the existing sift_py implementation for reports, but with the addition of configurable polling. For the reports implementation, requires a rule evaluation job or report to be provided, and returns a complete Report.

Verification
Adds unit tests for wait_until_complete and an integration test for Reports.

@alexluck-sift
Copy link
Collaborator

I'd suggest we expose a sync version within the Job object. Something like:
job.wait_until_complete()

@nathan-sift nathan-sift changed the title python(feat): Add wait_until_complete to SiftClient Jobs and Reports python(feat): Add PendingReport and wait_until_complete to SiftClient Feb 17, 2026
@nathan-sift nathan-sift changed the title python(feat): Add PendingReport and wait_until_complete to SiftClient python(feat): Add better report creation and wait_until_complete to SiftClient Feb 20, 2026
marc-sift
marc-sift previously approved these changes Feb 20, 2026
@nathan-sift nathan-sift enabled auto-merge (squash) February 24, 2026 23:24
@nathan-sift nathan-sift disabled auto-merge February 24, 2026 23:25
@nathan-sift nathan-sift dismissed marc-sift’s stale review February 24, 2026 23:25

Reviewed by Benji

@nathan-sift nathan-sift merged commit dde26f1 into main Feb 24, 2026
15 checks passed
@nathan-sift nathan-sift deleted the python/add-job-report-wait-until-complete branch February 24, 2026 23:25
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.

4 participants