feat(python): expose snapshot by debangshu919 · Pull Request #4616 · apache/iggy

debangshu919 · 2026-10-21T14:30:25Z

Which issue does this PR address?

Rationale

The Python SDK lacked support for taking server diagnostic snapshots, a capability already available in the Rust and C++ SDKs.

What changed?

The Python client had no interface to request server diagnostic snapshots.

IggyClient.snapshot() now captures server snapshots and returns compressed ZIP archive bytes. The method accepts strongly typed SnapshotCompression and SystemSnapshotType enums instead of raw strings, providing compile-time/IDE autocompletion and early type validation. The changes include full PyO3 bindings, regenerated type stubs in apache_iggy.pyi, and comprehensive unit and integration tests.

Local Execution

Passed
Pre-commit hooks ran

AI Usage

Which tools? (e.g., GitHub Copilot, Claude, ChatGPT)

OpenCode

Scope of usage? (e.g., autocomplete, generated functions, entire implementation)

Used AI tools to understand the codebase and generate tests

How did you verify the generated code works correctly?

Ran unit tests and integration tests against a live iggy server with pytest (test_snapshot.py), ran cargo clippy and verified with ruff.

Can you explain every line of the code if asked?

Yes

github-actions · 2026-10-21T14:32:23Z

Thanks for the PR. It is labeled S-waiting-on-review and queued for review.

Slash commands (own line, regular comment) move it around the queue:

/ready - back to S-waiting-on-review after addressing feedback
/author - flip to S-waiting-on-author while you finish changes
/request-review @user-or-team - request a reviewer
/pin - exempt the PR from the stale bot, /unpin to undo

See CONTRIBUTING.md for details.

codecov · 2026-10-21T15:43:41Z

Codecov Report

❌ Patch coverage is 53.73134% with 31 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.75%. Comparing base (b1adfe5) to head (04c71b6).
⚠️ Report is 12 commits behind head on master.

Files with missing lines	Patch %	Lines
foreign/python/src/snapshot.rs	22.50%	31 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #4616      +/-   ##
============================================
- Coverage     90.76%   90.75%   -0.01%     
  Complexity     2966     2966              
============================================
  Files          1459     1460       +1     
  Lines        347741   347824      +83     
  Branches     292547   292547              
============================================
+ Hits         315617   315669      +52     
- Misses        25507    25538      +31     
  Partials       6617     6617

Components	Coverage Δ
Rust Core	`92.08% <ø> (ø)`
Java SDK	`77.73% <ø> (ø)`
C# SDK	`83.54% <ø> (ø)`
Python SDK	`85.25% <53.73%> (-0.39%)`	⬇️
PHP SDK	`90.59% <ø> (ø)`
Node SDK	`96.45% <ø> (ø)`
Go SDK	`69.87% <ø> (ø)`
C++ SDK	`85.45% <ø> (ø)`

