https://github.com/python/cpython/commit/8e60e6ca847f45d186cbdcf8ee79a500f9029235
commit: 8e60e6ca847f45d186cbdcf8ee79a500f9029235
branch: 3.13
author: Miss Islington (bot) <[email protected]>
committer: vsajip <[email protected]>
date: 2025-05-28T12:32:57Z
summary:
[3.13] gh-134817: Document [Timed]RotatingFileHandler shouldRollover method
(GH-134818) (GH-134824)
(cherry picked from commit 7be5916f6dc3db95744b5fec945327d82cce0183)
files:
M Doc/library/logging.handlers.rst
diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst
index e63c253e123552..1c4085efa867e8 100644
--- a/Doc/library/logging.handlers.rst
+++ b/Doc/library/logging.handlers.rst
@@ -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:
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
