This is an archive of the discontinued Mercurial Phabricator instance.

Differential D613

dispatch: store the command name which is going to run in ui object
AbandonedPublic

Authored by durin42 on Sep 2 2017, 11:38 AM.

Download Raw Diff

Details

Reviewers

pulkit

Group Reviewers

hg-reviewers

Summary

This patch stores the command which is going to run in the ui object in
_internal.command. This will help us in checking which command we are running
where ever we need command specific logic instead of putting the logic in every
command.

Diff Detail

Repository

rHG Mercurial

Lint

Lint Skipped

Unit

Unit Tests Skipped

Event Timeline

pulkit created this revision.Sep 2 2017, 11:38 AM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptSep 2 2017, 11:38 AM

Herald added a subscriber: mercurial-devel. · View Herald Transcript

This reminds me the following patch series. The discussion was quite long, but
IIRC, we generally liked the functionality, but didn't like the implementation
that abuses "ui" object.

http://mercurial.markmail.org/message/4wlaxqjqs74vpyxy

This will help us in checking which command we are running
where ever we need command specific logic instead of putting the logic in every
command.

Do you have any usage example?

tests/test-basic.t
5	Perhaps this shouldn't be exposed (i.e. shouldn't be a config value.)

This is for directaccess as directaccess originally designed (https://www.mercurial-scm.org/repo/evolve/rev/b8f880d417)

It may be cleaner to use a flag of scmutil.rev* instead. So commands themselves could decide whether to enable directaccess or not.

In D613#10467, @quark wrote:

This is for directaccess as directaccess originally designed (https://www.mercurial-scm.org/repo/evolve/rev/b8f880d417)
It may be cleaner to use a flag of scmutil.rev* instead. So commands themselves could decide whether to enable directaccess or not.

Perhaps it could be a read-only flag (or class) set to repo object?

In D613#10670, @yuja wrote:

Perhaps it could be a read-only flag (or class) set to repo object?

Yes. It seems repo.filtername may be a reasonable choice.

pulkit planned changes to this revision.Sep 9 2017, 1:32 PM

My understanding is that we're moving towards a marker in the command registrar to decide what repo filter to use, which seems cleaner. Please reopen this (and commandeer it if needed) if I'm wrong. Thanks!

Revision Contents
Changeset List

			Path	Packages
M			mercurial/dispatch.py (9 lines)
M			tests/test-basic.t (3 lines)
M			tests/test-commandserver.t (7 lines)
M			tests/test-dispatch.t (41 lines)
M			tests/test-hgrc.t (9 lines)

Diff 1579

mercurial/dispatch.py


	# check for fallback encoding			# check for fallback encoding
	fallback = lui.config('ui', 'fallbackencoding')			fallback = lui.config('ui', 'fallbackencoding')
	if fallback:			if fallback:
	encoding.fallbackencoding = fallback			encoding.fallbackencoding = fallback

	fullargs = args			fullargs = args
	cmd, func, args, options, cmdoptions = _parse(lui, args)			cmd, func, args, options, cmdoptions = _parse(lui, args)
				cmdname = ''
				# An alias is passed, func is cmdalias object
				if util.safehasattr(func, 'cmdname'):
				cmdname = func.cmdname
				else:
				cmdname = cmd

				for ui_ in uis:
				ui_.setconfig('_internal', 'command', cmdname, 'dispatch')

	if options["config"]:			if options["config"]:
	raise error.Abort(_("option --config may not be abbreviated!"))			raise error.Abort(_("option --config may not be abbreviated!"))
	if options["cwd"]:			if options["cwd"]:
	raise error.Abort(_("option --cwd may not be abbreviated!"))			raise error.Abort(_("option --cwd may not be abbreviated!"))
	if options["repository"]:			if options["repository"]:
	raise error.Abort(_(			raise error.Abort(_(
	"option -R has to be separated from other options (e.g. not "			"option -R has to be separated from other options (e.g. not "

tests/test-basic.t

	Create a repository:			Create a repository:

	$ hg config			$ hg config
				extensions.fsmonitor= (fsmonitor !)
				_internal.command=config
				yujaUnsubmitted Not Done Perhaps this shouldn't be exposed (i.e. shouldn't be a config value.) yuja: Perhaps this shouldn't be exposed (i.e. shouldn't be a config value.)
	devel.all-warnings=true			devel.all-warnings=true
	devel.default-date=0 0			devel.default-date=0 0
	extensions.fsmonitor= (fsmonitor !)
	largefiles.usercache=$TESTTMP/.cache/largefiles (glob)			largefiles.usercache=$TESTTMP/.cache/largefiles (glob)
	ui.slash=True			ui.slash=True
	ui.interactive=False			ui.interactive=False
	ui.mergemarkers=detailed			ui.mergemarkers=detailed
	ui.promptecho=True			ui.promptecho=True
	web.address=localhost			web.address=localhost
	web\.ipv6=(?:True\|False) (re)			web\.ipv6=(?:True\|False) (re)
	$ hg init t			$ hg init t

tests/test-commandserver.t

	... # the cached repo local hgrc contains ui.foo=bar, so showconfig should			... # the cached repo local hgrc contains ui.foo=bar, so showconfig should
	... # show it			... # show it
	... runcommand(server, ['showconfig'], outfilter=sep)			... runcommand(server, ['showconfig'], outfilter=sep)
	...			...
	... # but not for this repo			... # but not for this repo
	... runcommand(server, ['init', 'foo'])			... runcommand(server, ['init', 'foo'])
	... runcommand(server, ['-R', 'foo', 'showconfig', 'ui', 'defaults'])			... runcommand(server, ['-R', 'foo', 'showconfig', 'ui', 'defaults'])
	*** runcommand showconfig			*** runcommand showconfig
				extensions.fsmonitor= (fsmonitor !)
				ui.usehttp2=true (?)
				ui.usehttp2=true (?)
				_internal.command=config
	bundle.mainreporoot=$TESTTMP/repo			bundle.mainreporoot=$TESTTMP/repo
	devel.all-warnings=true			devel.all-warnings=true
	devel.default-date=0 0			devel.default-date=0 0
	extensions.fsmonitor= (fsmonitor !)
	largefiles.usercache=$TESTTMP/.cache/largefiles			largefiles.usercache=$TESTTMP/.cache/largefiles
	ui.slash=True			ui.slash=True
	ui.interactive=False			ui.interactive=False
	ui.mergemarkers=detailed			ui.mergemarkers=detailed
	ui.usehttp2=true (?)
	ui.foo=bar			ui.foo=bar
	ui.nontty=true			ui.nontty=true
	web.address=localhost			web.address=localhost
	web\.ipv6=(?:True\|False) (re)			web\.ipv6=(?:True\|False) (re)
	*** runcommand init foo			*** runcommand init foo
	*** runcommand -R foo showconfig ui defaults			*** runcommand -R foo showconfig ui defaults
	ui.slash=True			ui.slash=True
	ui.interactive=False			ui.interactive=False
	ui.mergemarkers=detailed			ui.mergemarkers=detailed
	ui.usehttp2=true (?)
	ui.nontty=true			ui.nontty=true

	$ rm -R foo			$ rm -R foo

	#if windows			#if windows
	$ PYTHONPATH="$TESTTMP/repo;$PYTHONPATH"			$ PYTHONPATH="$TESTTMP/repo;$PYTHONPATH"
	#else			#else
	$ PYTHONPATH="$TESTTMP/repo:$PYTHONPATH"			$ PYTHONPATH="$TESTTMP/repo:$PYTHONPATH"

tests/test-dispatch.t


	No repo:			No repo:

	$ hg cat			$ hg cat
	abort: no repository found in '$TESTTMP' (.hg not found)!			abort: no repository found in '$TESTTMP' (.hg not found)!
	[255]			[255]

	#endif			#endif

				Test storing of command in ui object by wrapping the dispatch.runcommand

				$ cat > checkui.py <<EOF
				> from mercurial import commands, registrar, util, extensions, dispatch
				> cmdtable = {}
				> command = registrar.command(cmdtable)
				> def extsetup():
				> extensions.wrapfunction(dispatch, '_runcommand', printcommandname)
				> def printcommandname(orig, ui, options, cmd, cmdfunc):
				> command = ui.config('_internal', 'command')
				> ui.write('%s\n' % command)
				> EOF

				Enable the extension after init to make sure it works

				$ hg init testui
				$ cd testui
				$ echo '[extensions]' >> $HGRCPATH
				$ echo "checkui = $TESTTMP/checkui.py" >> $HGRCPATH
				$ hg log
				log
				$ hg diff
				diff

				Testing short hand ones

				$ hg exp
				export
				$ hg ci
				commit

				Testing aliases

				$ echo '[alias]' >> $HGRCPATH
				$ echo "show = export" >> $HGRCPATH
				$ echo "glog = log -G" >> $HGRCPATH
				$ hg show
				export
				$ hg glog
				log

tests/test-hgrc.t

	# my-clone = /home/jdoe/jdoes-clone			# my-clone = /home/jdoe/jdoes-clone

	[ui]			[ui]
	# name and email (local to this repository, optional), e.g.			# name and email (local to this repository, optional), e.g.
	# username = Jane Doe <jdoe@example.com>			# username = Jane Doe <jdoe@example.com>
	$ hg paths			$ hg paths
	default = $TESTTMP/foo%bar (glob)			default = $TESTTMP/foo%bar (glob)
	$ hg showconfig			$ hg showconfig
				_internal.command=config
	bundle.mainreporoot=$TESTTMP/foobar (glob)			bundle.mainreporoot=$TESTTMP/foobar (glob)
	paths.default=$TESTTMP/foo%bar (glob)			paths.default=$TESTTMP/foo%bar (glob)
	$ cd ..			$ cd ..

	issue1829: wrong indentation			issue1829: wrong indentation

	$ echo '[foo]' > $HGRC			$ echo '[foo]' > $HGRC
	$ echo ' x = y' >> $HGRC			$ echo ' x = y' >> $HGRC
	Copyright (C) 2005-* Matt Mackall and others (glob)			Copyright (C) 2005-* Matt Mackall and others (glob)
	This is free software; see the source for copying conditions. There is NO			This is free software; see the source for copying conditions. There is NO
	warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.			warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
	$ unset FAKEPATH			$ unset FAKEPATH

	make sure global options given on the cmdline take precedence			make sure global options given on the cmdline take precedence

	$ hg showconfig --config ui.verbose=True --quiet			$ hg showconfig --config ui.verbose=True --quiet
				_internal.command=config
	bundle.mainreporoot=$TESTTMP			bundle.mainreporoot=$TESTTMP
	ui.verbose=False			ui.verbose=False
	ui.debug=False			ui.debug=False
	ui.quiet=True			ui.quiet=True

	$ touch foobar/untracked			$ touch foobar/untracked
	$ cat >> foobar/.hg/hgrc <<EOF			$ cat >> foobar/.hg/hgrc <<EOF
	> [ui]			> [ui]
	$ cd usertest			$ cd usertest
	$ touch bar			$ touch bar
	$ hg commit --addremove --quiet -m "added bar"			$ hg commit --addremove --quiet -m "added bar"
	$ hg log --template "{author}\n"			$ hg log --template "{author}\n"
	John Doe			John Doe
	$ cd ..			$ cd ..

	$ hg showconfig			$ hg showconfig
				_internal.command=config
	bundle.mainreporoot=$TESTTMP			bundle.mainreporoot=$TESTTMP
	ui.username=$FAKEUSER			ui.username=$FAKEUSER

	$ unset FAKEUSER			$ unset FAKEUSER
	$ HGUSER=$olduser			$ HGUSER=$olduser
	$ export HGUSER			$ export HGUSER

	showconfig with multiple arguments			showconfig with multiple arguments
	$ echo "identify=-n" >> $HGRC			$ echo "identify=-n" >> $HGRC
	$ echo "[alias]" >> $HGRC			$ echo "[alias]" >> $HGRC
	$ echo "log=log -g" >> $HGRC			$ echo "log=log -g" >> $HGRC

	customized hgrc			customized hgrc

	$ hg showconfig			$ hg showconfig
	read config from: $TESTTMP/hgrc			read config from: $TESTTMP/hgrc
				dispatch: _internal.command=config
	$TESTTMP/hgrc:13: alias.log=log -g			$TESTTMP/hgrc:13: alias.log=log -g
	repo: bundle.mainreporoot=$TESTTMP			repo: bundle.mainreporoot=$TESTTMP
	$TESTTMP/hgrc:11: defaults.identify=-n			$TESTTMP/hgrc:11: defaults.identify=-n
	$TESTTMP/hgrc:2: ui.debug=true			$TESTTMP/hgrc:2: ui.debug=true
	$TESTTMP/hgrc:3: ui.fallbackencoding=ASCII			$TESTTMP/hgrc:3: ui.fallbackencoding=ASCII
	$TESTTMP/hgrc:4: ui.quiet=true			$TESTTMP/hgrc:4: ui.quiet=true
	$TESTTMP/hgrc:5: ui.slash=true			$TESTTMP/hgrc:5: ui.slash=true
	$TESTTMP/hgrc:6: ui.traceback=true			$TESTTMP/hgrc:6: ui.traceback=true
	$TESTTMP/hgrc:7: ui.verbose=true			$TESTTMP/hgrc:7: ui.verbose=true
	$TESTTMP/hgrc:8: ui.style=~/.hgstyle			$TESTTMP/hgrc:8: ui.style=~/.hgstyle
	$TESTTMP/hgrc:9: ui.logtemplate={node}			$TESTTMP/hgrc:9: ui.logtemplate={node}

	plain hgrc			plain hgrc

	$ HGPLAIN=; export HGPLAIN			$ HGPLAIN=; export HGPLAIN
	$ hg showconfig --config ui.traceback=True --debug			$ hg showconfig --config ui.traceback=True --debug
	read config from: $TESTTMP/hgrc			read config from: $TESTTMP/hgrc
				dispatch: _internal.command=config
	repo: bundle.mainreporoot=$TESTTMP			repo: bundle.mainreporoot=$TESTTMP
	--config: ui.traceback=True			--config: ui.traceback=True
	--verbose: ui.verbose=False			--verbose: ui.verbose=False
	--debug: ui.debug=True			--debug: ui.debug=True
	--quiet: ui.quiet=False			--quiet: ui.quiet=False

	with environment variables			with environment variables

	$ PAGER=p1 EDITOR=e1 VISUAL=e2 hg showconfig --debug			$ PAGER=p1 EDITOR=e1 VISUAL=e2 hg showconfig --debug
	set config by: $EDITOR			set config by: $EDITOR
	set config by: $VISUAL			set config by: $VISUAL
	set config by: $PAGER			set config by: $PAGER
	read config from: $TESTTMP/hgrc			read config from: $TESTTMP/hgrc
				dispatch: _internal.command=config
	repo: bundle.mainreporoot=$TESTTMP			repo: bundle.mainreporoot=$TESTTMP
	$PAGER: pager.pager=p1			$PAGER: pager.pager=p1
	$VISUAL: ui.editor=e2			$VISUAL: ui.editor=e2
	--verbose: ui.verbose=False			--verbose: ui.verbose=False
	--debug: ui.debug=True			--debug: ui.debug=True
	--quiet: ui.quiet=False			--quiet: ui.quiet=False

	plain mode with exceptions			plain mode with exceptions

	$ cat > plain.py <<EOF			$ cat > plain.py <<EOF
	> from mercurial import commands, extensions			> from mercurial import commands, extensions
	> def _config(orig, ui, repo, values, *opts):			> def _config(orig, ui, repo, values, *opts):
	> ui.write('plain: %r\n' % ui.plain())			> ui.write('plain: %r\n' % ui.plain())
	> return orig(ui, repo, values, *opts)			> return orig(ui, repo, values, *opts)
	> def uisetup(ui):			> def uisetup(ui):
	> extensions.wrapcommand(commands.table, 'config', _config)			> extensions.wrapcommand(commands.table, 'config', _config)
	> EOF			> EOF
	$ echo "[extensions]" >> $HGRC			$ echo "[extensions]" >> $HGRC
	$ echo "plain=./plain.py" >> $HGRC			$ echo "plain=./plain.py" >> $HGRC
	$ HGPLAINEXCEPT=; export HGPLAINEXCEPT			$ HGPLAINEXCEPT=; export HGPLAINEXCEPT
	$ hg showconfig --config ui.traceback=True --debug			$ hg showconfig --config ui.traceback=True --debug
	plain: True			plain: True
	read config from: $TESTTMP/hgrc			read config from: $TESTTMP/hgrc
				dispatch: _internal.command=config
	repo: bundle.mainreporoot=$TESTTMP			repo: bundle.mainreporoot=$TESTTMP
	$TESTTMP/hgrc:15: extensions.plain=./plain.py			$TESTTMP/hgrc:15: extensions.plain=./plain.py
	--config: ui.traceback=True			--config: ui.traceback=True
	--verbose: ui.verbose=False			--verbose: ui.verbose=False
	--debug: ui.debug=True			--debug: ui.debug=True
	--quiet: ui.quiet=False			--quiet: ui.quiet=False
	$ unset HGPLAIN			$ unset HGPLAIN
	$ hg showconfig --config ui.traceback=True --debug			$ hg showconfig --config ui.traceback=True --debug
	plain: True			plain: True
	read config from: $TESTTMP/hgrc			read config from: $TESTTMP/hgrc
				dispatch: _internal.command=config
	repo: bundle.mainreporoot=$TESTTMP			repo: bundle.mainreporoot=$TESTTMP
	$TESTTMP/hgrc:15: extensions.plain=./plain.py			$TESTTMP/hgrc:15: extensions.plain=./plain.py
	--config: ui.traceback=True			--config: ui.traceback=True
	--verbose: ui.verbose=False			--verbose: ui.verbose=False
	--debug: ui.debug=True			--debug: ui.debug=True
	--quiet: ui.quiet=False			--quiet: ui.quiet=False
	$ HGPLAINEXCEPT=i18n; export HGPLAINEXCEPT			$ HGPLAINEXCEPT=i18n; export HGPLAINEXCEPT
	$ hg showconfig --config ui.traceback=True --debug			$ hg showconfig --config ui.traceback=True --debug
	plain: True			plain: True
	read config from: $TESTTMP/hgrc			read config from: $TESTTMP/hgrc
				dispatch: _internal.command=config
	repo: bundle.mainreporoot=$TESTTMP			repo: bundle.mainreporoot=$TESTTMP
	$TESTTMP/hgrc:15: extensions.plain=./plain.py			$TESTTMP/hgrc:15: extensions.plain=./plain.py
	--config: ui.traceback=True			--config: ui.traceback=True
	--verbose: ui.verbose=False			--verbose: ui.verbose=False
	--debug: ui.debug=True			--debug: ui.debug=True
	--quiet: ui.quiet=False			--quiet: ui.quiet=False

	source of paths is not mangled			source of paths is not mangled

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	1579			Sep 2 2017, 11:38 AM	★	★