( )⚙ D2868 util: prefer "bytesio" to "stringio"

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2868

util: prefer "bytesio" to "stringio"
ClosedPublic

Authored by indygreg on Mar 14 2018, 9:10 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG644a02f6b34f: util: prefer "bytesio" to "stringio"
rHG6619acb2fcbc: util: prefer "bytesio" to "stringio"
Summary

The io.BytesIO and io.StringIO types enforce the type of
data being operated on. On Python 2, we use cStringIO.StringIO(),
which is lax about mixing types. On Python 3, we actually use
io.BytesIO. Ideally, we'd use io.BytesIO on Python 2. But I believe
its performance is poor compared to cString.StringIO().

Anyway, we canonically define our pycompat type as "stringio."
That name is misleading, especially on Python 3.

This commit renames the canonical symbols to "bytesio."
"stringio" is preserved as an alias for API compatibility. There
are a lot of callers in the repo and I hesitate to take away the
old name. I also don't feel like changing everything at this time.
But at least new callers can use a "proper" name.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Mar 14 2018, 9:10 PM
pulkit accepted this revision.Mar 15 2018, 12:11 PM
Closed by commit rHG6619acb2fcbc: util: prefer "bytesio" to "stringio" (authored by indygreg). · Explain WhyMar 15 2018, 12:54 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 7046

mercurial/pure/mpatch.py

# mpatch.py - Python implementation of mpatch.c # mpatch.py - Python implementation of mpatch.c
# #
# Copyright 2009 Matt Mackall <mpm@selenic.com> and others # Copyright 2009 Matt Mackall <mpm@selenic.com> and others
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import struct import struct
from .. import pycompat from .. import pycompat
stringio = pycompat.stringio stringio = pycompat.bytesio
class mpatchError(Exception): class mpatchError(Exception):
"""error raised when a delta cannot be decoded """error raised when a delta cannot be decoded
""" """
# This attempts to apply a series of patches in time proportional to # This attempts to apply a series of patches in time proportional to
# the total size of the patches, rather than patches * len(text). This # the total size of the patches, rather than patches * len(text). This
# means rather than shuffling strings around, we shuffle around # means rather than shuffling strings around, we shuffle around

mercurial/pure/parsers.py

# parsers.py - Python implementation of parsers.c # parsers.py - Python implementation of parsers.c
# #
# Copyright 2009 Matt Mackall <mpm@selenic.com> and others # Copyright 2009 Matt Mackall <mpm@selenic.com> and others
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import struct import struct
import zlib import zlib
from ..node import nullid from ..node import nullid
from .. import pycompat from .. import pycompat
stringio = pycompat.stringio stringio = pycompat.bytesio
_pack = struct.pack _pack = struct.pack
_unpack = struct.unpack _unpack = struct.unpack
_compress = zlib.compress _compress = zlib.compress
_decompress = zlib.decompress _decompress = zlib.decompress
# Some code below makes tuples directly because it's more convenient. However, # Some code below makes tuples directly because it's more convenient. However,

mercurial/pycompat.py

osaltsep = osaltsep.encode('ascii') osaltsep = osaltsep.encode('ascii')
# os.getcwd() on Python 3 returns string, but it has os.getcwdb() which # os.getcwd() on Python 3 returns string, but it has os.getcwdb() which
# returns bytes. # returns bytes.
getcwd = os.getcwdb getcwd = os.getcwdb
sysplatform = sys.platform.encode('ascii') sysplatform = sys.platform.encode('ascii')
sysexecutable = sys.executable sysexecutable = sys.executable
if sysexecutable: if sysexecutable:
sysexecutable = os.fsencode(sysexecutable) sysexecutable = os.fsencode(sysexecutable)
stringio = io.BytesIO bytesio = io.BytesIO
# TODO deprecate stringio name, as it is a lie on Python 3.
stringio = bytesio
def maplist(*args): def maplist(*args):
return list(map(*args)) return list(map(*args))
def ziplist(*args): def ziplist(*args):
return list(zip(*args)) return list(zip(*args))
rawinput = input rawinput = input
stdout = sys.stdout stdout = sys.stdout
stderr = sys.stderr stderr = sys.stderr
if getattr(sys, 'argv', None) is not None: if getattr(sys, 'argv', None) is not None:
sysargv = sys.argv sysargv = sys.argv
sysplatform = sys.platform sysplatform = sys.platform
getcwd = os.getcwd getcwd = os.getcwd
sysexecutable = sys.executable sysexecutable = sys.executable
shlexsplit = shlex.split shlexsplit = shlex.split
stringio = cStringIO.StringIO bytesio = cStringIO.StringIO
stringio = bytesio
maplist = map maplist = map
ziplist = zip ziplist = zip
rawinput = raw_input rawinput = raw_input
getargspec = inspect.getargspec getargspec = inspect.getargspec
def emailparser(*args, **kwargs): def emailparser(*args, **kwargs):
import email.parser import email.parser
return email.parser.Parser(*args, **kwargs) return email.parser.Parser(*args, **kwargs)

mercurial/util.py

empty = pycompat.empty empty = pycompat.empty
httplib = pycompat.httplib httplib = pycompat.httplib
pickle = pycompat.pickle pickle = pycompat.pickle
queue = pycompat.queue queue = pycompat.queue
socketserver = pycompat.socketserver socketserver = pycompat.socketserver
stderr = pycompat.stderr stderr = pycompat.stderr
stdin = pycompat.stdin stdin = pycompat.stdin
stdout = pycompat.stdout stdout = pycompat.stdout
stringio = pycompat.stringio bytesio = pycompat.bytesio
# TODO deprecate stringio name, as it is a lie on Python 3.
stringio = bytesio
xmlrpclib = pycompat.xmlrpclib xmlrpclib = pycompat.xmlrpclib
httpserver = urllibcompat.httpserver httpserver = urllibcompat.httpserver
urlerr = urllibcompat.urlerr urlerr = urllibcompat.urlerr
urlreq = urllibcompat.urlreq urlreq = urllibcompat.urlreq
# workaround for win32mbcs # workaround for win32mbcs
_filenamebytestr = pycompat.bytestr _filenamebytestr = pycompat.bytestr