This is an archive of the discontinued Mercurial Phabricator instance.

remotenames: add a function to return the vfs object
AbandonedPublic

Authored by pulkit on Oct 4 2017, 5:53 PM.

Download Raw Diff

Details

Reviewers

dlax
ryanmce

Group Reviewers

hg-reviewers

Summary

The statement was added at a lot of places and was going to be added at more
places. So before that, let's turn that into a function.

Also this is turned into a function so that we can plug in the support for
shared repositories in future which is supported by hgremotenames extension.

Diff Detail

Repository

rHG Mercurial

Lint

Lint Skipped

Unit

Unit Tests Skipped

Event Timeline

pulkit created this revision.Oct 4 2017, 5:53 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptOct 4 2017, 5:53 PM

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

dlax accepted this revision.Oct 5 2017, 4:08 AM

pulkit planned changes to this revision.Oct 6 2017, 5:15 PM

ryanmce requested changes to this revision.Oct 12 2017, 7:43 AM

ryanmce added a subscriber: ryanmce.

ryanmce added inline comments.

mercurial/remotenames.py
31	This is not a great name. It implies it's a vfs on a remote peer, which is definitely not what we want to imply. We might just call it `getvfs` in this case -- it's already in the remotenames module so it's obvious what it is if it's used outside of the module. After reading the description, I see that this is for shared usage in the future. You should add a comment here in the code explaining that. Also, a better way to deal with that is to build a shared vfs in core -- but that's outside of the scope of this change.
32–33	nit: For single-line docblocks, please close the docblock on the same line: """returns a vfs object for .hg/remotenames/"""

Will revisit after the freeze.

Revision Contents
Changeset List

			Path	Packages
M			mercurial/remotenames.py (13 lines)

Status	Author	Revision
Abandoned	pulkit	D1358 remotenames: store journal entry for bookmarks if journal is loaded
Abandoned	pulkit	D1357 remotenames: consider existing data while storing newer data
Abandoned	pulkit	D1356 remotenames: add test showing overwriting on remotenames data
Abandoned	pulkit	D941 remotenames: add a function to return the vfs object
Abandoned	pulkit	D940 remotenames: add functions to read remotenames data from .hg/remotenames/
Abandoned	pulkit	D939 remotenames: add functionality to store remotenames under .hg/hgremotenames/
Abandoned	pulkit	D938 remotenames: move utility functions to join and split names to core
Abandoned	pulkit	D937 remotenames: move function to pull remotenames from the remoterepo to core

Diff 2438

