pickle is unable to encode unicode surrogates

[vstinner]

BPO	8383
Nosy	@malemburg, @loewis, @vstinner
Files	pickle_surrogates.patch

^{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 = None
closed_at = <Date 2010-04-13.11:10:22.602>
created_at = <Date 2010-04-13.00:39:55.090>
labels = ['library']
title = 'pickle is unable to encode unicode surrogates'
updated_at = <Date 2010-04-13.11:10:22.601>
user = 'https://github.com/vstinner'

bugs.python.org fields:

activity = <Date 2010-04-13.11:10:22.601>
actor = 'vstinner'
assignee = 'none'
closed = True
closed_date = <Date 2010-04-13.11:10:22.602>
closer = 'vstinner'
components = ['Library (Lib)']
creation = <Date 2010-04-13.00:39:55.090>
creator = 'vstinner'
dependencies = []
files = ['16904']
hgrepos = []
issue_num = 8383
keywords = ['patch']
message_count = 6.0
messages = ['102996', '102997', '103022', '103029', '103030', '103034']
nosy_count = 3.0
nosy_names = ['lemburg', 'loewis', 'vstinner']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue8383'
versions = ['Python 3.1', 'Python 3.2']

[vstinner]

Python3 uses unicode surrogates to store undecodable filenames. Eg. the filename b"abc\xff.py" is encoded as "abc\xdcff.py" if the file system encoding is ASCII. Pickle is unable to store them:

./python -c 'import pickle; pickle.dumps("abc\udcff")'
(...)
UnicodeEncodeError: 'utf-8' codec can't encode character '\udcff' in position 20: surrogates not allowed

This is a limitation of pickle (in the binary mode): Python accepts to store any unicode character, but pickle doesn't.

Using "surrogatepass" error handler should be enough to fix this issue.

Related issue: bpo-3672 (Reject surrogates in utf-8 codec) -> r72208 creates "surrogatepass" error handler.

[vstinner]

I found this bug indirectly: test_logging failed on a SocketHandler if LogRecord.pathname contains a surrogate character. SocketHandler uses pickle to serialize the record.

[malemburg]

Both pickle and marshal will need to use the new error handler in order to stay compatible with Python 3.0 (and 2.x) and also to enable creating Unicode literals that include lone surrogates.

[vstinner]

Both pickle and marshal will need to use the new error handler
in order to stay compatible with Python 3.0 (and 2.x)
and also to enable creating Unicode literals that include
lone surrogates.

Attached patch fixes pickle. Marshal does already use surrogatepass since Martin's commit r72208 (Issue bpo-3672).

[malemburg]

STINNER Victor wrote:

STINNER Victor <victor.stinner@haypocalc.com> added the comment:

> Both pickle and marshal will need to use the new error handler
> in order to stay compatible with Python 3.0 (and 2.x)
> and also to enable creating Unicode literals that include
> lone surrogates.

Attached patch fixes pickle. Marshal does already use surrogatepass since Martin's commit r72208 (Issue bpo-3672).

Looks good !

Thanks.

[vstinner]

Commited: r80031 (py3k) and r80032 (3.1), fix also pickletools.