Files with missing lines	Coverage Δ
foreign/python/src/client.rs	`99.12% <100.00%> (+0.03%)`	⬆️
foreign/python/src/lib.rs	`100.00% <100.00%> (ø)`
foreign/python/src/snapshot.rs	`22.50% <22.50%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

slbotbm · 2026-10-21T15:46:19Z

/skill team-review-slim

github-actions

Summary: The Python snapshot() binding mirrors the Rust SDK and its dedupe protects the wire encoder, but it inherits a fixed 30-second transport deadline that large log snapshots can exceed. The method also trims compression but not snapshot_types, and the new dedupe path has no test.

Counts: critical 0, warning 1, nit 2, simplification 0

This review was generated by Claude Code 2.1.284 on deepseek-flash[1m]. Review the output before you act on it.

debangshu919 · 2026-10-22T07:04:38Z

/ready

slbotbm

Let's add snapshot compression and snapshot types as enums instead of allowing the user to freely enter strings for them.

debangshu919 · 2026-10-24T12:30:56Z

Hi @slbotbm thanks for the review!
I've replaced the string parameters with SnapshotCompression and SystemSnapshotType enums as you suggested, and also rebased the branch onto latest master to resolve the merge conflicts.

Please let me know if any further adjustments are needed.

debangshu919 · 2026-10-24T12:31:08Z

/ready

…ests

slbotbm · 2026-10-28T05:49:07Z

+
+        let mut parsed_types = Vec::with_capacity(snapshot_types.len());
+        for snapshot_type in snapshot_types {
+            let rust_type: SystemSnapshotType = snapshot_type.into();


Let's make this SystemSnapshotType::from(snapshot_type)

slbotbm · 2026-10-28T05:50:05Z

+        }
+
+        let inner = self.inner.clone();
+        let compression: SnapshotCompression = snapshot_compression.into();


SnapshotCompression::from(snapshot_compression)

slbotbm · 2026-10-28T05:50:47Z

+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]


these tests are not required

slbotbm · 2026-10-28T05:51:40Z

+    @pytest.mark.unit
+    def test_snapshot_enums(self):
+        """Snapshot compression and type enums expose expected variants."""
+        assert SnapshotCompression.Deflated == SnapshotCompression.Deflated
+        assert SnapshotCompression.Deflated != SnapshotCompression.Stored
+        assert SystemSnapshotType.All == SystemSnapshotType.All


This test is not required

github-actions Bot added the S-waiting-on-review PR is waiting on a reviewer label Oct 21, 2026

github-actions Bot reviewed Oct 21, 2026

View reviewed changes

Comment thread foreign/python/src/client.rs

Comment thread foreign/python/src/client.rs Outdated

Comment thread foreign/python/src/client.rs Outdated

github-actions Bot added S-waiting-on-author PR is waiting on author response and removed S-waiting-on-review PR is waiting on a reviewer labels Oct 21, 2026

github-actions Bot added S-waiting-on-review PR is waiting on a reviewer and removed S-waiting-on-author PR is waiting on author response labels Oct 22, 2026

slbotbm requested changes Oct 24, 2026

View reviewed changes

Comment thread foreign/python/src/client.rs Outdated

github-actions Bot added S-waiting-on-author PR is waiting on author response and removed S-waiting-on-review PR is waiting on a reviewer labels Oct 24, 2026

debangshu919 added 7 commits October 24, 2026 17:37

feat(python): add snapshot support

b3a9dc2

fix(python): deduplicate parsed snapshot types and update docs

151bb6e

fix(python): trim snapshot types and document binary timeout

b1ea98d

chore(python): sync snapshot docstring in stub file

3047354

chore(python): remove redundant capacity cap in snapshot

419e149

refactor(python): rename compression to snapshot_compression

069da08

refactor(python): use enums for snapshot compression and snapshot types

96c5e4d

debangshu919 force-pushed the feat/python-snapshot branch from 57c591f to 96c5e4d Compare October 24, 2026 12:20

github-actions Bot added S-waiting-on-review PR is waiting on a reviewer and removed S-waiting-on-author PR is waiting on author response labels Oct 24, 2026

debangshu919 requested a review from slbotbm October 24, 2026 12:36

test(python): ignore pyrefly bad-argument-type in snapshot negative t…

04c71b6

…ests

slbotbm requested changes Oct 28, 2026

View reviewed changes

github-actions Bot added S-waiting-on-author PR is waiting on author response and removed S-waiting-on-review PR is waiting on a reviewer labels Oct 28, 2026

Conversation

debangshu919 commented Oct 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Which issue does this PR address?

Rationale

What changed?

Local Execution

AI Usage

Uh oh!

github-actions Bot commented Oct 21, 2026

Uh oh!

codecov Bot commented Oct 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

slbotbm commented Oct 21, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

debangshu919 commented Oct 22, 2026

Uh oh!

slbotbm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

debangshu919 commented Oct 24, 2026

Uh oh!

debangshu919 commented Oct 24, 2026

Uh oh!

slbotbm Oct 28, 2026

Choose a reason for hiding this comment

Uh oh!

slbotbm Oct 28, 2026

Choose a reason for hiding this comment

Uh oh!

slbotbm Oct 28, 2026

Choose a reason for hiding this comment

Uh oh!

slbotbm Oct 28, 2026

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

debangshu919 commented Oct 21, 2026 •

edited

Loading

codecov Bot commented Oct 21, 2026 •

edited

Loading