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

Co-authored-by: Allen Hernandez <2349718+AllenSH12@users.noreply.github.com>
This commit is contained in:
Allen Hernandez 2025-05-28 02:44:38 -04:00 committed by GitHub
parent d7256ae4d7
commit 7be5916f6d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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
@ -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: