Skip to content

docs: Add documentation comment to scrub_list #2769

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 27, 2024
Merged

docs: Add documentation comment to scrub_list #2769

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
993abdd
ref: Rename `scrub_list` to `_scrub_list_recursive`
szokeasaurusrex Feb 27, 2024
9fc6e87
Make `scrub_list_recursively` public
szokeasaurusrex Feb 27, 2024
aa93df5
Rename back to `scrub_list` and add doc comment
szokeasaurusrex Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions sentry_sdk/scrubber.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ def __init__(self, denylist=None, recursive=False):

def scrub_list(self, lst):
# type: (List[Any]) -> None
"""
If a list is passed to this method, the method recursively searches the list and any
nested lists for any dictionaries. The method calls scrub_dict on all dictionaries
it finds.
If the parameter passed to this method is not a list, the method does nothing.
"""
if not isinstance(lst, list):
return

Expand Down