Skip to content

[3.14] gh-134817: Document [Timed]RotatingFileHandler shouldRollover method (GH-134818) #134823

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 1 commit into from
May 28, 2025
Merged

[3.14] gh-134817: Document [Timed]RotatingFileHandler shouldRollover method (GH-134818) #134823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion Doc/library/logging.handlers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,10 @@ module, supports rotation of disk log files.
Outputs the record to the file, catering for rollover as described
previously.

.. method:: shouldRollover(record)

See if the supplied record would cause the file to exceed the configured size limit.

.. _timed-rotating-file-handler:

TimedRotatingFileHandler
Expand Down Expand Up @@ -459,7 +463,11 @@ timed intervals.
.. method:: getFilesToDelete()

Returns a list of filenames which should be deleted as part of rollover. These
are the absolute paths of the oldest backup log files written by the handler.

.. method:: shouldRollover(record)

See if enough time has passed for a rollover to occur and if it has, compute
the next rollover time.

.. _socket-handler:

Expand Down
Loading