UTF-8-Sig codec

[doerwalter]

BPO	1177307
Nosy	@loewis, @doerwalter
Files	diff.txt diff2.txt: Better handling of partial BOMs diff3.txt UnicodeBOM.txt

^{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/loewis'
closed_at = <Date 2006-01-08.10:46:05.000>
created_at = <Date 2005-04-05.19:26:11.000>
labels = ['library']
title = 'UTF-8-Sig codec'
updated_at = <Date 2006-01-08.10:46:05.000>
user = 'https://github.com/doerwalter'

bugs.python.org fields:

activity = <Date 2006-01-08.10:46:05.000>
actor = 'loewis'
assignee = 'loewis'
closed = True
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2005-04-05.19:26:11.000>
creator = 'doerwalter'
dependencies = []
files = ['6593', '6594', '6595', '6596']
hgrepos = []
issue_num = 1177307
keywords = ['patch']
message_count = 7.0
messages = ['48154', '48155', '48156', '48157', '48158', '48159', '48160']
nosy_count = 2.0
nosy_names = ['loewis', 'doerwalter']
pr_nums = []
priority = 'normal'
resolution = 'accepted'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1177307'
versions = []

[doerwalter]

This patch implements a UTF-8-Sig codec. This codec
works like UTF-8 but adds a BOM on writing and skips
(at most) one BOM on reading.

[doerwalter]

Logged In: YES
user_id=89016

This second version of the patch will return starting bytes
immediately, if they don't look like a BOM.

[loewis]

Logged In: YES
user_id=21627

The patch looks fine, but lacks documentation changes.

[doerwalter]

Logged In: YES
user_id=89016

This version (diff3.txt) of the patch adds a note to
Misc/NEWS and a section to Doc/lib/libcodecs.tex. Is this
the correct place to add the documentation?

[loewis]

Logged In: YES
user_id=21627

The place is right, but I feel this documentation is
incomplete still. The library reference should explain
somewhere what the difference between utf-8 and utf-8-sig
is. Perhaps a footnote could be added. I think I would
prefer a separate subsection on the BOM, explaining byte
order in UTF-{16,32}, and how the BOM can be used as a magic
signature for UTF-8.

[doerwalter]

Logged In: YES
user_id=89016

OK, here's a text that explains what the BOM is used for in
various Unicode encodings. I hope that this can be turned
into something useful.

[loewis]

Logged In: YES
user_id=21627

Thanks for the patch. Committed as 41977.