[Python-checkins] cpython: Issue #20037: Avoid crashes when doing text I/O late at interpreter shutdown.

Sat Dec 21 15:52:36 CET 2013

http://hg.python.org/cpython/rev/9158f201f6d0
changeset: 88109:9158f201f6d0
user: Antoine Pitrou <solipsis at pitrou.net>
date: Sat Dec 21 15:51:54 2013 +0100
summary:
 Issue #20037: Avoid crashes when doing text I/O late at interpreter shutdown.
files:
 Lib/test/test_io.py | 41 +++++++++++++++++++++++++++-
 Lib/test/test_logging.py | 20 +++++++++++++
 Misc/NEWS | 3 ++
 Modules/_io/_iomodule.c | 14 +++++++++
 Modules/_io/_iomodule.h | 3 +-
 Modules/_io/bufferedio.c | 4 ++-
 Modules/_io/fileio.c | 6 ++-
 Modules/_io/iobase.c | 4 ++-
 Modules/_io/textio.c | 9 ++++-
 9 files changed, 96 insertions(+), 8 deletions(-)

diff --git a/Lib/test/test_io.py b/Lib/test/test_io.py
--- a/Lib/test/test_io.py
+++ b/Lib/test/test_io.py
@@ -36,6 +36,7 @@
 from collections import deque, UserList
 from itertools import cycle, count
 from test import support
+from test.script_helper import assert_python_ok
 
 import codecs
 import io # C implementation of io
@@ -2589,8 +2590,46 @@
 encoding='quopri_codec')
 self.assertRaises(TypeError, t.read)
 
+ def _check_create_at_shutdown(self, **kwargs):
+ # Issue #20037: creating a TextIOWrapper at shutdown
+ # shouldn't crash the interpreter.
+ iomod = self.io.__name__
+ code = """if 1:
+ import codecs
+ import {iomod} as io
+
+ # Avoid looking up codecs at shutdown
+ codecs.lookup('utf-8')
+
+ class C:
+ def __init__(self):
+ self.buf = io.BytesIO()
+ def __del__(self):
+ io.TextIOWrapper(self.buf, **{kwargs})
+ print("ok")
+ c = C()
+ """.format(iomod=iomod, kwargs=kwargs)
+ return assert_python_ok("-c", code)
+
+ def test_create_at_shutdown_without_encoding(self):
+ rc, out, err = self._check_create_at_shutdown()
+ if err:
+ # Can error out with a RuntimeError if the module state
+ # isn't found.
+ self.assertIn("RuntimeError: could not find io module state",
+ err.decode())
+ else:
+ self.assertEqual("ok", out.decode().strip())
+
+ def test_create_at_shutdown_with_encoding(self):
+ rc, out, err = self._check_create_at_shutdown(encoding='utf-8',
+ errors='strict')
+ self.assertFalse(err)
+ self.assertEqual("ok", out.decode().strip())
+
 
 class CTextIOWrapperTest(TextIOWrapperTest):
+ io = io
 
 def test_initialization(self):
 r = self.BytesIO(b"\xc3\xa9\n\n")
@@ -2634,7 +2673,7 @@
 
 
 class PyTextIOWrapperTest(TextIOWrapperTest):
- pass
+ io = pyio
 
 
 class IncrementalNewlineDecoderTest(unittest.TestCase):
diff --git a/Lib/test/test_logging.py b/Lib/test/test_logging.py
--- a/Lib/test/test_logging.py
+++ b/Lib/test/test_logging.py
@@ -41,6 +41,7 @@
 import struct
 import sys
 import tempfile
+from test.script_helper import assert_python_ok
 from test.support import (captured_stdout, run_with_locale, run_unittest,
 patch, requires_zlib, TestHandler, Matcher)
 import textwrap
@@ -3397,6 +3398,25 @@
 logging.setLoggerClass(logging.Logger)
 self.assertEqual(logging.getLoggerClass(), logging.Logger)
 
+ def test_logging_at_shutdown(self):
+ # Issue #20037
+ code = """if 1:
+ import logging
+
+ class A:
+ def __del__(self):
+ try:
+ raise ValueError("some error")
+ except Exception:
+ logging.exception("exception in __del__")
+
+ a = A()"""
+ rc, out, err = assert_python_ok("-c", code)
+ err = err.decode()
+ self.assertIn("exception in __del__", err)
+ self.assertIn("ValueError: some error", err)
+
+
 class LogRecordTest(BaseTest):
 def test_str_rep(self):
 r = logging.makeLogRecord({})
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -44,6 +44,9 @@
 Library
 -------
 
