-
Notifications
You must be signed in to change notification settings - Fork 58
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
base: master
Are you sure you want to change the base?
Add variable fitler to snapshot #1090
Conversation
Pull Request Test Coverage Report for Build 11116620696Details
💛 - Coveralls |
There was a problem hiding this 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: |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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.
Proposed Changes
Add a
exclude_vars
parameter tosnapshot
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.)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:
After opening your pull request:
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
toinclude_frames
for clarity. Let me know if you want this changed and I can do a refactor ticket with the functions above.