This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10162

ui: pass a `ui` object to `paths.getpath`
ClosedPublic

Authored by marmoute on Mar 11 2021, 12:08 PM.

Download Raw Diff

Details

Reviewers

None

Group Reviewers

hg-reviewers

Commits

rHG66fb04552122: ui: pass a `ui` object to `paths.getpath`

Summary

I want to introduce more path's suboption and make it possible to use default
value for them. Processing theses sub-options might result in warnings. We
need a ui object to issue such warnings.

To make things simpler, we add an helper method on the ui object.

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

marmoute created this revision.Mar 11 2021, 12:08 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptMar 11 2021, 12:08 PM

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

marmoute added a child revision: D10163: paths: add a `*` special path to define default sub option.Mar 11 2021, 12:08 PM

I think the commit description has passed the not-ok threshold of typos ;)

I am pushing an udpate

✅ refresh by Heptapod after a successful CI run (🐙 💚)

marmoute added a commit: rHG66fb04552122: ui: pass a `ui` object to `paths.getpath`.Mar 16 2021, 5:43 PM

This revision was not accepted when it landed; it landed in state Needs Review.

Closed by commit rHG66fb04552122: ui: pass a `ui` object to `paths.getpath` (authored by marmoute). · Explain Why

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			contrib/perf.py (2 lines)
M			hgext/infinitepush/__init__.py (2 lines)
M			mercurial/commands.py (4 lines)
M			mercurial/hg.py (2 lines)
M			mercurial/revset.py (4 lines)
M			mercurial/ui.py (17 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	26250		Mar 11 2021, 12:08 PM	★	★
Diff 2	26399		Mar 16 2021, 8:43 AM	★	★
Diff 3	26401	rHG66fb045521223684373a4b47d88b9a1f6ee5b704	Mar 11 2021, 11:26 AM	★	★

	Status	Author	Revision
	Closed	marmoute	D10163 paths: add a `*` special path to define default sub option
	Closed	marmoute	D10162 ui: pass a `ui` object to `paths.getpath`

Diff 26401

contrib/perf.py

	exchange,			exchange,
	hg,			hg,
	phases,			phases,
	)			)

	opts = _byteskwargs(opts)			opts = _byteskwargs(opts)
	timer, fm = gettimer(ui, opts)			timer, fm = gettimer(ui, opts)

	path = ui.paths.getpath(dest, default=(b'default-push', b'default'))			path = ui.getpath(dest, default=(b'default-push', b'default'))
	if not path:			if not path:
	raise error.Abort(			raise error.Abort(
	b'default repository not configured!',			b'default repository not configured!',
	hint=b"see 'hg help config.paths'",			hint=b"see 'hg help config.paths'",
	)			)
	dest = path.pushloc or path.loc			dest = path.pushloc or path.loc
	ui.statusnoi18n(b'analysing phase of %s\n' % util.hidepassword(dest))			ui.statusnoi18n(b'analysing phase of %s\n' % util.hidepassword(dest))
	other = hg.peer(repo, opts, dest)			other = hg.peer(repo, opts, dest)

hgext/infinitepush/init.py

	# this is an infinitepush, we don't want the bookmark to be applied			# this is an infinitepush, we don't want the bookmark to be applied
	# rather that should be stored in the bundlestore			# rather that should be stored in the bundlestore
	opts[b'bookmark'] = []			opts[b'bookmark'] = []
	ui.setconfig(experimental, configscratchpush, True)			ui.setconfig(experimental, configscratchpush, True)
	oldphasemove = extensions.wrapfunction(			oldphasemove = extensions.wrapfunction(
	exchange, b'_localphasemove', _phasemove			exchange, b'_localphasemove', _phasemove
	)			)
	# Copy-paste from `push` command			# Copy-paste from `push` command
	path = ui.paths.getpath(dest, default=(b'default-push', b'default'))			path = ui.getpath(dest, default=(b'default-push', b'default'))
	if not path:			if not path:
	raise error.Abort(			raise error.Abort(
	_(b'default repository not configured!'),			_(b'default repository not configured!'),
	hint=_(b"see 'hg help config.paths'"),			hint=_(b"see 'hg help config.paths'"),
	)			)
	destpath = path.pushloc or path.loc			destpath = path.pushloc or path.loc
	# Remote scratch bookmarks will be deleted because remotenames doesn't			# Remote scratch bookmarks will be deleted because remotenames doesn't
	# know about them. Let's save it before push and restore after			# know about them. Let's save it before push and restore after

