mercurial/txnutil.py

extensions: avoid including `__index__` in the disabled extension list

This generated module contains a dictionary of all bundled extension names and
their help for builds that cannot enumerate extensions in the filesystem.

The disabled list gets displayed in `hg help extensions`, and is also used by
`setup.py` to populate `__index__.py` when building.  I haven't seen it sneak
into either py2exe or PyOxidizer builds, but it does show up when running tests
locally after having created an installer.

Differential Revision: https://phab.mercurial-scm.org/D9544

# txnutil.py - transaction related utilities
#
#  Copyright FUJIWARA Katsunori <[e-mail]> and others
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.

from __future__ import absolute_import

import errno

from . import encoding


def mayhavepending(root):
    """return whether 'root' may have pending changes, which are
    visible to this process.
    """
    return root == encoding.environ.get(b'HG_PENDING')


def trypending(root, vfs, filename, **kwargs):
    """Open  file to be read according to HG_PENDING environment variable

    This opens '.pending' of specified 'filename' only when HG_PENDING
    is equal to 'root'.

    This returns '(fp, is_pending_opened)' tuple.
    """
    if mayhavepending(root):
        try:
            return (vfs(b'%s.pending' % filename, **kwargs), True)
        except IOError as inst:
            if inst.errno != errno.ENOENT:
                raise
    return (vfs(filename, **kwargs), False)