[issue29105] code or doc improvement for logging.handlers.RotatingFileHandler

[Roundup Robot]

Roundup Robot added the comment:

New changeset 4255c7aae85b by Vinay Sajip in branch '3.6':
Closes #29105: Updated RotatingFileHandler documentation.
https://hg.python.org/cpython/rev/4255c7aae85b

--
nosy: +python-dev
resolution:  -> fixed
stage:  -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue29105] code or doc improvement for logging.handlers.RotatingFileHandler

[Berker Peksag]

Changes by Berker Peksag :


--
nosy: +vinay.sajip

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue29105] code or doc improvement for logging.handlers.RotatingFileHandler

[iMath]

New submission from iMath:

For 
class logging.handlers.RotatingFileHandler(filename, mode='a', maxBytes=0, 
backupCount=0, encoding=None, delay=0) 

if backupCount is zero and maxBytes is non-zero, the log file size could exceed 
maxBytes, i.e. we are not able to restrict the log file size using 
RotatingFileHandler at this case .
I suggest add the above description to the doc 
https://docs.python.org/3.6/library/logging.handlers.html#logging.handlers.RotatingFileHandler
If possible , set backupCount=1 by default to avoid this pitfall as much as 
possible.

The doc right now just says "if either of maxBytes or backupCount is zero, 
rollover never occurs.", it is too difficult to understand the meaning of 
'Rollover' to aviod the pitfall .

--
assignee: docs@python
components: Documentation
messages: 284277
nosy: docs@python, redstone-cold
priority: normal
severity: normal
status: open
title: code or doc improvement for logging.handlers.RotatingFileHandler
type: enhancement
versions: Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com