+- Issue #20037: Avoid crashes when opening a text file late at interpreter
+ shutdown.
+
 - Issue #19967: Thanks to the PEP 442, asyncio.Future now uses a
 destructor to log uncaught exceptions, instead of the dedicated
 _TracebackLogger class.
diff --git a/Modules/_io/_iomodule.c b/Modules/_io/_iomodule.c
--- a/Modules/_io/_iomodule.c
+++ b/Modules/_io/_iomodule.c
@@ -539,6 +539,20 @@
 }
 
 
+_PyIO_State *
+_PyIO_get_module_state(void)
+{
+ PyObject *mod = PyState_FindModule(&_PyIO_Module);
+ _PyIO_State *state;
+ if (mod == NULL || (state = IO_MOD_STATE(mod)) == NULL) {
+ PyErr_SetString(PyExc_RuntimeError,
+ "could not find io module state "
+ "(interpreter shutdown?)");
+ return NULL;
+ }
+ return state;
+}
+
 PyObject *
 _PyIO_get_locale_module(_PyIO_State *state)
 {
diff --git a/Modules/_io/_iomodule.h b/Modules/_io/_iomodule.h
--- a/Modules/_io/_iomodule.h
+++ b/Modules/_io/_iomodule.h
@@ -135,8 +135,9 @@
 } _PyIO_State;
 
 #define IO_MOD_STATE(mod) ((_PyIO_State *)PyModule_GetState(mod))
-#define IO_STATE IO_MOD_STATE(PyState_FindModule(&_PyIO_Module))
+#define IO_STATE() _PyIO_get_module_state()
 
+extern _PyIO_State *_PyIO_get_module_state(void);
 extern PyObject *_PyIO_get_locale_module(_PyIO_State *);
 
 extern PyObject *_PyIO_str_close;
diff --git a/Modules/_io/bufferedio.c b/Modules/_io/bufferedio.c
--- a/Modules/_io/bufferedio.c
+++ b/Modules/_io/bufferedio.c
@@ -91,7 +91,9 @@
 static PyObject *
 bufferediobase_unsupported(const char *message)
 {
- PyErr_SetString(IO_STATE->unsupported_operation, message);
+ _PyIO_State *state = IO_STATE();
+ if (state != NULL)
+ PyErr_SetString(state->unsupported_operation, message);
 return NULL;
 }
 
diff --git a/Modules/_io/fileio.c b/Modules/_io/fileio.c
--- a/Modules/_io/fileio.c
+++ b/Modules/_io/fileio.c
@@ -493,8 +493,10 @@
 static PyObject *
 err_mode(char *action)
 {
- PyErr_Format(IO_STATE->unsupported_operation,
- "File not open for %s", action);
+ _PyIO_State *state = IO_STATE();
+ if (state != NULL)
+ PyErr_Format(state->unsupported_operation,
+ "File not open for %s", action);
 return NULL;
 }
 
diff --git a/Modules/_io/iobase.c b/Modules/_io/iobase.c
--- a/Modules/_io/iobase.c
+++ b/Modules/_io/iobase.c
@@ -69,7 +69,9 @@
 static PyObject *
 iobase_unsupported(const char *message)
 {
- PyErr_SetString(IO_STATE->unsupported_operation, message);
+ _PyIO_State *state = IO_STATE();
+ if (state != NULL)
+ PyErr_SetString(state->unsupported_operation, message);
 return NULL;
 }
 
diff --git a/Modules/_io/textio.c b/Modules/_io/textio.c
--- a/Modules/_io/textio.c
+++ b/Modules/_io/textio.c
@@ -45,7 +45,9 @@
 static PyObject *
 _unsupported(const char *message)
 {
- PyErr_SetString(IO_STATE->unsupported_operation, message);
+ _PyIO_State *state = IO_STATE();
+ if (state != NULL)
+ PyErr_SetString(state->unsupported_operation, message);
 return NULL;
 }
 
@@ -852,7 +854,7 @@
 char *errors = NULL;
 char *newline = NULL;
 int line_buffering = 0, write_through = 0;
- _PyIO_State *state = IO_STATE;
+ _PyIO_State *state = NULL;
 
 PyObject *res;
 int r;
@@ -891,6 +893,9 @@
 if (encoding == NULL) {
 /* Try os.device_encoding(fileno) */
 PyObject *fileno;
+ state = IO_STATE();
+ if (state == NULL)
+ goto error;
 fileno = _PyObject_CallMethodId(buffer, &PyId_fileno, NULL);
 /* Ignore only AttributeError and UnsupportedOperation */
 if (fileno == NULL) {
-- 
Repository URL: http://hg.python.org/cpython
