This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8096

purge: add -i flag to delete ignored files instead of untracked files
ClosedPublic

Authored by valentin.gatienbaron on Feb 8 2020, 11:00 AM.

Details

Reviewers
marmoute
pulkit
Group Reviewers
hg-reviewers
Commits
rHG9f8eddd2723f: purge: add -i flag to delete ignored files instead of untracked files
Summary

It's convenient for deleting build artifacts. Using --all instead
would delete other things too.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute accepted this revision.Feb 8 2020, 12:42 PM
marmoute added a subscriber: marmoute.

The feature is great (I actually needs it from time to time) and the code looks good.

pulkit added a subscriber: pulkit.Feb 10 2020, 11:29 AM

Nice! Looks good to me. Can you add a releasenotes entry in relnotes/next?

hgext/purge.py
51

nit: Here instead of None, False can be used to prevent passing default value later in line 110.

112

nit: it's better to have the check earlier, i.e. after line 99 on this side.

valentin.gatienbaron added a comment.Feb 10 2020, 11:59 AM

I thought it was generally preferred to have the False in the code, for extensions that want to call the function?

pulkit accepted this revision.Feb 10 2020, 12:27 PM
In D8096#120082, @valentin.gatienbaron wrote:

I thought it was generally preferred to have the False in the code, for extensions that want to call the function?

Ah, I see. Not sure we have an existing preference here.

This revision is now accepted and ready to land.Feb 10 2020, 12:27 PM

Revision Contents
Changeset List

PathPackages
Mhgext/purge.py (13 lines)
Mmercurial/merge.py (7 lines)
Mtests/test-purge.t (15 lines)

Diff 20031

hgext/purge.py

