Skip to content

docs(plz-3d-explain): clarify Python state persistence - #44

Merged
codekongdev merged 1 commit into
codekongdev:mainfrom
Aaqibhafeezkhan:fix/issue-16-python-interpreter-state
Nov 20, 2026
Merged

codekongdev merged 1 commit into
codekongdev:mainfrom
Aaqibhafeezkhan:fix/issue-16-python-interpreter-state

Conversation

@Aaqibhafeezkhan

Copy link
Copy Markdown
Contributor

Changes

  • Clarify that sandbox reuse alone does not guarantee Python variable persistence.
  • Explain the distinction between filesystem state and Python interpreter memory.
  • State that starting a new Python process loses variables, even inside the same VM or container.
  • Explain how restoring a snapshot containing process memory can preserve interpreter state.
  • Align the Korean and English explanations, code comments and animation results.

Validation

  • Checked the lifecycle explanation in both languages.
  • Checked the example comments against the process-memory behavior.
  • Checked that the animation describes interpreter reuse and snapshot restoration consistently.

Closes #16

@coderabbitai

coderabbitai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Clarified that files can persist in a sandbox independently of Python variables, which persist only when the same process continues or its memory is restored.
    • Updated the animation narration to specify when snapshots preserve and restore both files and interpreter state.

Both HTML versions clarify that sandbox reuse alone does not preserve Python variables. They distinguish files in the sandbox filesystem from variables in Python process memory. The lifecycle example and animation text explain that variables persist when the same process continues or when a snapshot restores its memory.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other · Severity of issue fixed: Low

Assessment against linked issues

Objective Addressed Explanation
Clarify that variable persistence requires the same Python process or execution context, and distinguish file, memory, and snapshot persistence [#16] ✅
Update the lifecycle text, example comments, and animation text in both language versions [#16] ✅

Suggested reviewers: codekongdev

Merge Risk: Minimal · up to 9256f

This change clarifies that reusing a sandbox does not by itself preserve Python variables, and it applies the same wording to both language versions. It is documentation only and has no identified merge-blocking risk.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 197d6d9 and 9256fe7.

Files selected for processing: 2

  • skills/plz-3d-explain/assets/example-agent-sandbox.en.html
  • skills/plz-3d-explain/assets/example-agent-sandbox.html

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@Aaqibhafeezkhan Aaqibhafeezkhan left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

  • The example now explicitly assumes the same Python interpreter across turns.
  • Files and variables have separate, clearly explained lifetimes.
  • Snapshot restoration is no longer presented as equivalent to simply reusing a sandbox.

Signed-off-by: Aaqibhafeez Khan <githubaaqibhafeezkhan@gmail.com>
@Aaqibhafeezkhan
Aaqibhafeezkhan force-pushed the fix/issue-16-python-interpreter-state branch from 29df604 to 9256fe7 Compare November 20, 2026 00:31
@codekongdev
codekongdev merged commit 7240d82 into codekongdev:main Nov 20, 2026
2 checks passed
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.

[plz-3d-explain] Clarify when Python variables persist across sandbox reuse

2 participants