mercurial/commands.py

	From the point of view of pushing behavior, bookmarks			From the point of view of pushing behavior, bookmarks
	existing only in the remote repository are treated as			existing only in the remote repository are treated as
	``deleted``, even if it is in fact added remotely.			``deleted``, even if it is in fact added remotely.

	Returns 0 if there are outgoing changes, 1 otherwise.			Returns 0 if there are outgoing changes, 1 otherwise.
	"""			"""
	# hg._outgoing() needs to re-resolve the path in order to handle #branch			# hg._outgoing() needs to re-resolve the path in order to handle #branch
	# style URLs, so don't overwrite dest.			# style URLs, so don't overwrite dest.
	path = ui.paths.getpath(dest, default=(b'default-push', b'default'))			path = ui.getpath(dest, default=(b'default-push', b'default'))
	if not path:			if not path:
	raise error.ConfigError(			raise error.ConfigError(
	_(b'default repository not configured!'),			_(b'default repository not configured!'),
	hint=_(b"see 'hg help config.paths'"),			hint=_(b"see 'hg help config.paths'"),
	)			)

	opts = pycompat.byteskwargs(opts)			opts = pycompat.byteskwargs(opts)
	if opts.get(b'graph'):			if opts.get(b'graph'):
	b = repo._bookmarks.expandname(b)			b = repo._bookmarks.expandname(b)
	if b in repo._bookmarks:			if b in repo._bookmarks:
	opts.setdefault(b'rev', []).append(b)			opts.setdefault(b'rev', []).append(b)
	else:			else:
	# if we try to push a deleted bookmark, translate it to null			# if we try to push a deleted bookmark, translate it to null
	# this lets simultaneous -r, -b options continue working			# this lets simultaneous -r, -b options continue working
	opts.setdefault(b'rev', []).append(b"null")			opts.setdefault(b'rev', []).append(b"null")

	path = ui.paths.getpath(dest, default=(b'default-push', b'default'))			path = ui.getpath(dest, default=(b'default-push', b'default'))
	if not path:			if not path:
	raise error.ConfigError(			raise error.ConfigError(
	_(b'default repository not configured!'),			_(b'default repository not configured!'),
	hint=_(b"see 'hg help config.paths'"),			hint=_(b"see 'hg help config.paths'"),
	)			)
	dest = path.pushloc or path.loc			dest = path.pushloc or path.loc
	branches = (path.branch, opts.get(b'branch') or [])			branches = (path.branch, opts.get(b'branch') or [])
	ui.status(_(b'pushing to %s\n') % util.hidepassword(dest))			ui.status(_(b'pushing to %s\n') % util.hidepassword(dest))

mercurial/hg.py

	continue			continue
	count += 1			count += 1
	displayer.show(other[n])			displayer.show(other[n])

	return _incoming(display, subreporecurse, ui, repo, source, opts)			return _incoming(display, subreporecurse, ui, repo, source, opts)


	def _outgoing(ui, repo, dest, opts):			def _outgoing(ui, repo, dest, opts):
	path = ui.paths.getpath(dest, default=(b'default-push', b'default'))			path = ui.getpath(dest, default=(b'default-push', b'default'))
	if not path:			if not path:
	raise error.Abort(			raise error.Abort(
	_(b'default repository not configured!'),			_(b'default repository not configured!'),
	hint=_(b"see 'hg help config.paths'"),			hint=_(b"see 'hg help config.paths'"),
	)			)
	dest = path.pushloc or path.loc			dest = path.pushloc or path.loc
	branches = path.branch, opts.get(b'branch') or []			branches = path.branch, opts.get(b'branch') or []

