Skip to content

Format HTTPError.log_message only if args provided #3465

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
Apr 12, 2025
Merged

Format HTTPError.log_message only if args provided #3465

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec08dd3
Format HTTPError.log_message only if args provided
hXtreme Feb 27, 2025
ff9ae15
Resolve RequestEncodingTest.test_error failure
hXtreme Feb 27, 2025
8c1e010
Add log_message property to HTTPError for backwards compatibility
hXtreme Mar 12, 2025
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
30 changes: 22 additions & 8 deletions tornado/web.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1911,9 +1911,10 @@ def log_exception(
.. versionadded:: 3.1
"""
if isinstance(value, HTTPError):
if value.log_message:
format = "%d %s: " + value.log_message
args = [value.status_code, self._request_summary()] + list(value.args)
log_message = value.get_message()
if log_message:
format = "%d %s: %s"
args = [value.status_code, self._request_summary(), log_message]
gen_log.warning(format, *args)
else:
app_log.error(
Expand Down Expand Up @@ -2517,19 +2518,32 @@ def __init__(
**kwargs: Any,
) -> None:
self.status_code = status_code
self.log_message = log_message
self._log_message = log_message
self.args = args
self.reason = kwargs.get("reason", None)
if log_message and not args:
self.log_message = log_message.replace("%", "%%")

@property
def log_message(self) -> Optional[str]:
"""
A backwards compatible way of accessing log_message.
"""
if self._log_message and not self.args:
return self._log_message.replace("%", "%%")
return self._log_message

def get_message(self) -> Optional[str]:
if self._log_message and self.args:
return self._log_message % self.args
return self._log_message

def __str__(self) -> str:
message = "HTTP %d: %s" % (
self.status_code,
self.reason or httputil.responses.get(self.status_code, "Unknown"),
)
if self.log_message:
return message + " (" + (self.log_message % self.args) + ")"
log_message = self.get_message()
if log_message:
return message + " (" + log_message + ")"
else:
return message

Expand Down