view contrib/debugshell.py @ 50734:d5cd1fd690f3 stable

hgweb: drop references to deprecated cgitb cgitb is going away and gives warnings when importing, and that make tests fail: $TESTTMP/hgweb.cgi:5: DeprecationWarning: 'cgitb' is deprecated and slated for removal in Python 3.13 The lack of a "nice" high level error handler is not a huge problem, neither for users (where it is disabled anyway) or for tests (where we don't use a browser and the plain tracebacks often are more readable). It is inevitable that it is going away, and there is no obvious alternative. Remove it and move on.
author Mads Kiilerich <mads@kiilerich.com>
date Mon, 26 Jun 2023 18:00:28 +0200
parents 6000f5b25c9b
children
line wrap: on
line source

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

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)