shutil._make_tarball misses a guard against loggger=None

[tarekziade]

BPO	11045
Nosy	@freddrake, @birkenfeld, @rhettinger, @tarekziade, @merwok
Files	distutils2_logger.info_bug.txt: Full stacktrace check-logger-is-none.patch fix-11045.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/merwok'
closed_at = <Date 2011-11-20.14:32:40.073>
created_at = <Date 2011-01-28.13:48:09.593>
labels = ['type-bug', 'library']
title = 'shutil._make_tarball misses a guard against loggger=None'
updated_at = <Date 2011-11-20.14:32:40.072>
user = 'https://github.com/tarekziade'

bugs.python.org fields:

activity = <Date 2011-11-20.14:32:40.072>
actor = 'eric.araujo'
assignee = 'eric.araujo'
closed = True
closed_date = <Date 2011-11-20.14:32:40.073>
closer = 'eric.araujo'
components = ['Library (Lib)']
creation = <Date 2011-01-28.13:48:09.593>
creator = 'tarek'
dependencies = []
files = ['20574', '20609', '20610']
hgrepos = []
issue_num = 11045
keywords = ['patch']
message_count = 11.0
messages = ['127300', '127301', '127302', '127473', '127476', '127478', '127480', '127483', '127484', '127860', '147992']
nosy_count = 8.0
nosy_names = ['fdrake', 'georg.brandl', 'rhettinger', 'paulsmith', 'tarek', 'eric.araujo', 'v_peter', 'kelsey.hightower']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue11045'
versions = ['Python 3.1', 'Python 2.7', 'Python 3.2']

[tarekziade]

This line : logger.info("creating %s" % archive_dir)

should check that logger is not None before being called..

[tarekziade]

will fix + write patch

[kelseyhightower]

Adding stacktrace to ticket

[kelseyhightower]

Adding patch to ticket

[merwok]

I’ve checked the code and this is the only place where logger.* is not protected by a check for None. There is no unit test, though.

My patch adds two things: Make one formatting call lazy (use logging.info(one, two) instead of one % two), lower-case one message for consistent output). If we want to be ultra-conservative, Kelsey’s patch is to be preferred.

[rhettinger]

Please apply right away.

[rhettinger]

For 3.2, just make the one-line fix. I'm worry that a test may be hard to get right and would be a risk in and of itself this late in the release cycle.

For the backports, a test would be nice (since we have time to fix a test if it turns out to be problematic).

[merwok]

Indeed, I tried writing a small test to go into the faulty code path, but without calling the private function directly it’s not trivial.

I’ll apply the minimal change shortly if there is no opposition from Georg.

[merwok]

Fixed for 3.2rc2 in r88240. Would it be right to call the internal function in the test?

[merwok]

Arg, bpo-9173 had a patch including a test. Not sure which bug is superseded by the other.

[merwok]

This was fixed in 615a29295d5f.