pycompat: use os.fsencode() to re-encode sys.argv
Historically, the previous code made sense, as Py_EncodeLocale() and
fs.fsencode() could possibly use different encodings. However, this is not the
case anymore for Python 3.2, which uses the locale encoding as the filesystem
encoding (this is not true for later Python versions, but see below). See
https://vstinner.github.io/painful-history-python-filesystem-encoding.html for
a source and more background information.
Using os.fsencode() is safer, as the documentation for sys.argv says that it can
be used to get the original bytes. When doing further changes, the Python
developers will take care that this continues to work.
One concrete case where os.fsencode() is more correct is when enabling Python's
UTF-8 mode. Py_DecodeLocale() will use UTF-8 in this case. Our previous code
would have encoded it using the locale encoding (which might be different),
whereas os.fsencode() will encode it with UTF-8.
Since we don’t claim to support the UTF-8 mode, this is not really a bug and the
patch can go to the default branch. It might be a good idea to not commit this
to the stable branch, as it could in theory introduce regressions.
mock bugzilla driver for testing template output:
$ cat <<EOF > bzmock.py
> from __future__ import absolute_import
> from mercurial import extensions
> from mercurial import pycompat
> from mercurial import registrar
> from mercurial.utils import stringutil
>
> configtable = {}
> configitem = registrar.configitem(configtable)
>
> configitem(b'bugzilla', b'mocklog',
> default=None,
> )
> def extsetup(ui):
> bugzilla = extensions.find(b'bugzilla')
> class bzmock(bugzilla.bzaccess):
> def __init__(self, ui):
> super(bzmock, self).__init__(ui)
> self._logfile = ui.config(b'bugzilla', b'mocklog')
> def updatebug(self, bugid, newstate, text, committer):
> with open(pycompat.fsdecode(self._logfile), 'ab') as f:
> f.write(b'update bugid=%s, newstate=%s, committer=%s\n'
> % (stringutil.pprint(bugid),
> stringutil.pprint(newstate),
> stringutil.pprint(committer)))
> f.write(b'----\n' + text + b'\n----\n')
> def notify(self, bugs, committer):
> with open(pycompat.fsdecode(self._logfile), 'ab') as f:
> f.write(b'notify bugs=%s, committer=%s\n'
> % (stringutil.pprint(bugs),
> stringutil.pprint(committer)))
> bugzilla.bugzilla._versions[b'mock'] = bzmock
> EOF
set up mock repository:
$ hg init mockremote
$ cat <<EOF > mockremote/.hg/hgrc
> [extensions]
> bugzilla =
> bzmock = $TESTTMP/bzmock.py
>
> [bugzilla]
> version = mock
> mocklog = $TESTTMP/bzmock.log
>
> [hooks]
> incoming.bugzilla = python:hgext.bugzilla.hook
>
> [web]
> baseurl=http://example.org/hg
>
> %include $TESTTMP/bzstyle.hgrc
> EOF
$ hg clone -q mockremote mocklocal
push with default template:
$ echo '[bugzilla]' > bzstyle.hgrc
$ echo foo > mocklocal/foo
$ hg ci -R mocklocal -Aqm 'Fixes bug 123'
$ hg -R mocklocal push -q
$ cat bzmock.log && rm bzmock.log
update bugid=123, newstate={}, committer='test'
----
changeset 7875a8342c6f in repo $TESTTMP/mockremote refers to bug 123.
details:
Fixes bug 123
----
notify bugs={123: {}}, committer='test'
push with style:
$ cat <<EOF > bzstyle.map
> changeset = "{node|short} refers to bug {bug}."
> EOF
$ echo "style = $TESTTMP/bzstyle.map" >> bzstyle.hgrc
$ echo foo >> mocklocal/foo
$ hg ci -R mocklocal -qm 'Fixes bug 456'
$ hg -R mocklocal push -q
$ cat bzmock.log && rm bzmock.log
update bugid=456, newstate={}, committer='test'
----
2808b172464b refers to bug 456.
----
notify bugs={456: {}}, committer='test'
push with template (overrides style):
$ cat <<EOF >> bzstyle.hgrc
> template = Changeset {node|short} in {root|basename}.
> {hgweb}/rev/{node|short}\n
> {desc}
> EOF
$ echo foo >> mocklocal/foo
$ hg ci -R mocklocal -qm 'Fixes bug 789'
$ hg -R mocklocal push -q
$ cat bzmock.log && rm bzmock.log
update bugid=789, newstate={}, committer='test'
----
Changeset a770f3e409f2 in mockremote.
http://example.org/hg/rev/a770f3e409f2
Fixes bug 789
----
notify bugs={789: {}}, committer='test'