This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4477

merge: move purge logic from extension
ClosedPublic

Authored by indygreg on Sep 4 2018, 6:56 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG7fea205fd5dc: merge: move purge logic from extension
Summary

Working directory purging feels like functionality that should be
in core rather than in an extension.

This commit effectively moves the core purging logic from the
purge extension to merge.py.

Code was refactored slightly. Rather than deal with printing in
this function, the function is a generator of paths and the caller
can worry about printing.

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

indygreg created this revision.Sep 4 2018, 6:56 PM
yuja added a subscriber: yuja.Sep 6 2018, 8:47 AM

+def purge(repo, dirs=None, ignored=False, removeemptydirs=True,
+ removefiles=True, abortonerror=False, include=None, exclude=None,
+ noop=False):

Nit: can't we pass in matcher instead of (dirs, include, exclude)?

+ if removefiles:
+ for f in sorted(status.unknown + status.ignored):
+ if not noop:
+ repo.ui.note(_('removing file %s\n') % f)
+ remove(util.unlink, f)
+ yield f
+
+ if removeemptydirs:
+ for f in sorted(directories, reverse=True):
+ if match(f) and not os.listdir(repo.wvfs.join(f)):
+ if not noop:
+ repo.ui.note(_('removing directory %s\n') % f)
+ remove(os.rmdir, f)
+ yield f

This means mergemod.purge() itself does nothing unless the return value
is fully consumed. That's IMHO a bad API.

+ paths = mergemod.purge(
+ repo, dirs, ignored=opts.get('all', False),
+ removeemptydirs=removedirs, removefiles=removefiles,
+ abortonerror=opts.get('abort_on_err'),
+ include=opts.get('include'), exclude=opts.get('exclude'),
+ noop=opts.get('print') or opts.get('print0'))

Nit: perhaps noop=not act?

indygreg updated this revision to Diff 10825.Sep 6 2018, 9:33 PM
yuja added a comment.Sep 7 2018, 8:05 AM

Queued the series, thanks.

+ matcher = scmutil.match(repo[None], dirs or (), {
+ 'include': opts.get('include'),
+ 'exclude': opts.get('exclude')})

  • match = scmutil.match(repo[None], dirs, opts)

Restored the original match construction, which looks simpler.

Closed by commit rHG7fea205fd5dc: merge: move purge logic from extension (authored by indygreg). · Explain WhySep 7 2018, 8:12 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/purge.py (45 lines)
Mmercurial/merge.py (69 lines)

Diff 10827

hgext/purge.py

# GNU General Public License for more details. # GNU General Public License for more details.
# #
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>. # along with this program; if not, see <http://www.gnu.org/licenses/>.
'''command to delete untracked files from the working directory''' '''command to delete untracked files from the working directory'''
from __future__ import absolute_import from __future__ import absolute_import
import os
from mercurial.i18n import _ from mercurial.i18n import _
from mercurial import ( from mercurial import (
cmdutil, cmdutil,
error, merge as mergemod,
pycompat, pycompat,
registrar, registrar,
scmutil, scmutil,
util,
) )
cmdtable = {} cmdtable = {}
command = registrar.command(cmdtable) command = registrar.command(cmdtable)
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
# be specifying the version(s) of Mercurial they are tested with, or # be specifying the version(s) of Mercurial they are tested with, or
# leave the attribute unspecified. # leave the attribute unspecified.
directories are considered. directories are considered.
Be careful with purge, as you could irreversibly delete some files Be careful with purge, as you could irreversibly delete some files
you forgot to add to the repository. If you only want to print the you forgot to add to the repository. If you only want to print the
list of files that this program would delete, use the --print list of files that this program would delete, use the --print
option. option.
''' '''
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
act = not opts.get('print') act = not opts.get('print')
eol = '\n' eol = '\n'
if opts.get('print0'): if opts.get('print0'):
eol = '\0' eol = '\0'
act = False # --print0 implies --print act = False # --print0 implies --print
removefiles = opts.get('files') removefiles = opts.get('files')
removedirs = opts.get('dirs') removedirs = opts.get('dirs')
if not removefiles and not removedirs: if not removefiles and not removedirs:
removefiles = True removefiles = True
removedirs = True removedirs = True
def remove(remove_func, name):
if act:
try:
remove_func(repo.wjoin(name))
except OSError:
m = _('%s cannot be removed') % name
if opts.get('abort_on_err'):
raise error.Abort(m)
ui.warn(_('warning: %s\n') % m)
else:
ui.write('%s%s' % (name, eol))
match = scmutil.match(repo[None], dirs, opts) match = scmutil.match(repo[None], dirs, opts)
if removedirs:
directories = [] paths = mergemod.purge(
match.explicitdir = match.traversedir = directories.append repo, match, ignored=opts.get('all', False),
status = repo.status(match=match, ignored=opts.get('all'), unknown=True) removeemptydirs=removedirs, removefiles=removefiles,
abortonerror=opts.get('abort_on_err'),
if removefiles: noop=not act)
for f in sorted(status.unknown + status.ignored):
if act: for path in paths:
ui.note(_('removing file %s\n') % f) if not act:
remove(util.unlink, f) ui.write('%s%s' % (path, eol))
if removedirs:
for f in sorted(directories, reverse=True):
if match(f) and not os.listdir(repo.wjoin(f)):
if act:
ui.note(_('removing directory %s\n') % f)
remove(os.rmdir, f)

