This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9700

shelve: introduce class representing a shelf
ClosedPublic

Authored by martinvonz on Jan 8 2021, 3:36 PM.

Download Raw Diff

Details

Reviewers

pulkit

Group Reviewers

hg-reviewers

Commits

rHGefc71bb71682: shelve: introduce class representing a shelf
rHGae24c543ba8d: shelve: introduce class representing a shelf
rHG48176c7bcc5e: shelve: introduce class representing a shelf

Summary

I'm about to make phase-based shelve not write .hg and .patch
files. Having a class that represents a single shelf, regardless of
which files it uses will help. I'm starting small with just a
.exists() function. I plan to eventually remove the shelvedfile
class once all functionality has been moved to the new class.

By the way, I know that things you shelve are not typically themselves
shelves. I still picked Shelf for the class because it's short
(compared to e.g. ShelvedChange).

Diff Detail

Repository

rHG Mercurial

Branch

default

Lint

No Linters Available

Unit

No Unit Test Coverage

Event Timeline

martinvonz created this revision.Jan 8 2021, 3:36 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptJan 8 2021, 3:36 PM

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

martinvonz added a child revision: D9701: shelve: move method for writing .shelve to new shelf class.Jan 8 2021, 3:36 PM

martinvonz edited the summary of this revision. (Show Details)Jan 11 2021, 1:04 PM

As I'm working on further changes on top of this series, I'm starting to wonder if I should pass in a vfs into the Shelf class instead. I'll mark this as "changes planned" while I figure that out.

In D9700#146752, @martinvonz wrote:

As I'm working on further changes on top of this series, I'm starting to wonder if I should pass in a vfs into the Shelf class instead. I'll mark this as "changes planned" while I figure that out.

I made that change later in the stack instead, in D9738.

pulkit accepted this revision.Jan 16 2021, 4:19 AM

This revision is now accepted and ready to land.Jan 16 2021, 4:19 AM

martinvonz added a commit: rHG48176c7bcc5e: shelve: introduce class representing a shelf.Jan 16 2021, 5:56 AM

Closed by commit rHG48176c7bcc5e: shelve: introduce class representing a shelf (authored by martinvonz). · Explain Why

This revision was automatically updated to reflect the committed changes.

martinvonz added a commit: rHGae24c543ba8d: shelve: introduce class representing a shelf.Jan 16 2021, 1:31 PM

martinvonz added a commit: rHGefc71bb71682: shelve: introduce class representing a shelf.Jan 17 2021, 2:21 AM

Revision Contents
Changeset List

			Path	Packages
M			mercurial/shelve.py (27 lines)

Commit	Parents	Author	Summary	Date
12b14e1c8751	a11254de9ab9	Martin von Zweigbergk		Jan 7 2021, 2:07 PM

