From 91bb9b9383cd29a56c48e8936b74b6ed1eda3171 Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Sun, 10 Oct 2021 16:15:24 +0100 Subject: [PATCH] =?UTF-8?q?bpo-45401:=20Change=20shouldRollover()=20method?= =?UTF-8?q?s=20to=20only=20rollover=20regular=20f=E2=80=A6=20(GH-28822)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit …iles. Also changed some historical return values from 1 -> True and 0 -> False. (cherry picked from commit 62a667784ba7b84611ebd50fa8a1a464cde32235) Co-authored-by: Vinay Sajip --- Lib/logging/handlers.py | 14 ++++++++++---- Lib/test/test_logging.py | 15 +++++++++++++++ 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/Lib/logging/handlers.py b/Lib/logging/handlers.py index 4cabc0d740c29f..4dcbe4530fcfcc 100644 --- a/Lib/logging/handlers.py +++ b/Lib/logging/handlers.py @@ -187,14 +187,17 @@ def shouldRollover(self, record): Basically, see if the supplied record would cause the file to exceed the size limit we have. """ + # See bpo-45401: Never rollover anything other than regular files + if os.path.exists(self.baseFilename) and not os.path.isfile(self.baseFilename): + return False if self.stream is None: # delay was set... self.stream = self._open() if self.maxBytes > 0: # are we rolling over? msg = "%s\n" % self.format(record) self.stream.seek(0, 2) #due to non-posix-compliant Windows feature if self.stream.tell() + len(msg) >= self.maxBytes: - return 1 - return 0 + return True + return False class TimedRotatingFileHandler(BaseRotatingHandler): """ @@ -345,10 +348,13 @@ def shouldRollover(self, record): record is not used, as we are just comparing times, but it is needed so the method signatures are the same """ + # See bpo-45401: Never rollover anything other than regular files + if os.path.exists(self.baseFilename) and not os.path.isfile(self.baseFilename): + return False t = int(time.time()) if t >= self.rolloverAt: - return 1 - return 0 + return True + return False def getFilesToDelete(self): """ diff --git a/Lib/test/test_logging.py b/Lib/test/test_logging.py index 8356e6be24baf0..1a5f8b60f5ccb5 100644 --- a/Lib/test/test_logging.py +++ b/Lib/test/test_logging.py @@ -5190,6 +5190,13 @@ def test_should_not_rollover(self): self.fn, encoding="utf-8", maxBytes=0) self.assertFalse(rh.shouldRollover(None)) rh.close() + # bpo-45401 - test with special file + # We set maxBytes to 1 so that rollover would normally happen, except + # for the check for regular files + rh = logging.handlers.RotatingFileHandler( + os.devnull, encoding="utf-8", maxBytes=1) + self.assertFalse(rh.shouldRollover(self.next_rec())) + rh.close() def test_should_rollover(self): rh = logging.handlers.RotatingFileHandler(self.fn, encoding="utf-8", maxBytes=1) @@ -5284,6 +5291,14 @@ def rotator(source, dest): rh.close() class TimedRotatingFileHandlerTest(BaseFileTest): + def test_should_not_rollover(self): + # See bpo-45401. Should only ever rollover regular files + fh = logging.handlers.TimedRotatingFileHandler( + os.devnull, 'S', encoding="utf-8", backupCount=1) + time.sleep(1.1) # a little over a second ... + r = logging.makeLogRecord({'msg': 'testing - device file'}) + self.assertFalse(fh.shouldRollover(r)) + # other test methods added below def test_rollover(self): fh = logging.handlers.TimedRotatingFileHandler(