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

Add variable fitler to snapshot #1090

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

leowrites
Copy link
Contributor

@leowrites leowrites commented Oct 1, 2024

Proposed Changes

Add a exclude_vars parameter to snapshot to allow filtering variables.

...

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)
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

@david-yz-liu I moved some function inputs for the include filter PR up with the rest of the function inputs, let me know if I should revert that.

I think we could also rename include to include_frames for clarity. Let me know if you want this changed and I can do a refactor ticket with the functions above.

@leowrites leowrites marked this pull request as ready for review October 1, 2024 00:57
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 11116620696

Details

  • 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 92.051%

Totals Coverage Status
Change from base Build 11097474413: 0.0%
Covered Lines: 3057
Relevant Lines: 3321

💛 - Coveralls

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 nice work. I left a few minor comments; I'm happy with you reorganizing the test functions in the way that you have.

@@ -37,11 +37,25 @@ def get_filtered_global_variables(frame: FrameType) -> dict:
return {"__main__": true_global_vars}


def get_filtered_local_variables(frame, exclude_vars: Optional[Iterable[str | re.Pattern]]) -> dict:
Copy link
Contributor

Choose a reason for hiding this comment

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

make sure to include a type annotation for frame as well

}
return frame.f_locals


def snapshot(
save: bool = False,
memory_viz_args: Optional[list[str]] = None,
memory_viz_version: str = "latest",
include: Optional[Iterable[str | re.Pattern]] = None,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you're absolutely correct to rename this to include_frames, please go ahead to make that change in this PR.

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