Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Snapshot Tracer #1086

Merged
merged 73 commits into from
Oct 3, 2024
Merged

Conversation

leowrites
Copy link
Contributor

@leowrites leowrites commented Sep 23, 2024

Proposed Changes

  • Add a context manager python_ta.debug.SnapshotManager

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)
New feature (non-breaking change that adds functionality) x
🐛 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) x
📚 Documentation update (change that only updates documentation) x
📦 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 pre-commit.ci checks have passed.
  • 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

(Include any questions or comments you have regarding your changes.)

Copy link
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.

@leowrites good work. In this first review, I focused on the API of SnapshotManager as well as some high-level comments to improve the test file. Make sure to also update the documentation accordingly, which I'll review more closely after you've addressed these comments.

python_ta/debug/snapshot_manager.py Outdated Show resolved Hide resolved
python_ta/debug/snapshot_manager.py Outdated Show resolved Hide resolved
python_ta/debug/snapshot_manager.py Outdated Show resolved Hide resolved
python_ta/debug/snapshot_manager.py Outdated Show resolved Hide resolved
python_ta/debug/snapshot_manager.py Outdated Show resolved Hide resolved
tests/test_debug/test_snapshot_manager.py Outdated Show resolved Hide resolved
tests/test_debug/test_snapshot_manager.py Outdated Show resolved Hide resolved
tests/test_debug/test_snapshot_manager.py Outdated Show resolved Hide resolved
tests/test_debug/test_snapshot_manager.py Outdated Show resolved Hide resolved
tests/test_debug/test_snapshot_manager.py Outdated Show resolved Hide resolved
Copy link
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.

@leowrites okay great work. I only have one comment left, which is to pin the memory_viz_version argument as well (to make the tests robust against future MemoryViz library updates).

@leowrites leowrites changed the title Snapshot manager Implement Snapshot Tracer Oct 2, 2024
@david-yz-liu david-yz-liu merged commit 6a16b70 into pyta-uoft:master Oct 3, 2024
15 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.

3 participants