Summary

Add options and context manager support to log_timed().

Review Request #14365 — Created March 11, 2025 and submitted March 21, 2025, 12:59 a.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Blocks

14366

Reviewers

Groups

djblets

People

Description

log_timed() has been updated to take in an optional logger argument
to specify a customer logger and extra to populate additional log
fields.

It also now works as a context manager, which handles stopping a log
when an exception occurs. This should simplify usage overall.

Every log_timed() call has a trace ID that can be used to associate
the beginning/end/result logs together. This is exposed on the timer
object so that other log calls can include it in their logs.

All arguments after message are now keyword-only. This will be
enforced in Djblets 7.

Deprecated calls for datetimes have been fixed. Typing has been added.
Documentation has been modernized to meet current standards. Unit tests
were added.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	ad713186449e2a9666da73b3a398adbe8c5be28d

Summary

Add options and context manager support to log_timed().

`log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.

ad713186449e2a9666da73b3a398adbe8c5be28d

Issues

Description	From	Last Updated
Missing docstrings.	maubin	March 17, 2025, 2:18 p.m.
trace_id needs to be passed here.	maubin	March 18, 2025, 3:03 p.m.
undefined name 'UTC' Column: 30 Error code: F821	reviewbot	March 19, 2025, 4:42 p.m.

flake8 passed.

JSHint passed.

Change Summary:

Removed deprecated utcnow() calls.

Description:

		`log_timed()` has been updated to take in an optional `logger` argument
		to specify a customer logger and `extra` to populate additional log
		fields.

		It also now works as a context manager, which handles stopping a log
		when an exception occurs. This should simplify usage overall.

		All arguments after `message` are now keyword-only. This will be
		enforced in Djblets 7.

~		Typing has been added, and documentation has been modernized to meet
~		current standards. Unit tests were added.
	~	Deprecated calls for datetimes have been fixed. Typing has been added.
	~	Documentation has been modernized to meet current standards. Unit tests
	+	were added.

Commits:

	Summary	ID
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Typing has been added, and documentation has been modernized to meet current standards. Unit tests were added.	12d6721e3f08b89c501796d55c452f662cc48113
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	85f0ee27d55d3a8043f66fc9a5d8b5fa19cec2b7

Diff:

Revision 2 (+858 -68)

Show changes

	djblets/log/__init__.py
	djblets/log/tests/test_log_timed.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

djblets/log/__init__.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing docstrings.
```

Change Summary:


Added trace ID support.
Fixed missing docstrings.
Fixed the return type for __exit__.

Description:

		`log_timed()` has been updated to take in an optional `logger` argument
		to specify a customer logger and `extra` to populate additional log
		fields.

		It also now works as a context manager, which handles stopping a log
		when an exception occurs. This should simplify usage overall.

	+	Every `log_timed()` call has a trace ID that can be used to associate
	+	the beginning/end/result logs together. This is exposed on the timer
	+	object so that other log calls can include it in their logs.
	+
		All arguments after `message` are now keyword-only. This will be
		enforced in Djblets 7.

		Deprecated calls for datetimes have been fixed. Typing has been added.
		Documentation has been modernized to meet current standards. Unit tests
		were added.

Commits:

	Summary	ID
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	85f0ee27d55d3a8043f66fc9a5d8b5fa19cec2b7
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	fc24f9317fe134e998123525304833c0ed41b99c

Diff:

Revision 3 (+992 -66)

Show changes

	djblets/log/__init__.py
	djblets/log/tests/test_log_timed.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/log/__init__.py (Diff revisions 2 - 3)

The issue has been resolved. Show all issues

trace_id needs to be passed here.

chipx86 March 18, 2025, 3:03 p.m.

Oops, that's in my tree but not in the commit. Thanks!

Change Summary:

Fixed a custom trace_id not being passed to TimedLogInfo.

Commits:

	Summary	ID
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	fc24f9317fe134e998123525304833c0ed41b99c
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	3c4817f2b1e69ce5be3b6740d0e3283f7a817683

Diff:

Revision 4 (+994 -66)

Show changes

	djblets/log/__init__.py
	djblets/log/tests/test_log_timed.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Fixed the UTC reference to work with Python 3.8.

Commits:

	Summary	ID
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	3c4817f2b1e69ce5be3b6740d0e3283f7a817683
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	e4266b7f8e276dd605016f0b0a0daffee2c7c0a7

Diff:

Revision 5 (+994 -66)

Show changes

	djblets/log/__init__.py
	djblets/log/tests/test_log_timed.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

djblets/log/__init__.py (Diff revision 5)
The issue has been resolved. Show all issues
```
undefined name 'UTC'

Column: 30
Error code: F821
```

Change Summary:

Added a missing unstaged change.

Commits:

	Summary	ID
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	e4266b7f8e276dd605016f0b0a0daffee2c7c0a7
	Add options and context manager support to log_timed(). `log_timed()` has been updated to take in an optional `logger` argument to specify a customer logger and `extra` to populate additional log fields. It also now works as a context manager, which handles stopping a log when an exception occurs. This should simplify usage overall. Every `log_timed()` call has a trace ID that can be used to associate the beginning/end/result logs together. This is exposed on the timer object so that other log calls can include it in their logs. All arguments after `message` are now keyword-only. This will be enforced in Djblets 7. Deprecated calls for datetimes have been fixed. Typing has been added. Documentation has been modernized to meet current standards. Unit tests were added.	ad713186449e2a9666da73b3a398adbe8c5be28d

Diff:

Revision 6 (+994 -66)

Show changes

	djblets/log/__init__.py
	djblets/log/tests/test_log_timed.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (e615f08)