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).
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
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.
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/shelve.py (27 lines) |
| Status | Author | Revision | |
|---|---|---|---|
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz | ||
| Closed | martinvonz |
| 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 | ||||