This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9820

purge: move extension into core mercurial
ClosedPublic

Authored by marmoute on Jan 18 2021, 4:26 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHGbb3a5c0df06b: purge: move extension into core mercurial
Summary

The motivation is simple: it's nicer to avoid gating basic
functionality.

To reduce the risk of people shooting themselves in the feet, --confirm is now
the default, unless the extensions is loaded..

For review of the body of the purge command, use this instead of what
hg/phabricator will show (the block of code is modified, not just
moved):

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

marmoute created this revision.Jan 18 2021, 4:26 AM
Alphare accepted this revision.Jan 22 2021, 8:51 AM
pulkit added a subscriber: pulkit.Jan 22 2021, 11:48 AM
pulkit added inline comments.
relnotes/next
20

This is not the correct relnotes file anymore. We need to move existing one to 5.7 and then create and empty next one.

valentin.gatienbaron added a commit: rHGbb3a5c0df06b: purge: move extension into core mercurial.Jan 22 2021, 3:38 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGbb3a5c0df06b: purge: move extension into core mercurial (authored by valentin.gatienbaron). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 25223

hgext/largefiles/overrides.py

# function to take care of the rest. Make sure it doesn't do anything with # function to take care of the rest. Make sure it doesn't do anything with
# largefiles by passing a matcher that will ignore them. # largefiles by passing a matcher that will ignore them.
matcher = composenormalfilematcher(matcher, repo[None].manifest(), added) matcher = composenormalfilematcher(matcher, repo[None].manifest(), added)
return orig(repo, matcher, prefix, uipathfn, opts) return orig(repo, matcher, prefix, uipathfn, opts)
# Calling purge with --all will cause the largefiles to be deleted. # Calling purge with --all will cause the largefiles to be deleted.
# Override repo.status to prevent this from happening. # Override repo.status to prevent this from happening.
@eh.wrapcommand(b'purge', extension=b'purge') @eh.wrapcommand(b'purge')
def overridepurge(orig, ui, repo, *dirs, **opts): def overridepurge(orig, ui, repo, *dirs, **opts):
# XXX Monkey patching a repoview will not work. The assigned attribute will # XXX Monkey patching a repoview will not work. The assigned attribute will
# be set on the unfiltered repo, but we will only lookup attributes in the # be set on the unfiltered repo, but we will only lookup attributes in the
# unfiltered repo if the lookup in the repoview object itself fails. As the # unfiltered repo if the lookup in the repoview object itself fails. As the
# monkey patched method exists on the repoview class the lookup will not # monkey patched method exists on the repoview class the lookup will not
# fail. As a result, the original version will shadow the monkey patched # fail. As a result, the original version will shadow the monkey patched
# one, defeating the monkey patch. # one, defeating the monkey patch.
# #

hgext/purge.py

