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

(cherry picked from commit 7be5916f6d)
This commit is contained in:
Miss Islington (bot) 2025-05-28 14:32:59 +02:00 committed by GitHub
parent 998cedb9bc
commit 7515384974
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 Outputs the record to the file, catering for rollover as described
previously. previously.
.. method:: shouldRollover(record)
See if the supplied record would cause the file to exceed the configured size limit.
.. _timed-rotating-file-handler: .. _timed-rotating-file-handler:
TimedRotatingFileHandler TimedRotatingFileHandler
@ -459,7 +463,11 @@ timed intervals.
.. method:: getFilesToDelete() .. method:: getFilesToDelete()
Returns a list of filenames which should be deleted as part of rollover. These 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: .. _socket-handler: