Skip to content

Modify SnapshotTracer to generate JSON#1339

Open
shirleyyzhang wants to merge 15 commits into
pyta-uoft:masterfrom
shirleyyzhang:snapshot-json
Open

Modify SnapshotTracer to generate JSON#1339
shirleyyzhang wants to merge 15 commits into
pyta-uoft:masterfrom
shirleyyzhang:snapshot-json

Conversation

@shirleyyzhang
Copy link
Copy Markdown
Contributor

@shirleyyzhang shirleyyzhang commented May 17, 2026

Proposed Changes

(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)

  • This PR modifies SnapshotTracer to generate JSON and pass it into the webstepper template as part of ongoing work towards integration with MemoryViz.
  • snapshot_to_json function was modified to handle compound data types during recursive processing.
Screenshots of your changes (if applicable)

Type of Change

(Write an X or a brief description next to the type or types that best describe your changes.)

Type Applies?
🚨 Breaking change (fix or feature that would cause existing functionality to change) X
New feature (non-breaking change that adds functionality)
🐛 Bug fix (non-breaking change that fixes an issue)
♻️ Refactoring (internal change to codebase, without changing functionality)
🚦 Test update (change that only adds or modifies tests)
📚 Documentation update (change that only updates documentation)
📦 Dependency update (change that updates a dependency)
🔧 Internal (change that only affects developers or continuous integration)

Checklist

(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the [ ] into a [x] in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)

Before opening your pull request:

  • I have performed a self-review of my changes.
    • Check that all changed files included in this pull request are intentional changes.
    • Check that all changes are relevant to the purpose of this pull request, as described above.
  • I have added tests for my changes, if applicable.
    • This is required for all bug fixes and new features.
  • I have updated the project documentation, if applicable.
    • This is required for new features.
  • I have updated the project Changelog (this is required for all changes).
  • If this is my first contribution, I have added myself to the list of contributors.

After opening your pull request:

  • I have verified that the CI tests have passed.
  • I have reviewed the test coverage changes reported by Coveralls.
  • I have requested a review from a project maintainer.

Questions and Comments

@shirleyyzhang shirleyyzhang marked this pull request as ready for review May 21, 2026 23:02
@coveralls
Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 26258168223

Warning

Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes.
Quick fix: rebase this PR. Learn more →

Coverage remained the same at 90.539%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 3879
Covered Lines: 3512
Line Coverage: 90.54%
Coverage Strength: 17.57 hits per line

💛 - Coveralls

Copy link
Copy Markdown
Contributor

@david-yz-liu david-yz-liu left a comment

Choose a reason for hiding this comment

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

Hi @shirleyyzhang, great progress. I left one inline comment. Please also remove the output_directory attribute of the SnapshotTracer class, as it's no longer being used.

To maintain backwards compatibility you can leave the argument in the initializer, but if it is provided please use warnings.warn (import warnings) to emit a message saying that this argument is deprecated.

json_data = snapshot_to_json(snapshot_output, id_tracker=self.id_tracker)
self._add_json_to_map(json_data, frame.f_lineno)

def _add_json_to_map(self, json_data: list[dict], line: int) -> None:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think this method is really necessary any more, please just put the body inline above

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.

3 participants