Status	Author	Revision
Closed	martinvonz	D9744 shelve: move listshelves() to new ShelfDir class, so caller need not pass vfs
Closed	martinvonz	D9743 shelve: also create class representing whole directory of shelves
Closed	martinvonz	D9742 shelve: add a method for deleting shelf to new shelf class
Closed	martinvonz	D9741 shelve: inline ".patch" constant now that it's only used in the Shelf class
Closed	martinvonz	D9740 shelve: use listshelves() in cleanupoldbackups()
Closed	martinvonz	D9739 shelve: make listshelves() list shelves in a given vfs
Closed	martinvonz	D9738 shelve: replace repo instance in Shelf class by vfs instance
Closed	martinvonz	D9737 shelve: use listdir() instead of readdir() when we don't need stat information
Closed	martinvonz	D9720 shelve: don't crash on file with unexpected extension in .hg/shelved/
Closed	martinvonz	D9719 shelve: don't include invalid shelves in `hg shelve --list`
Closed	martinvonz	D9714 shelve: extract some repeated creation of shelf instances to variables
Closed	martinvonz	D9713 shelve: teach new shelf class to check if .shelve file exists
Closed	martinvonz	D9712 shelve: move method for creating backup to new shelf class
Closed	martinvonz	D9711 shelve: make gennames() helper generate relative backup paths
Closed	martinvonz	D9710 shelve: use listshelves() in cleanup function
Closed	martinvonz	D9709 shelve: inline shelvedfile.filename() since there are no callers outside class
Closed	martinvonz	D9708 shelve: make listshelves() return shelf names instead of filenames
Closed	martinvonz	D9707 shelve: move method for getting stat (mtime) to new shelf class
Closed	martinvonz	D9706 shelve: open patch using new shelf class instead of open()
Closed	martinvonz	D9705 shelve: move function for opening .patch file to new shelf class
Closed	martinvonz	D9704 shelve: move method for reading .hg to new shelf class
Closed	martinvonz	D9703 shelve: move method for writing bundle to new shelf class
Closed	martinvonz	D9702 shelve: move method for reading .shelve file to new shelf class
Closed	martinvonz	D9701 shelve: move method for writing .shelve to new shelf class
Closed	martinvonz	D9700 shelve: introduce class representing a shelf
Closed	martinvonz	D9699 shelve: raise more specific errors
Closed	martinvonz	D9698 shelve: trust caller of shelvedfile.opener() to check that the file exists
Closed	martinvonz	D9697 shelve: rewrite check for unknown shelf to delete
Closed	martinvonz	D9696 shelve: remove a bundlerepo method
Closed	martinvonz	D9718 tests: add tests for corrupt .hg/shelved/ directory

Diff 24656

