https://github.com/python/cpython/commit/7515384974cb5a49c98f7bdd1061948e653fb0ee
commit: 7515384974cb5a49c98f7bdd1061948e653fb0ee
branch: 3.14
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: vsajip <vinay_sa...@yahoo.co.uk>
date: 2025-05-28T12:32:59Z
summary:

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

(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 63ef533e82c658..8f3aa1dfdd0cde 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 -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: arch...@mail-archive.com

Reply via email to