mercurial/revset.py


	# i18n: "outgoing" is a keyword			# i18n: "outgoing" is a keyword
	l = getargs(x, 0, 1, _(b"outgoing takes one or no arguments"))			l = getargs(x, 0, 1, _(b"outgoing takes one or no arguments"))
	# i18n: "outgoing" is a keyword			# i18n: "outgoing" is a keyword
	dest = (			dest = (
	l and getstring(l[0], _(b"outgoing requires a repository path")) or b''			l and getstring(l[0], _(b"outgoing requires a repository path")) or b''
	)			)
	if not dest:			if not dest:
	# ui.paths.getpath() explicitly tests for None, not just a boolean			# ui.getpath() explicitly tests for None, not just a boolean
	dest = None			dest = None
	path = repo.ui.paths.getpath(dest, default=(b'default-push', b'default'))			path = repo.ui.getpath(dest, default=(b'default-push', b'default'))
	if not path:			if not path:
	raise error.Abort(			raise error.Abort(
	_(b'default repository not configured!'),			_(b'default repository not configured!'),
	hint=_(b"see 'hg help config.paths'"),			hint=_(b"see 'hg help config.paths'"),
	)			)
	dest = path.pushloc or path.loc			dest = path.pushloc or path.loc
	branches = path.branch, []			branches = path.branch, []

mercurial/ui.py

	"""Return a short representation of a user name or email address."""			"""Return a short representation of a user name or email address."""
	if not self.verbose:			if not self.verbose:
	user = stringutil.shortuser(user)			user = stringutil.shortuser(user)
	return user			return user

	def expandpath(self, loc, default=None):			def expandpath(self, loc, default=None):
	"""Return repository location relative to cwd or from [paths]"""			"""Return repository location relative to cwd or from [paths]"""
	try:			try:
	p = self.paths.getpath(loc)			p = self.getpath(loc)
	if p:			if p:
	return p.rawloc			return p.rawloc
	except error.RepoError:			except error.RepoError:
	pass			pass

	if default:			if default:
	try:			try:
	p = self.paths.getpath(default)			p = self.getpath(default)
	if p:			if p:
	return p.rawloc			return p.rawloc
	except error.RepoError:			except error.RepoError:
	pass			pass

	return loc			return loc

	@util.propertycache			@util.propertycache
	def paths(self):			def paths(self):
	return paths(self)			return paths(self)

				def getpath(self, args, *kwargs):
				"""see paths.getpath for details

				This method exist as `getpath` need a ui for potential warning message.
				"""
				return self.paths.getpath(self, args, *kwargs)

	@property			@property
	def fout(self):			def fout(self):
	return self._fout			return self._fout

	@fout.setter			@fout.setter
	def fout(self, f):			def fout(self, f):
	self._fout = f			self._fout = f
	self._fmsgout, self._fmsgerr = _selectmsgdests(self)			self._fmsgout, self._fmsgerr = _selectmsgdests(self)

	for name, loc in ui.configitems(b'paths', ignoresub=True):			for name, loc in ui.configitems(b'paths', ignoresub=True):
	# No location is the same as not existing.			# No location is the same as not existing.
	if not loc:			if not loc:
	continue			continue
	loc, sub = ui.configsuboptions(b'paths', name)			loc, sub = ui.configsuboptions(b'paths', name)
	self[name] = path(ui, name, rawloc=loc, suboptions=sub)			self[name] = path(ui, name, rawloc=loc, suboptions=sub)

	def getpath(self, name, default=None):			def getpath(self, ui, name, default=None):
	"""Return a ``path`` from a string, falling back to default.			"""Return a ``path`` from a string, falling back to default.

	``name`` can be a named path or locations. Locations are filesystem			``name`` can be a named path or locations. Locations are filesystem
	paths or URIs.			paths or URIs.

	Returns None if ``name`` is not a registered path, a URI, or a local			Returns None if ``name`` is not a registered path, a URI, or a local
	path to a repo.			path to a repo.
	"""			"""
	if not name:			if not name:
	return None			return None

	try:			try:
	return self[name]			return self[name]
	except KeyError:			except KeyError:
	# Try to resolve as a local path or URI.			# Try to resolve as a local path or URI.
	try:			try:
	# We don't pass sub-options in, so no need to pass ui instance.			# we pass the ui instance are warning might need to be issued
	return path(None, None, rawloc=name)			return path(ui, None, rawloc=name)
	except ValueError:			except ValueError:
	raise error.RepoError(_(b'repository %s does not exist') % name)			raise error.RepoError(_(b'repository %s does not exist') % name)


	_pathsuboptions = {}			_pathsuboptions = {}


	def pathsuboption(option, attr):			def pathsuboption(option, attr):