( )⚙ D8347 encoding: use special dictionary type for env variables on Windows

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8347

encoding: use special dictionary type for env variables on Windows
Needs RevisionPublic

Authored by indygreg on Mar 29 2020, 9:30 PM.

Details

Reviewers
marmoute
baymax
Group Reviewers
hg-reviewers
Summary

Environment variables on Windows are case insensitive and Python
internally uses a special dict type that normalizes all keys to
uppercase.

Our custom bytes-based environment variable dict on Windows was
not aware of this, leading to failures when looking up lower case
environment variables (such as http_proxy).

This commit introduces a custom dict type that normalizes keys
to uppercase on Windows. test-http-proxy.t passes after this
change, as a lookup of b'http_proxy' now succeeds.

It's worth noting that Python's behavior with regards to
normalizing all environment variables to uppercase is buggy.
See https://bugs.python.org/issue28824. I preserved Python's
behavior for compatibility.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.Mar 29 2020, 9:30 PM
marmoute accepted this revision.Apr 17 2020, 2:31 PM
marmoute added a subscriber: marmoute.

Urg, this make me sad, but seems a reasonable way to move forward.

baymax requested changes to this revision.Jul 31 2020, 1:56 PM

There seems to have been no activities on this Diff for the past 3 Months.

By policy, we are automatically moving it out of the need-review state.

Please, move it back to need-review without hesitation if this diff should still be discussed.

:baymax:need-review-idle:

This revision now requires changes to proceed.Jul 31 2020, 1:56 PM

Revision Contents
Changeset List

PathPackages
Mmercurial/encoding.py (36 lines)

Diff 20920

mercurial/encoding.py

if not _nativeenviron: if not _nativeenviron:
# now encoding and helper functions are available, recreate the environ # now encoding and helper functions are available, recreate the environ
# dict to be exported to other modules # dict to be exported to other modules
environ = { environ = {
tolocal(k.encode('utf-8')): tolocal(v.encode('utf-8')) tolocal(k.encode('utf-8')): tolocal(v.encode('utf-8'))
for k, v in os.environ.items() # re-exports for k, v in os.environ.items() # re-exports
} }
# Environment variables are normalized to uppercase on Windows. So wrap
# in a custom type to emulate what the standard library does.
if pycompat.ispy3 and pycompat.iswindows:
class UppercaseDict(dict):
def __init__(self, values):
super(UppercaseDict, self).__init__()
for k, v in values.items():
self[k] = v
def __setitem__(self, key, value):
super(UppercaseDict, self).__setitem__(key.upper(), value)
def __getitem__(self, key):
return super(UppercaseDict, self).__getitem__(key.upper())
def __delitem__(self, key):
super(UppercaseDict, self).__delitem__(key.upper())
def __contains__(self, key):
return super(UppercaseDict, self).__contains__(key.upper())
def get(self, key, *args):
return super(UppercaseDict, self).get(key.upper(), *args)
def pop(self, key, *args):
return super(UppercaseDict, self).pop(key.upper(), *args)
def update(self):
raise NotImplementedError
def setdefault(self, key, *args):
return super(UppercaseDict, self).setdefault(key.upper(), *args)
environ = UppercaseDict(environ)
if pycompat.ispy3: if pycompat.ispy3:
# 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.
if pycompat.iswindows: if pycompat.iswindows:
# Python 3 on Windows issues a DeprecationWarning about using the bytes # Python 3 on Windows issues a DeprecationWarning about using the bytes
# API when os.getcwdb() is called. # API when os.getcwdb() is called.
getcwd = lambda: strtolocal(os.getcwd()) # re-exports getcwd = lambda: strtolocal(os.getcwd()) # re-exports
else: else: