Enhancement: Extended Snapshot - Capturing Variables in '__main__' Stack Frame

[umututku03]

Motivation and Context

The current snapshot function gathers variables only from function calls, potentially nested. To enhance its utility, we aim to expand its capabilities, and our goal is to include variables in the top-level scope, specifically those defined in the main block. This expansion caters to a beginner-friendly Python context, providing a more comprehensive snapshot functionality.

Your Changes

Description:

I've updated the snapshot.py module to improve the snapshot function. Now, it captures specific global variables, particularly those defined at the top level within the module where the snapshot function is called. The unit tests have been adjusted accordingly to validate and cover these improvements thoroughly.

Type of change (select all that apply):

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Refactoring (internal change to codebase, without changing functionality)
• Test update (change that modifies or updates tests only)
• Documentation update (change that modifies or updates documentation only)
• Other (please specify):

Testing

I've modified the unit tests for the snapshot function and tested the new feature across different levels of nesting. This ensures that the tests now align with the recent changes and thoroughly validate the functionality under various scenarios.

Questions and Comments (if applicable)

N/A

Checklist

• I have performed a self-review of my own code.
• I have verified that the CI tests have passed.
• I have reviewed the test coverage changes reported on Coveralls.
• I have added tests for my changes.
• I have updated the CHANGELOG.md file.

[coveralls]

Pull Request Test Coverage Report for Build 7859135880

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 96.904%

---

Totals
Change from base Build 7803649633:	0.0%
Covered Lines:	3224
Relevant Lines:	3327

---

💛 - Coveralls

[david-yz-liu]

This still isn't what I'm looking for. Look at the condition on line 40 and ask why it's there, and how you can use it to address the current problem.

[umututku03]

Hi @david-yz-liu! I believe the necessity of the if condition was to only pinpoint local variables, and do not investigate global context. That's why I called the helper function after that check (and with the same indentation level with the if condition) so that the variables within the global context will be added to the accumulator, after the check is made.