This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9866

debugshell: add a simple command for starting an interactive shell
ClosedPublic

Authored by joerg.sonnenberger on Jan 25 2021, 6:19 PM.

Details

Reviewers
mharbison72
Group Reviewers
hg-reviewers
Commits
rHGf25c770c217b: debugshell: add a simple command for starting an interactive shell
rHGbe0cdcd8b9f9: debugshell: add a simple command for starting an interactive shell
Summary

This simplifies interactive exploration of the Mercurial APIs.
The ui and repo instances are provided as local variables.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

mharbison72 added a subscriber: mharbison72.Jan 25 2021, 6:50 PM

Ultimately I'd like to add support for a -m to be able to pip install --user. I assume there's a way to do that with the code module?

As mentioned in IRC, -c ... can be done with echoing into this command. I'll have to look at some of my setup script stuff, but I think it might be nice to have -c that doesn't print all of the REPL banner stuff because keyring on Linux usually requires running some python commands to print where various files are stored. But that's all future stuff. I'm happy with this once the optional repo question is answered/fixed. (Also, this needs hg fix.)

mercurial/debugcommands.py
3721

Should repo be optional? It's somewhat less useful that way, but it's valid to run some commands with no repo, so it might be worth the ability to poke around at the internals in that state.

marmoute added a subscriber: marmoute.Jan 26 2021, 10:35 AM

Note that once D9872 is in, I'll loby for this comand to be name admin::python

joerg.sonnenberger marked an inline comment as done.Jan 26 2021, 11:05 AM

Actually, I believe this really belongs into a/the debug namespace, not admin. It's a much lower level than all other tools and not a user interface in any form.

mharbison72 accepted this revision.Jan 27 2021, 12:26 AM
This revision is now accepted and ready to land.Jan 27 2021, 12:26 AM
pulkit added a subscriber: pulkit.Jan 27 2021, 5:27 AM

Can you followup by removing the debugshell in contrib/ then? https://www.mercurial-scm.org/repo/hg/file/tip/contrib/debugshell.py

Revision Contents
Changeset List

PathPackages
Mmercurial/debugcommands.py (17 lines)
Mtests/test-completion.t (2 lines)
Mtests/test-help.t (1 line)

Diff 25292

mercurial/debugcommands.py

def debugsub(ui, repo, rev=None): def debugsub(ui, repo, rev=None):
ctx = scmutil.revsingle(repo, rev, None) ctx = scmutil.revsingle(repo, rev, None)
for k, v in sorted(ctx.substate.items()): for k, v in sorted(ctx.substate.items()):
ui.writenoi18n(b'path %s\n' % k) ui.writenoi18n(b'path %s\n' % k)
ui.writenoi18n(b' source %s\n' % v[0]) ui.writenoi18n(b' source %s\n' % v[0])
ui.writenoi18n(b' revision %s\n' % v[1]) ui.writenoi18n(b' revision %s\n' % v[1])
@command(b'debugshell', optionalrepo=True)
def debugshell(ui, repo):
mharbison72Unsubmitted
Done

Should repo be optional? It's somewhat less useful that way, but it's valid to run some commands with no repo, so it might be worth the ability to poke around at the internals in that state.

mharbison72: Should `repo` be optional? It's somewhat less useful that way, but it's valid to run some…
"""run an interactive Python interpreter
The local namespace is provided with a reference to the ui and
the repo instance (if available).
"""
import code
imported_objects = {
'ui': ui,
'repo': repo,
}
code.interact(local=imported_objects)
@command( @command(
b'debugsuccessorssets', b'debugsuccessorssets',
[(b'', b'closest', False, _(b'return closest successors sets only'))], [(b'', b'closest', False, _(b'return closest successors sets only'))],
_(b'[REV]'), _(b'[REV]'),
) )
def debugsuccessorssets(ui, repo, *revs, **opts): def debugsuccessorssets(ui, repo, *revs, **opts):
"""show set of successors for revision """show set of successors for revision

tests/test-completion.t

debugrebuildfncache debugrebuildfncache
debugrename debugrename
debugrequires debugrequires
debugrevlog debugrevlog
debugrevlogindex debugrevlogindex
debugrevspec debugrevspec
debugserve debugserve
debugsetparents debugsetparents
debugshell
debugsidedata debugsidedata
debugssl debugssl
debugstrip debugstrip
debugsub debugsub
debugsuccessorssets debugsuccessorssets
debugtagscache debugtagscache
debugtemplate debugtemplate
debuguigetpass debuguigetpass
debugrebuildfncache: debugrebuildfncache:
debugrename: rev debugrename: rev
debugrequires: debugrequires:
debugrevlog: changelog, manifest, dir, dump debugrevlog: changelog, manifest, dir, dump
debugrevlogindex: changelog, manifest, dir, format debugrevlogindex: changelog, manifest, dir, format
debugrevspec: optimize, show-revs, show-set, show-stage, no-optimized, verify-optimized debugrevspec: optimize, show-revs, show-set, show-stage, no-optimized, verify-optimized
debugserve: sshstdio, logiofd, logiofile debugserve: sshstdio, logiofd, logiofile
debugsetparents: debugsetparents:
debugshell:
debugsidedata: changelog, manifest, dir debugsidedata: changelog, manifest, dir
debugssl: debugssl:
debugstrip: rev, force, no-backup, nobackup, , keep, bookmark, soft debugstrip: rev, force, no-backup, nobackup, , keep, bookmark, soft
debugsub: rev debugsub: rev
debugsuccessorssets: closest debugsuccessorssets: closest
debugtagscache: debugtagscache:
debugtemplate: rev, define debugtemplate: rev, define
debuguigetpass: prompt debuguigetpass: prompt

tests/test-help.t

debugrevlog show data and statistics about a revlog debugrevlog show data and statistics about a revlog
debugrevlogindex debugrevlogindex
dump the contents of a revlog index dump the contents of a revlog index
debugrevspec parse and apply a revision specification debugrevspec parse and apply a revision specification
debugserve run a server with advanced settings debugserve run a server with advanced settings
debugsetparents debugsetparents
manually set the parents of the current working directory manually set the parents of the current working directory
(DANGEROUS) (DANGEROUS)
debugshell run an interactive Python interpreter
debugsidedata debugsidedata
dump the side data for a cl/manifest/file revision dump the side data for a cl/manifest/file revision
debugssl test a secure connection to a server debugssl test a secure connection to a server
debugstrip strip changesets and all their descendants from the repository debugstrip strip changesets and all their descendants from the repository
debugsub (no help text available) debugsub (no help text available)
debugsuccessorssets debugsuccessorssets
show set of successors for revision show set of successors for revision
debugtagscache debugtagscache