mercurial/remotenames.py

	remote, name = remote.split('/', 1)			remote, name = remote.split('/', 1)
	return remote, name			return remote, name

	def joinremotename(remote, ref):			def joinremotename(remote, ref):
	if ref:			if ref:
	remote += '/' + ref			remote += '/' + ref
	return remote			return remote

				def getremotevfs(repo):
				ryanmceUnsubmitted Not Done This is not a great name. It implies it's a vfs on a remote peer, which is definitely not what we want to imply. We might just call it `getvfs` in this case -- it's already in the remotenames module so it's obvious what it is if it's used outside of the module. After reading the description, I see that this is for shared usage in the future. You should add a comment here in the code explaining that. Also, a better way to deal with that is to build a shared vfs in core -- but that's outside of the scope of this change. ryanmce: This is not a great name. It implies it's a vfs on a remote peer, which is definitely not what…
				""" returns a vfs object for .hg/remotenames/
				"""
				ryanmceUnsubmitted Not Done nit: For single-line docblocks, please close the docblock on the same line: """returns a vfs object for .hg/remotenames/""" ryanmce: nit: For single-line docblocks, please close the docblock on the same line: ``` """returns…
				return vfsmod.vfs(repo.vfs.join(remotenamedir))

	def readremotenamefile(repo, vfs, filename):			def readremotenamefile(repo, vfs, filename):
	""" reads a file from .hg/remotenames/ directory and yields it's content			""" reads a file from .hg/remotenames/ directory and yields it's content

	filename: the file to be read			filename: the file to be read

	yield a tuple (node, remotepath, name)			yield a tuple (node, remotepath, name)
	"""			"""


	def readremotenames(repo):			def readremotenames(repo):
	""" read the details about the remotenames stored in .hg/remotenames/ and			""" read the details about the remotenames stored in .hg/remotenames/ and
	yields a tuple (node, remotepath, name). It does not yields information			yields a tuple (node, remotepath, name). It does not yields information
	about whether an entry yielded is branch or bookmark. To get that			about whether an entry yielded is branch or bookmark. To get that
	information, call the respective functions.			information, call the respective functions.
	"""			"""

	vfs = vfsmod.vfs(repo.vfs.join(remotenamedir))			vfs = getremotevfs(repo)

	for bmentry in readremotenamefile(repo, vfs, 'bookmarks'):			for bmentry in readremotenamefile(repo, vfs, 'bookmarks'):
	yield bmentry			yield bmentry

	def readremotebookmarks(repo, remotepath=None):			def readremotebookmarks(repo, remotepath=None):
	""" read the remotebookmarks stored in .hg/remotenames/bookmarks and yield a			""" read the remotebookmarks stored in .hg/remotenames/bookmarks and yield a
	tuple of (node, remotepath, name)			tuple of (node, remotepath, name)

	If remotepath is passed, the entries with the same remotepath are yielded			If remotepath is passed, the entries with the same remotepath are yielded
	only.			only.
	"""			"""
	vfs = vfsmod.vfs(repo.vfs.join(remotenamedir))			vfs = getremotevfs(repo)
	for bmentry in readremotenamefile(repo, vfs, 'bookmarks'):			for bmentry in readremotenamefile(repo, vfs, 'bookmarks'):
	if bmentry[1] != remotepath:			if bmentry[1] != remotepath:
	yield bmentry			yield bmentry

	def readremotebranches(repo, remotepath=None):			def readremotebranches(repo, remotepath=None):
	""" read the remotebranches stored in .hg/remotenames/branches and yield a			""" read the remotebranches stored in .hg/remotenames/branches and yield a
	tuple of (node, remotepath, name)			tuple of (node, remotepath, name)

	If remotepath is passed, the entries with the same remotepath are yielded			If remotepath is passed, the entries with the same remotepath are yielded
	only.			only.
	"""			"""
	vfs = vfsmod.vfs(repo.vfs.join(remotenamedir))			vfs = getremotevfs(repo)
	for bmentry in readremotenamefile(repo, vfs, 'branches'):			for bmentry in readremotenamefile(repo, vfs, 'branches'):
	if bmentry[1] != remotepath:			if bmentry[1] != remotepath:
	yield bmentry			yield bmentry

	def saveremotebookmarks(repo, vfs, remotepath, bookmarks):			def saveremotebookmarks(repo, vfs, remotepath, bookmarks):
	""" save remote bookmarks in .hg/remotenames/bookmarks.			""" save remote bookmarks in .hg/remotenames/bookmarks.
	The format of the data stored will be:			The format of the data stored will be:


	f.close()			f.close()

	def saveremotenames(repo, remotepath, branches=None, bookmarks=None):			def saveremotenames(repo, remotepath, branches=None, bookmarks=None):
	""" save remotenames i.e. remotebookmarks and remotebranches in their			""" save remotenames i.e. remotebookmarks and remotebranches in their
	respective files under ".hg/remotenames/" directory.			respective files under ".hg/remotenames/" directory.
	"""			"""

	vfs = vfsmod.vfs(repo.vfs.join(remotenamedir))			vfs = getremotevfs(repo)
	wlock = repo.wlock()			wlock = repo.wlock()
	try:			try:
	if bookmarks:			if bookmarks:
	saveremotebookmarks(repo, vfs, remotepath, bookmarks)			saveremotebookmarks(repo, vfs, remotepath, bookmarks)
	if branches:			if branches:
	saveremotebranches(repo, vfs, remotepath, branches)			saveremotebranches(repo, vfs, remotepath, branches)
	finally:			finally:
	wlock.release()			wlock.release()

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	2438			Oct 4 2017, 5:53 PM	★	★