testedwith = b'ships-with-hg-core' testedwith = b'ships-with-hg-core'
@command( @command(
b'purge|clean', b'purge|clean',
[ [
(b'a', b'abort-on-err', None, _(b'abort if an error occurs')), (b'a', b'abort-on-err', None, _(b'abort if an error occurs')),
(b'', b'all', None, _(b'purge ignored files too')), (b'', b'all', None, _(b'purge ignored files too')),
(b'i', b'ignored', None, _(b'purge only ignored files')),
pulkitUnsubmitted
Not Done

nit: Here instead of None, False can be used to prevent passing default value later in line 110.

pulkit: nit: Here instead of `None`, `False` can be used to prevent passing default value later in line…
(b'', b'dirs', None, _(b'purge empty directories')), (b'', b'dirs', None, _(b'purge empty directories')),
(b'', b'files', None, _(b'purge files')), (b'', b'files', None, _(b'purge files')),
(b'p', b'print', None, _(b'print filenames instead of deleting them')), (b'p', b'print', None, _(b'print filenames instead of deleting them')),
( (
b'0', b'0',
b'print0', b'print0',
None, None,
_( _(
- Unknown files: files marked with "?" by :hg:`status` - Unknown files: files marked with "?" by :hg:`status`
- Empty directories: in fact Mercurial ignores directories unless - Empty directories: in fact Mercurial ignores directories unless
they contain files under source control management they contain files under source control management
But it will leave untouched: But it will leave untouched:
- Modified and unmodified tracked files - Modified and unmodified tracked files
- Ignored files (unless --all is specified) - Ignored files (unless -i or --all is specified)
- New files added to the repository (with :hg:`add`) - New files added to the repository (with :hg:`add`)
The --files and --dirs options can be used to direct purge to delete The --files and --dirs options can be used to direct purge to delete
only files, only directories, or both. If neither option is given, only files, only directories, or both. If neither option is given,
both will be deleted. both will be deleted.
If directories are given on the command line, only files in these If directories are given on the command line, only files in these
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(b'print') act = not opts.get(b'print')
eol = b'\n' eol = b'\n'
if opts.get(b'print0'): if opts.get(b'print0'):
eol = b'\0' eol = b'\0'
act = False # --print0 implies --print act = False # --print0 implies --print
if opts.get(b'all', False):
ignored = True
unknown = True
else:
ignored = opts.get(b'ignored', False)
unknown = not ignored
cmdutil.check_at_most_one_arg(opts, b'all', b'ignored')
pulkitUnsubmitted
Not Done

nit: it's better to have the check earlier, i.e. after line 99 on this side.

pulkit: nit: it's better to have the check earlier, i.e. after line 99 on this side.
removefiles = opts.get(b'files') removefiles = opts.get(b'files')
removedirs = opts.get(b'dirs') removedirs = opts.get(b'dirs')
if not removefiles and not removedirs: if not removefiles and not removedirs:
removefiles = True removefiles = True
removedirs = True removedirs = True
match = scmutil.match(repo[None], dirs, opts) match = scmutil.match(repo[None], dirs, opts)
paths = mergemod.purge( paths = mergemod.purge(
repo, repo,
match, match,
ignored=opts.get(b'all', False), unknown=unknown,
ignored=ignored,
removeemptydirs=removedirs, removeemptydirs=removedirs,
removefiles=removefiles, removefiles=removefiles,
abortonerror=opts.get(b'abort_on_err'), abortonerror=opts.get(b'abort_on_err'),
noop=not act, noop=not act,
) )
for path in paths: for path in paths:
if not act: if not act:
ui.write(b'%s%s' % (path, eol)) ui.write(b'%s%s' % (path, eol))

mercurial/merge.py

# fix up dirstate for copies and renames # fix up dirstate for copies and renames
copies.graftcopies(wctx, ctx, base) copies.graftcopies(wctx, ctx, base)
return stats return stats
def purge( def purge(
repo, repo,
matcher, matcher,
unknown=True,
ignored=False, ignored=False,
removeemptydirs=True, removeemptydirs=True,
removefiles=True, removefiles=True,
abortonerror=False, abortonerror=False,
noop=False, noop=False,
): ):
"""Purge the working directory of untracked files. """Purge the working directory of untracked files.
``matcher`` is a matcher configured to scan the working directory - ``matcher`` is a matcher configured to scan the working directory -
potentially a subset. potentially a subset.
``ignored`` controls whether ignored files should also be purged. ``unknown`` controls whether unknown files should be purged.
``ignored`` controls whether ignored files should be purged.
``removeemptydirs`` controls whether empty directories should be removed. ``removeemptydirs`` controls whether empty directories should be removed.
``removefiles`` controls whether files are removed. ``removefiles`` controls whether files are removed.
``abortonerror`` causes an exception to be raised if an error occurs ``abortonerror`` causes an exception to be raised if an error occurs
deleting a file or directory. deleting a file or directory.
res = [] res = []
try: try:
if removeemptydirs: if removeemptydirs:
directories = [] directories = []
matcher.traversedir = directories.append matcher.traversedir = directories.append
status = repo.status(match=matcher, ignored=ignored, unknown=True) status = repo.status(match=matcher, ignored=ignored, unknown=unknown)
if removefiles: if removefiles:
for f in sorted(status.unknown + status.ignored): for f in sorted(status.unknown + status.ignored):
if not noop: if not noop:
repo.ui.note(_(b'removing file %s\n') % f) repo.ui.note(_(b'removing file %s\n') % f)
remove(repo.wvfs.unlink, f) remove(repo.wvfs.unlink, f)
res.append(f) res.append(f)

tests/test-purge.t

$ cd .. $ cd ..
$ ls $ ls
directory directory
r1 r1
$ ls directory/untracked_file $ ls directory/untracked_file
directory/untracked_file directory/untracked_file
$ rm directory/untracked_file $ rm directory/untracked_file
skip ignored files if --all not specified skip ignored files if -i or --all not specified
$ touch ignored $ touch ignored
$ hg purge -p $ hg purge -p
$ hg purge -v $ hg purge -v
$ touch untracked_file
$ ls $ ls
directory directory
ignored ignored
r1 r1
untracked_file
$ hg purge -p -i
ignored
$ hg purge -v -i
removing file ignored
$ ls
directory
r1
untracked_file
$ touch ignored
$ hg purge -p --all $ hg purge -p --all
ignored ignored
untracked_file
$ hg purge -v --all $ hg purge -v --all
removing file ignored removing file ignored
removing file untracked_file
$ ls $ ls
directory directory
r1 r1
abort with missing files until we support name mangling filesystems abort with missing files until we support name mangling filesystems
$ touch untracked_file $ touch untracked_file
$ rm r1 $ rm r1