Skip to content

gh-92592: Allow logging filters to return a LogRecord. (GH-92591) #92591

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
vsajip merged 18 commits into from
Jun 7, 2022
Merged

gh-92592: Allow logging filters to return a LogRecord. (GH-92591) #92591

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
3aeeba6
allow logging filters to return a LogRecord
adriangb May 10, 2022
1e4d27f
edit docstring
adriangb May 10, 2022
b526a35
remove unecessary __bool__ impl
adriangb May 10, 2022
f1ea183
edit docs
adriangb May 10, 2022
19561d3
Add docs and blurb
adriangb May 10, 2022
14e704d
Merge branch 'main' into logging-filters
adriangb May 10, 2022
4d34540
fix rst
adriangb May 10, 2022
a69e76a
touch up wording
adriangb May 10, 2022
67453f6
add test for filters on loggers
adriangb May 10, 2022
b1e1084
push straggler change
adriangb May 10, 2022
f72c594
Merge branch 'main' into logging-filters
adriangb May 10, 2022
225329f
pr feedback
adriangb May 10, 2022
735d78a
Merge branch 'logging-filters' of https://github.com/adriangb/cpython…
adriangb May 10, 2022
5e54c77
Merge branch 'main' into logging-filters
adriangb May 10, 2022
f52e404
fix whitespace
adriangb May 10, 2022
46e2f7f
fix docs as per pr feedback
adriangb May 10, 2022
7a0f470
Update logging-cookbook.rst
vsajip Jun 7, 2022
643551d
Update logging.rst
vsajip Jun 7, 2022
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
Prev Previous commit
Next Next commit
Add docs and blurb
  • Loading branch information
@adriangb
adriangb committed May 10, 2022
commit 19561d39e8f6b28f17851a33d700887b6a1e35d2
4 changes: 2 additions & 2 deletions Doc/howto/logging-cookbook.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,8 +713,8 @@ which, when run, produces something like:
2010-09-06 22:38:15,301 d.e.f DEBUG IP: 123.231.231.123 User: fred A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f INFO IP: 123.231.231.123 User: fred A message at INFO level with 2 parameters

Imparting contextual information for specific Handlers
------------------------------------------------------
Imparting contextual in Handlers
Copy link
Copy Markdown
Member

@vsajip vsajip May 10, 2022

Choose a reason for hiding this comment

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

Should be contextual information rather than just contextual. Also, no need to capitalise handlers here, as we're not talking about the class.

---------------------------------

Each :class:`~Handler` has it's own chain of Filters.
Copy link
Copy Markdown
Member

@vsajip vsajip May 10, 2022

Choose a reason for hiding this comment

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

it's should be its - the former is only used as a contraction of it is. Also, no need to capitalise filters here.

If you want to add contextual information to a :class:`LogRecord` without leaking
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2022-05-09-22-27-11.gh-issue-92591.V7RCk2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Let :mod:`logging` Filters to return a :class:`logging.LogRecord` instance
Copy link
Copy Markdown
Member

@vsajip vsajip May 10, 2022

Choose a reason for hiding this comment

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

No need to capitalise filters and handlers here, and also either use Allow filters to return ... or Let filters return ..., as Let ... to ... would be grammatically incorrect. Also, strictly, it would be more accurate to say ... so that filters attached to handlers can enrich ...

so that :class:`logging.Handler`s can enrich records without side effects on
other Handlers.