mercurial/shelve.py


	def writeinfo(self, info):			def writeinfo(self, info):
	scmutil.simplekeyvaluefile(self.vfs, self.fname).write(info)			scmutil.simplekeyvaluefile(self.vfs, self.fname).write(info)

	def readinfo(self):			def readinfo(self):
	return scmutil.simplekeyvaluefile(self.vfs, self.fname).read()			return scmutil.simplekeyvaluefile(self.vfs, self.fname).read()


				class Shelf(object):
				"""Represents a shelf, including possibly multiple files storing it.

				Old shelves will have a .patch and a .hg file. Newer shelves will
				also have a .shelve file. This class abstracts away some of the
				differences and lets you work with the shelf as a whole.
				"""

				def __init__(self, repo, name):
				self.repo = repo
				self.name = name
				self.vfs = vfsmod.vfs(repo.vfs.join(shelvedir))

				def exists(self):
				return self.vfs.exists(self.name + b'.' + patchextension)


	class shelvedstate(object):			class shelvedstate(object):
	"""Handle persistence during unshelving operations.			"""Handle persistence during unshelving operations.

	Handles saving and restoring a shelved state. Ensures that different			Handles saving and restoring a shelved state. Ensures that different
	versions of a shelved state are possible and handles them appropriately.			versions of a shelved state are possible and handles them appropriately.
	"""			"""

	_version = 2			_version = 2
	# slashes aren't allowed in filenames, therefore we rename it			# slashes aren't allowed in filenames, therefore we rename it
	label = label.replace(b'/', b'_')			label = label.replace(b'/', b'_')
	label = label.replace(b'\\', b'_')			label = label.replace(b'\\', b'_')
	# filenames must not start with '.' as it should not be hidden			# filenames must not start with '.' as it should not be hidden
	if label.startswith(b'.'):			if label.startswith(b'.'):
	label = label.replace(b'.', b'_', 1)			label = label.replace(b'.', b'_', 1)

	if name:			if name:
	if shelvedfile(repo, name, patchextension).exists():			if Shelf(repo, name).exists():
	e = _(b"a shelved change named '%s' already exists") % name			e = _(b"a shelved change named '%s' already exists") % name
	raise error.Abort(e)			raise error.Abort(e)

	# ensure we are not creating a subdirectory or a hidden file			# ensure we are not creating a subdirectory or a hidden file
	if b'/' in name or b'\\' in name:			if b'/' in name or b'\\' in name:
	raise error.Abort(			raise error.Abort(
	_(b'shelved change names can not contain slashes')			_(b'shelved change names can not contain slashes')
	)			)
	if name.startswith(b'.'):			if name.startswith(b'.'):
	raise error.Abort(_(b"shelved change names can not start with '.'"))			raise error.Abort(_(b"shelved change names can not start with '.'"))

	else:			else:
	for n in gennames():			for n in gennames():
	if not shelvedfile(repo, n, patchextension).exists():			if not Shelf(repo, n).exists():
	name = n			name = n
	break			break

	return name			return name


	def mutableancestors(ctx):			def mutableancestors(ctx):
	"""return all mutable ancestors for ctx (included)			"""return all mutable ancestors for ctx (included)


	def deletecmd(ui, repo, pats):			def deletecmd(ui, repo, pats):
	"""subcommand that deletes a specific shelve"""			"""subcommand that deletes a specific shelve"""
	if not pats:			if not pats:
	raise error.InputError(_(b'no shelved changes specified!'))			raise error.InputError(_(b'no shelved changes specified!'))
	with repo.wlock():			with repo.wlock():
	for name in pats:			for name in pats:
	if not shelvedfile(repo, name, patchextension).exists():			if not Shelf(repo, name).exists():
	raise error.InputError(			raise error.InputError(
	_(b"shelved change '%s' not found") % name			_(b"shelved change '%s' not found") % name
	)			)
	for suffix in shelvefileextensions:			for suffix in shelvefileextensions:
	shfile = shelvedfile(repo, name, suffix)			shfile = shelvedfile(repo, name, suffix)
	if shfile.exists():			if shfile.exists():
	shfile.movetobackup()			shfile.movetobackup()
	cleanupoldbackups(repo)			cleanupoldbackups(repo)
	shelves = listshelves(repo)			shelves = listshelves(repo)
	if not shelves:			if not shelves:
	raise error.Abort(_(b"there are no shelves to show"))			raise error.Abort(_(b"there are no shelves to show"))
	mtime, name = shelves[0]			mtime, name = shelves[0]
	sname = util.split(name)[1]			sname = util.split(name)[1]
	pats = [sname]			pats = [sname]

	for shelfname in pats:			for shelfname in pats:
	if not shelvedfile(repo, shelfname, patchextension).exists():			if not Shelf(repo, shelfname).exists():
	raise error.Abort(_(b"cannot find shelf %s") % shelfname)			raise error.Abort(_(b"cannot find shelf %s") % shelfname)

	listcmd(ui, repo, pats, opts)			listcmd(ui, repo, pats, opts)


	def checkparents(repo, state):			def checkparents(repo, state):
	"""check parent while resuming an unshelve"""			"""check parent while resuming an unshelve"""
	if state.parents != repo.dirstate.parents():			if state.parents != repo.dirstate.parents():
	shelved = listshelves(repo)			shelved = listshelves(repo)
	if not shelved:			if not shelved:
	raise error.StateError(_(b'no shelved changes to apply!'))			raise error.StateError(_(b'no shelved changes to apply!'))
	basename = util.split(shelved[0][1])[1]			basename = util.split(shelved[0][1])[1]
	ui.status(_(b"unshelving change '%s'\n") % basename)			ui.status(_(b"unshelving change '%s'\n") % basename)
	else:			else:
	basename = shelved[0]			basename = shelved[0]

	if not shelvedfile(repo, basename, patchextension).exists():			if not Shelf(repo, basename).exists():
	raise error.InputError(_(b"shelved change '%s' not found") % basename)			raise error.InputError(_(b"shelved change '%s' not found") % basename)

	return _dounshelve(ui, repo, basename, opts)			return _dounshelve(ui, repo, basename, opts)


	def _dounshelve(ui, repo, basename, opts):			def _dounshelve(ui, repo, basename, opts):
	repo = repo.unfiltered()			repo = repo.unfiltered()
	lock = tr = None			lock = tr = None

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	24656		Jan 8 2021, 3:36 PM	★	★
Diff 2	24935	rHG48176c7bcc5ef187be0ac632c8ae21710f3cc218	Jan 7 2021, 2:07 PM	★	★