# This program is distributed in the hope that it will be useful, # This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of # but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# 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 (DEPRECATED)
from __future__ import absolute_import
from mercurial.i18n import _ The functionality of this extension has been included in core Mercurial since
from mercurial import ( version 5.7. Please use :hg:`purge ...` instead. :hg:`purge --confirm` is now the default, unless the extension is enabled for backward compatibility.
cmdutil, '''
merge as mergemod,
pycompat,
registrar,
scmutil,
)
cmdtable = {} # This empty extension looks pointless, but core mercurial checks if it's loaded
command = registrar.command(cmdtable) # to implement the slightly different behavior documented above.
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
# be specifying the version(s) of Mercurial they are tested with, or
# leave the attribute unspecified.
testedwith = b'ships-with-hg-core'
@command(
b'purge|clean',
[
(b'a', b'abort-on-err', None, _(b'abort if an error occurs')),
(b'', b'all', None, _(b'purge ignored files too')),
(b'i', b'ignored', None, _(b'purge only ignored files')),
(b'', b'dirs', None, _(b'purge empty directories')),
(b'', b'files', None, _(b'purge files')),
(b'p', b'print', None, _(b'print filenames instead of deleting them')),
(
b'0',
b'print0',
None,
_(
b'end filenames with NUL, for use with xargs'
b' (implies -p/--print)'
),
),
(b'', b'confirm', None, _(b'ask before permanently deleting files')),
]
+ cmdutil.walkopts,
_(b'hg purge [OPTION]... [DIR]...'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY,
)
def purge(ui, repo, *dirs, **opts):
"""removes files not tracked by Mercurial
Delete files not known to Mercurial. This is useful to test local
and uncommitted changes in an otherwise-clean source tree.
This means that purge will delete the following by default:
- Unknown files: files marked with "?" by :hg:`status`
- Empty directories: in fact Mercurial ignores directories unless
they contain files under source control management
But it will leave untouched:
- Modified and unmodified tracked files
- Ignored files (unless -i or --all is specified)
- New files added to the repository (with :hg:`add`)
The --files and --dirs options can be used to direct purge to delete
only files, only directories, or both. If neither option is given,
both will be deleted.
If directories are given on the command line, only files in these
directories are considered.
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
list of files that this program would delete, use the --print
option.
"""
opts = pycompat.byteskwargs(opts)
cmdutil.check_at_most_one_arg(opts, b'all', b'ignored')
act = not opts.get(b'print')
eol = b'\n'
if opts.get(b'print0'):
eol = b'\0'
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
removefiles = opts.get(b'files')
removedirs = opts.get(b'dirs')
confirm = opts.get(b'confirm')
if not removefiles and not removedirs:
removefiles = True
removedirs = True
match = scmutil.match(repo[None], dirs, opts)
paths = mergemod.purge(
repo,
match,
unknown=unknown,
ignored=ignored,
removeemptydirs=removedirs,
removefiles=removefiles,
abortonerror=opts.get(b'abort_on_err'),
noop=not act,
confirm=confirm,
)
for path in paths:
if not act:
ui.write(b'%s%s' % (path, eol))

mercurial/commands.py

del repo._subtoppath del repo._subtoppath
finally: finally:
other.close() other.close()
return ret return ret
@command( @command(
b'purge|clean',
[
(b'a', b'abort-on-err', None, _(b'abort if an error occurs')),
(b'', b'all', None, _(b'purge ignored files too')),
(b'i', b'ignored', None, _(b'purge only ignored files')),
(b'', b'dirs', None, _(b'purge empty directories')),
(b'', b'files', None, _(b'purge files')),
(b'p', b'print', None, _(b'print filenames instead of deleting them')),
(
b'0',
b'print0',
None,
_(
b'end filenames with NUL, for use with xargs'
b' (implies -p/--print)'
),
),
(b'', b'confirm', None, _(b'ask before permanently deleting files')),
]
+ cmdutil.walkopts,
_(b'hg purge [OPTION]... [DIR]...'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY,
)
def purge(ui, repo, *dirs, **opts):
"""removes files not tracked by Mercurial
Delete files not known to Mercurial. This is useful to test local
and uncommitted changes in an otherwise-clean source tree.
This means that purge will delete the following by default:
- Unknown files: files marked with "?" by :hg:`status`
- Empty directories: in fact Mercurial ignores directories unless
they contain files under source control management
But it will leave untouched:
- Modified and unmodified tracked files
- Ignored files (unless -i or --all is specified)
- New files added to the repository (with :hg:`add`)
The --files and --dirs options can be used to direct purge to delete
only files, only directories, or both. If neither option is given,
both will be deleted.
If directories are given on the command line, only files in these
directories are considered.
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
list of files that this program would delete, use the --print
option.
"""
opts = pycompat.byteskwargs(opts)
cmdutil.check_at_most_one_arg(opts, b'all', b'ignored')
act = not opts.get(b'print')
eol = b'\n'
if opts.get(b'print0'):
eol = b'\0'
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
removefiles = opts.get(b'files')
removedirs = opts.get(b'dirs')
confirm = opts.get(b'confirm')
if confirm is None:
try:
extensions.find(b'purge')
confirm = False
except KeyError:
confirm = True
if not removefiles and not removedirs:
removefiles = True
removedirs = True
match = scmutil.match(repo[None], dirs, opts)
paths = mergemod.purge(
repo,
match,
unknown=unknown,
ignored=ignored,
removeemptydirs=removedirs,
removefiles=removefiles,
abortonerror=opts.get(b'abort_on_err'),
noop=not act,
confirm=confirm,
)
for path in paths:
if not act:
ui.write(b'%s%s' % (path, eol))
@command(
b'push', b'push',
[ [
(b'f', b'force', None, _(b'force push')), (b'f', b'force', None, _(b'force push')),
( (
b'r', b'r',
b'rev', b'rev',
[], [],
_(b'a changeset intended to be included in the destination'), _(b'a changeset intended to be included in the destination'),

relnotes/next

* There is a new set of config options for the template used for the * There is a new set of config options for the template used for the
one-line commit summary displayed by various commands, such as `hg one-line commit summary displayed by various commands, such as `hg
rebase`. The main one is `command-templates.oneline-summary`. That rebase`. The main one is `command-templates.oneline-summary`. That
can be overridden per command with can be overridden per command with
`command-templates.oneline-summary.<command>`, where `<command>` `command-templates.oneline-summary.<command>`, where `<command>`
can be e.g. `rebase`. As part of this effort, the default format can be e.g. `rebase`. As part of this effort, the default format
from `hg rebase` was reorganized a bit. from `hg rebase` was reorganized a bit.
* `hg purge` is now a core command using `--confirm` by default.
pulkitUnsubmitted
Not Done

This is not the correct relnotes file anymore. We need to move existing one to 5.7 and then create and empty next one.

pulkit: This is not the correct relnotes file anymore. We need to move existing one to 5.7 and then…
* `hg strip`, from the strip extension, is now a core command, `hg * `hg strip`, from the strip extension, is now a core command, `hg
debugstrip`. The extension remains for compatibility. debugstrip`. The extension remains for compatibility.
* `hg diff` and `hg extdiff` now support `--from <rev>` and `--to <rev>` * `hg diff` and `hg extdiff` now support `--from <rev>` and `--to <rev>`
arguments as clearer alternatives to `-r <revs>`. `-r <revs>` has been arguments as clearer alternatives to `-r <revs>`. `-r <revs>` has been
deprecated. deprecated.
* The memory footprint per changeset during pull/unbundle * The memory footprint per changeset during pull/unbundle

tests/test-completion.t

log log
manifest manifest
merge merge
outgoing outgoing
parents parents
paths paths
phase phase
pull pull
purge
push push
recover recover
remove remove
rename rename
resolve resolve
revert revert
rollback rollback
root root
log: follow, follow-first, date, copies, keyword, rev, line-range, removed, only-merges, user, only-branch, branch, bookmark, prune, patch, git, limit, no-merges, stat, graph, style, template, include, exclude log: follow, follow-first, date, copies, keyword, rev, line-range, removed, only-merges, user, only-branch, branch, bookmark, prune, patch, git, limit, no-merges, stat, graph, style, template, include, exclude
manifest: rev, all, template manifest: rev, all, template
merge: force, rev, preview, abort, tool merge: force, rev, preview, abort, tool
outgoing: force, rev, newest-first, bookmarks, branch, patch, git, limit, no-merges, stat, graph, style, template, ssh, remotecmd, insecure, subrepos outgoing: force, rev, newest-first, bookmarks, branch, patch, git, limit, no-merges, stat, graph, style, template, ssh, remotecmd, insecure, subrepos
parents: rev, style, template parents: rev, style, template
paths: template paths: template
phase: public, draft, secret, force, rev phase: public, draft, secret, force, rev
pull: update, force, confirm, rev, bookmark, branch, ssh, remotecmd, insecure pull: update, force, confirm, rev, bookmark, branch, ssh, remotecmd, insecure
purge: abort-on-err, all, ignored, dirs, files, print, print0, confirm, include, exclude
push: force, rev, bookmark, all-bookmarks, branch, new-branch, pushvars, publish, ssh, remotecmd, insecure push: force, rev, bookmark, all-bookmarks, branch, new-branch, pushvars, publish, ssh, remotecmd, insecure
recover: verify recover: verify
remove: after, force, subrepos, include, exclude, dry-run remove: after, force, subrepos, include, exclude, dry-run
rename: after, at-rev, force, include, exclude, dry-run rename: after, at-rev, force, include, exclude, dry-run
resolve: all, list, mark, unmark, no-status, re-merge, tool, include, exclude, template resolve: all, list, mark, unmark, no-status, re-merge, tool, include, exclude, template
revert: all, date, rev, no-backup, interactive, include, exclude, dry-run revert: all, date, rev, no-backup, interactive, include, exclude, dry-run
rollback: dry-run, force rollback: dry-run, force
root: template root: template

tests/test-globalopts.t

log show revision history of entire repository or files log show revision history of entire repository or files
Working directory management: Working directory management:
add add the specified files on the next commit add add the specified files on the next commit
addremove add all new files, delete all missing files addremove add all new files, delete all missing files
files list tracked files files list tracked files
forget forget the specified files on the next commit forget forget the specified files on the next commit
purge removes files not tracked by Mercurial
remove remove the specified files on the next commit remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files resolve redo merges or set/view the merge status of files
revert restore files to their checkout state revert restore files to their checkout state
root print the root (top) of the current working directory root print the root (top) of the current working directory
shelve save and set aside changes from the working directory shelve save and set aside changes from the working directory
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state
log show revision history of entire repository or files log show revision history of entire repository or files
Working directory management: Working directory management:
add add the specified files on the next commit add add the specified files on the next commit
addremove add all new files, delete all missing files addremove add all new files, delete all missing files
files list tracked files files list tracked files
forget forget the specified files on the next commit forget forget the specified files on the next commit
purge removes files not tracked by Mercurial
remove remove the specified files on the next commit remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files resolve redo merges or set/view the merge status of files
revert restore files to their checkout state revert restore files to their checkout state
root print the root (top) of the current working directory root print the root (top) of the current working directory
shelve save and set aside changes from the working directory shelve save and set aside changes from the working directory
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state

tests/test-help-hide.t

log show revision history of entire repository or files log show revision history of entire repository or files
Working directory management: Working directory management:
add add the specified files on the next commit add add the specified files on the next commit
addremove add all new files, delete all missing files addremove add all new files, delete all missing files
files list tracked files files list tracked files
forget forget the specified files on the next commit forget forget the specified files on the next commit
purge removes files not tracked by Mercurial
remove remove the specified files on the next commit remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files resolve redo merges or set/view the merge status of files
revert restore files to their checkout state revert restore files to their checkout state
root print the root (top) of the current working directory root print the root (top) of the current working directory
shelve save and set aside changes from the working directory shelve save and set aside changes from the working directory
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state
log show revision history of entire repository or files log show revision history of entire repository or files
Working directory management: Working directory management:
add add the specified files on the next commit add add the specified files on the next commit
addremove add all new files, delete all missing files addremove add all new files, delete all missing files
files list tracked files files list tracked files
forget forget the specified files on the next commit forget forget the specified files on the next commit
purge removes files not tracked by Mercurial
remove remove the specified files on the next commit remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files resolve redo merges or set/view the merge status of files
revert restore files to their checkout state revert restore files to their checkout state
root print the root (top) of the current working directory root print the root (top) of the current working directory
shelve save and set aside changes from the working directory shelve save and set aside changes from the working directory
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state

tests/test-help.t

log show revision history of entire repository or files log show revision history of entire repository or files
Working directory management: Working directory management:
add add the specified files on the next commit add add the specified files on the next commit
addremove add all new files, delete all missing files addremove add all new files, delete all missing files
files list tracked files files list tracked files
forget forget the specified files on the next commit forget forget the specified files on the next commit
purge removes files not tracked by Mercurial
remove remove the specified files on the next commit remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files resolve redo merges or set/view the merge status of files
revert restore files to their checkout state revert restore files to their checkout state
root print the root (top) of the current working directory root print the root (top) of the current working directory
shelve save and set aside changes from the working directory shelve save and set aside changes from the working directory
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state
log show revision history of entire repository or files log show revision history of entire repository or files
Working directory management: Working directory management:
add add the specified files on the next commit add add the specified files on the next commit
addremove add all new files, delete all missing files addremove add all new files, delete all missing files
files list tracked files files list tracked files
forget forget the specified files on the next commit forget forget the specified files on the next commit
purge removes files not tracked by Mercurial
remove remove the specified files on the next commit remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files resolve redo merges or set/view the merge status of files
revert restore files to their checkout state revert restore files to their checkout state
root print the root (top) of the current working directory root print the root (top) of the current working directory
shelve save and set aside changes from the working directory shelve save and set aside changes from the working directory
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state
hgk browse the repository in a graphical way hgk browse the repository in a graphical way
highlight syntax highlighting for hgweb (requires Pygments) highlight syntax highlighting for hgweb (requires Pygments)
histedit interactive history editing histedit interactive history editing
keyword expand keywords in tracked files keyword expand keywords in tracked files
largefiles track large binary files largefiles track large binary files
mq manage a stack of patches mq manage a stack of patches
notify hooks for sending email push notifications notify hooks for sending email push notifications
patchbomb command to send changesets as (a series of) patch emails patchbomb command to send changesets as (a series of) patch emails
purge command to delete untracked files from the working
directory
relink recreates hardlinks between repository clones relink recreates hardlinks between repository clones
schemes extend schemes with shortcuts to repository swarms schemes extend schemes with shortcuts to repository swarms
share share a common history between several working directories share share a common history between several working directories
transplant command to transplant changesets from another branch transplant command to transplant changesets from another branch
win32mbcs allow the use of MBCS paths with problematic encodings win32mbcs allow the use of MBCS paths with problematic encodings
zeroconf discover and advertise repositories on the local network zeroconf discover and advertise repositories on the local network
#endif #endif
<tr><td> <tr><td>
<a href="/help/phase"> <a href="/help/phase">
phase phase
</a> </a>
</td><td> </td><td>
set or show the current phase name set or show the current phase name
</td></tr> </td></tr>
<tr><td> <tr><td>
<a href="/help/purge">
purge
</a>
</td><td>
removes files not tracked by Mercurial
</td></tr>
<tr><td>
<a href="/help/recover"> <a href="/help/recover">
recover recover
</a> </a>
</td><td> </td><td>
roll back an interrupted transaction roll back an interrupted transaction
</td></tr> </td></tr>
<tr><td> <tr><td>
<a href="/help/rename"> <a href="/help/rename">

tests/test-hgweb-json.t

"summary": "show aliases for remote repositories", "summary": "show aliases for remote repositories",
"topic": "paths" "topic": "paths"
}, },
{ {
"summary": "set or show the current phase name", "summary": "set or show the current phase name",
"topic": "phase" "topic": "phase"
}, },
{ {
"summary": "removes files not tracked by Mercurial",
"topic": "purge"
},
{
"summary": "roll back an interrupted transaction", "summary": "roll back an interrupted transaction",
"topic": "recover" "topic": "recover"
}, },
{ {
"summary": "rename files; equivalent of copy + remove", "summary": "rename files; equivalent of copy + remove",
"topic": "rename" "topic": "rename"
}, },
{ {

tests/test-purge.t

$ cat <<EOF >> $HGRCPATH
> [extensions]
> purge =
> EOF
init init
$ hg init t $ hg init t
$ cd t $ cd t
setup setup
$ echo r1 > r1 $ echo r1 > r1
$ hg ci -qAmr1 -d'0 0' $ hg ci -qAmr1 -d'0 0'
$ mkdir directory $ mkdir directory
$ echo r2 > directory/r2 $ echo r2 > directory/r2
$ hg ci -qAmr2 -d'1 0' $ hg ci -qAmr2 -d'1 0'
$ echo 'ignored' > .hgignore $ echo 'ignored' > .hgignore
$ hg ci -qAmr3 -d'2 0' $ hg ci -qAmr3 -d'2 0'
purge without the extension
$ hg st
$ touch foo
$ hg purge
permanently delete 1 unkown files? (yN) n
abort: removal cancelled
[250]
$ hg st
? foo
$ hg purge --no-confirm
$ hg st
now enabling the extension
$ cat <<EOF >> $HGRCPATH
> [extensions]
> purge =
> EOF
delete an empty directory delete an empty directory
$ mkdir empty_dir $ mkdir empty_dir
$ hg purge -p -v $ hg purge -p -v
empty_dir empty_dir
$ hg purge --confirm $ hg purge --confirm
permanently delete at least 1 empty directories? (yN) n permanently delete at least 1 empty directories? (yN) n
abort: removal cancelled abort: removal cancelled