mercurial/merge.py

# merge.py - directory-level update/merge handling for Mercurial # merge.py - directory-level update/merge handling for Mercurial
# #
# Copyright 2006, 2007 Matt Mackall <mpm@selenic.com> # Copyright 2006, 2007 Matt Mackall <mpm@selenic.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import errno import errno
import hashlib import hashlib
import os
import shutil import shutil
import struct import struct
from .i18n import _ from .i18n import _
from .node import ( from .node import (
addednodeid, addednodeid,
bin, bin,
hex, hex,
pother = parents[0].node() pother = parents[0].node()
with repo.dirstate.parentchange(): with repo.dirstate.parentchange():
repo.setparents(repo['.'].node(), pother) repo.setparents(repo['.'].node(), pother)
repo.dirstate.write(repo.currenttransaction()) repo.dirstate.write(repo.currenttransaction())
# fix up dirstate for copies and renames # fix up dirstate for copies and renames
copies.duplicatecopies(repo, repo[None], ctx.rev(), pctx.rev()) copies.duplicatecopies(repo, repo[None], ctx.rev(), pctx.rev())
return stats return stats
def purge(repo, matcher, ignored=False, removeemptydirs=True,
removefiles=True, abortonerror=False, noop=False):
"""Purge the working directory of untracked files.
``matcher`` is a matcher configured to scan the working directory -
potentially a subset.
``ignored`` controls whether ignored files should also be purged.
``removeemptydirs`` controls whether empty directories should be removed.
``removefiles`` controls whether files are removed.
``abortonerror`` causes an exception to be raised if an error occurs
deleting a file or directory.
``noop`` controls whether to actually remove files. If not defined, actions
will be taken.
Returns an iterable of relative paths in the working directory that were
or would be removed.
"""
def remove(removefn, path):
try:
removefn(repo.wvfs.join(path))
except OSError:
m = _('%s cannot be removed') % path
if abortonerror:
raise error.Abort(m)
else:
repo.ui.warn(_('warning: %s\n') % m)
# There's no API to copy a matcher. So mutate the passed matcher and
# restore it when we're done.
oldexplicitdir = matcher.explicitdir
oldtraversedir = matcher.traversedir
res = []
try:
if removeemptydirs:
directories = []
matcher.explicitdir = matcher.traversedir = directories.append
status = repo.status(match=matcher, ignored=ignored, unknown=True)
if removefiles:
for f in sorted(status.unknown + status.ignored):
if not noop:
repo.ui.note(_('removing file %s\n') % f)
remove(util.unlink, f)
res.append(f)
if removeemptydirs:
for f in sorted(directories, reverse=True):
if matcher(f) and not os.listdir(repo.wvfs.join(f)):
if not noop:
repo.ui.note(_('removing directory %s\n') % f)
remove(os.rmdir, f)
res.append(f)
return res
finally:
matcher.explicitdir = oldexplicitdir
matcher.traversedir = oldtraversedir