pip._internal.utils.encoding Namespace Reference

Functions
str	auto_decode (bytes data)

Variables
list	BOMS
	ENCODING_RE = re.compile(rb"coding[:=]\s*([-\w.]+)")

Function Documentation

auto_decode()

str auto_decode

(

bytes

data

)

Check a bytes string for a BOM to correctly detect the encoding

Fallback to locale.getpreferredencoding(False) like open() on Python3

Definition at line 20 of file encoding.py.

def auto_decode(data: bytes) -> str:
    """Check a bytes string for a BOM to correctly detect the encoding
 
    Fallback to locale.getpreferredencoding(False) like open() on Python3"""
    for bom, encoding in BOMS:
        if data.startswith(bom):
            return data[len(bom) :].decode(encoding)
    # Lets check the first two lines as in PEP263
    for line in data.split(b"\n")[:2]:
        if line[0:1] == b"#" and ENCODING_RE.search(line):
            result = ENCODING_RE.search(line)
            assert result is not None
            encoding = result.groups()[0].decode("ascii")
            return data.decode(encoding)
    return data.decode(
        locale.getpreferredencoding(False) or sys.getdefaultencoding(),
    )

References i.

Variable Documentation

BOMS

list BOMS

Initial value:

=  [
    (codecs.BOM_UTF8, "utf-8"),
    (codecs.BOM_UTF16, "utf-16"),
    (codecs.BOM_UTF16_BE, "utf-16-be"),
    (codecs.BOM_UTF16_LE, "utf-16-le"),
    (codecs.BOM_UTF32, "utf-32"),
    (codecs.BOM_UTF32_BE, "utf-32-be"),
    (codecs.BOM_UTF32_LE, "utf-32-le"),
]

Definition at line 7 of file encoding.py.

ENCODING_RE

ENCODING_RE = re.compile(rb"coding[:=]\s*([-\w.]+)")

Definition at line 17 of file encoding.py.