contrib/debugshell.py
author Pierre-Yves David <pierre-yves.david@octobus.net>
Mon, 03 May 2021 12:22:16 +0200
changeset 47162 a07d5cb03a85
parent 43080 86e4daa2d54c
child 48966 6000f5b25c9b
permissions -rw-r--r--
revlog: rename `indexfile` to `_indexfile` We want to make the actual location of the indexfile and location more of an implementation details than what is is currently. In that process, we make the attribute private. Differential Revision: https://phab.mercurial-scm.org/D10574

# debugshell extension
"""a python shell with repo, changelog & manifest objects"""

from __future__ import absolute_import
import code
import mercurial
import sys
from mercurial import (
    demandimport,
    pycompat,
    registrar,
)

cmdtable = {}
command = registrar.command(cmdtable)


def pdb(ui, repo, msg, **opts):
    objects = {
        'mercurial': mercurial,
        'repo': repo,
        'cl': repo.changelog,
        'mf': repo.manifestlog,
    }

    code.interact(msg, local=objects)


def ipdb(ui, repo, msg, **opts):
    import IPython

    cl = repo.changelog
    mf = repo.manifestlog
    cl, mf  # use variables to appease pyflakes

    IPython.embed()


@command(b'debugshell|dbsh', [])
def debugshell(ui, repo, **opts):
    bannermsg = "loaded repo : %s\n" "using source: %s" % (
        pycompat.sysstr(repo.root),
        mercurial.__path__[0],
    )

    pdbmap = {'pdb': 'code', 'ipdb': 'IPython'}

    debugger = ui.config(b"ui", b"debugger")
    if not debugger:
        debugger = 'pdb'
    else:
        debugger = pycompat.sysstr(debugger)

    # if IPython doesn't exist, fallback to code.interact
    try:
        with demandimport.deactivated():
            __import__(pdbmap[debugger])
    except ImportError:
        ui.warnnoi18n(
            b"%s debugger specified but %s module was not found\n"
            % (debugger, pdbmap[debugger])
        )
        debugger = b'pdb'

    getattr(sys.modules[__name__], debugger)(ui, repo, bannermsg, **opts)