This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3763

grep: add `--diff` flag
ClosedPublic

Authored by sangeet259 on Jun 17 2018, 6:31 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG7fbb5d76c555: grep: add --diff flag
Summary

adds a diff flag, which works exactly same as all, infact since
-all searches diffs, there diff is a better name for it.
The all flag is still here for backward compatibility reasons.
Some major tests for all has been picked and added for diff.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

sangeet259 created this revision.Jun 17 2018, 6:31 AM
pulkit added a subscriber: pulkit.Jun 18 2018, 4:14 PM
pulkit added inline comments.
mercurial/commands.py
2419

We definitely need better help text here to mention that it looks at the diff not all the content.

2446

To deprecate a flag, we need to add (DEPRECATED) after the help text of the flag. Look for DEPRECATED, EXPERIMENTAL, ADVANCED in commands.py, you will find examples.

Also, I suggest you to make a separate patch for deprecating the flag.

2554

nit: it will be better if we can initialize a variable and store opts.get('all') and opts.get('diff') in it and reuse that.

sangeet259 updated this revision to Diff 9217.Jun 19 2018, 4:42 AM
yuja added a subscriber: yuja.Jun 21 2018, 8:43 AM

Queued, thanks.

Can you send a follow-up to deprecate the --all option?
It doesn't make sense to provide both --all and --diff in user help.

[('0', 'print0', None, _('end fields with NUL')),
('', 'all', None, _('print all revisions that match')),

+ ('', 'diff', None, _('print all revisions when the term was introduced or removed')),

Next time, please make sure test-check-* pass.

Closed by commit rHG7fbb5d76c555: grep: add --diff flag (authored by sangeet259). · Explain WhyJun 21 2018, 8:44 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (9 lines)
Mtests/test-grep.t (20 lines)

Diff 9125

mercurial/commands.py

graftstate.delete() graftstate.delete()
ui.status(_("stopped the interrupted graft\n")) ui.status(_("stopped the interrupted graft\n"))
ui.status(_("working directory is now at %s\n") % pctx.hex()[:12]) ui.status(_("working directory is now at %s\n") % pctx.hex()[:12])
return 0 return 0
@command('grep', @command('grep',
[('0', 'print0', None, _('end fields with NUL')), [('0', 'print0', None, _('end fields with NUL')),
('', 'all', None, _('print all revisions that match')), ('', 'all', None, _('print all revisions that match')),
('', 'diff', None, _('print all revisions that match')),
pulkitUnsubmitted
Not Done

We definitely need better help text here to mention that it looks at the diff not all the content.

pulkit: We definitely need better help text here to mention that it looks at the diff not all the…
('a', 'text', None, _('treat all files as text')), ('a', 'text', None, _('treat all files as text')),
('f', 'follow', None, ('f', 'follow', None,
_('follow changeset history,' _('follow changeset history,'
' or file history across copies and renames')), ' or file history across copies and renames')),
('i', 'ignore-case', None, _('ignore case when matching')), ('i', 'ignore-case', None, _('ignore case when matching')),
('l', 'files-with-matches', None, ('l', 'files-with-matches', None,
_('print only filenames and revisions that match')), _('print only filenames and revisions that match')),
('n', 'line-number', None, _('print matching line numbers')), ('n', 'line-number', None, _('print matching line numbers')),
Search revision history for a regular expression in the specified Search revision history for a regular expression in the specified
files or the entire project. files or the entire project.
By default, grep prints the most recent revision number for each By default, grep prints the most recent revision number for each
file in which it finds a match. To get it to print every revision file in which it finds a match. To get it to print every revision
that contains a change in match status ("-" for a match that becomes that contains a change in match status ("-" for a match that becomes
a non-match, or "+" for a non-match that becomes a match), use the a non-match, or "+" for a non-match that becomes a match), use the
--all flag. --diff/--all(DEPRECATED) flag.
pulkitUnsubmitted
Not Done

To deprecate a flag, we need to add (DEPRECATED) after the help text of the flag. Look for DEPRECATED, EXPERIMENTAL, ADVANCED in commands.py, you will find examples.

Also, I suggest you to make a separate patch for deprecating the flag.

pulkit: To deprecate a flag, we need to add (DEPRECATED) after the help text of the flag. Look for…
PATTERN can be any Python (roughly Perl-compatible) regular PATTERN can be any Python (roughly Perl-compatible) regular
expression. expression.
If no FILEs are specified (and -f/--follow isn't set), all files in If no FILEs are specified (and -f/--follow isn't set), all files in
the repository are searched, including those that don't exist in the the repository are searched, including those that don't exist in the
current branch or have been deleted in a prior changeset. current branch or have been deleted in a prior changeset.
def binary(): def binary():
flog = getfile(fn) flog = getfile(fn)
try: try:
return stringutil.binary(flog.read(ctx.filenode(fn))) return stringutil.binary(flog.read(ctx.filenode(fn)))
except error.WdirUnsupported: except error.WdirUnsupported:
return ctx[fn].isbinary() return ctx[fn].isbinary()
fieldnamemap = {'filename': 'file', 'linenumber': 'line_number'} fieldnamemap = {'filename': 'file', 'linenumber': 'line_number'}
if opts.get('all'): if opts.get('all') or opts.get('diff'):
pulkitUnsubmitted
Not Done

nit: it will be better if we can initialize a variable and store opts.get('all') and opts.get('diff') in it and reuse that.

pulkit: nit: it will be better if we can initialize a variable and store `opts.get('all') and opts.get…
iter = difflinestates(pstates, states) iter = difflinestates(pstates, states)
else: else:
iter = [('', l) for l in states] iter = [('', l) for l in states]
for change, l in iter: for change, l in iter:
fm.startitem() fm.startitem()
fm.data(node=fm.hexfunc(scmutil.binnode(ctx))) fm.data(node=fm.hexfunc(scmutil.binnode(ctx)))
cols = [ cols = [
('filename', fn, True), ('filename', fn, True),
('rev', rev, True), ('rev', rev, True),
('linenumber', l.linenum, opts.get('line_number')), ('linenumber', l.linenum, opts.get('line_number')),
] ]
if opts.get('all'): if opts.get('all') or opts.get('diff'):
cols.append(('change', change, True)) cols.append(('change', change, True))
cols.extend([ cols.extend([
('user', formatuser(ctx.user()), opts.get('user')), ('user', formatuser(ctx.user()), opts.get('user')),
('date', fm.formatdate(ctx.date(), datefmt), opts.get('date')), ('date', fm.formatdate(ctx.date(), datefmt), opts.get('date')),
]) ])
lastcol = next(name for name, data, cond in reversed(cols) if cond) lastcol = next(name for name, data, cond in reversed(cols) if cond)
for name, data, cond in cols: for name, data, cond in cols:
field = fieldnamemap.get(name, name) field = fieldnamemap.get(name, name)
if fn in skip: if fn in skip:
if copy: if copy:
skip[copy] = True skip[copy] = True
continue continue
pstates = matches.get(parent, {}).get(copy or fn, []) pstates = matches.get(parent, {}).get(copy or fn, [])
if pstates or states: if pstates or states:
r = display(fm, fn, ctx, pstates, states) r = display(fm, fn, ctx, pstates, states)
found = found or r found = found or r
if r and not opts.get('all'): if r and not (opts.get('all') or opts.get('diff')):
skip[fn] = True skip[fn] = True
if copy: if copy:
skip[copy] = True skip[copy] = True
del revfiles[rev] del revfiles[rev]
# We will keep the matches dict for the duration of the window # We will keep the matches dict for the duration of the window
# clear the matches dict once the window is over # clear the matches dict once the window is over
if not revfiles: if not revfiles:
matches.clear() matches.clear()

tests/test-grep.t

$ hg ci -m 3 $ hg ci -m 3
$ hg grep orange $ hg grep orange
color:3:orange color:3:orange
$ hg grep --all orange $ hg grep --all orange
color:3:+:orange color:3:+:orange
color:2:-:orange color:2:-:orange
color:1:+:orange color:1:+:orange
$ hg grep --diff orange
color:3:+:orange
color:2:-:orange
color:1:+:orange
test substring match: '^' should only match at the beginning test substring match: '^' should only match at the beginning
$ hg grep '^.' --config extensions.color= --color debug $ hg grep '^.' --config extensions.color= --color debug
[grep.filename|color][grep.sep|:][grep.rev|3][grep.sep|:][grep.match|b]lack [grep.filename|color][grep.sep|:][grep.rev|3][grep.sep|:][grep.match|b]lack
[grep.filename|color][grep.sep|:][grep.rev|3][grep.sep|:][grep.match|o]range [grep.filename|color][grep.sep|:][grep.rev|3][grep.sep|:][grep.match|o]range
[grep.filename|color][grep.sep|:][grep.rev|3][grep.sep|:][grep.match|b]lue [grep.filename|color][grep.sep|:][grep.rev|3][grep.sep|:][grep.match|b]lue
match in last "line" without newline match in last "line" without newline
1 files updated, 0 files merged, 0 files removed, 0 files unresolved 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ echo blue > color $ echo blue > color
$ hg commit -A -m "3 blue" $ hg commit -A -m "3 blue"
$ hg grep --all red $ hg grep --all red
color:3:-:red color:3:-:red
color:1:+:red color:1:+:red
$ hg grep --diff red
color:3:-:red
color:1:+:red
Issue3885: test that changing revision order does not alter the Issue3885: test that changing revision order does not alter the
revisions printed, just their order. revisions printed, just their order.
$ hg grep --all red -r "all()" $ hg grep --all red -r "all()"
color:1:+:red color:1:+:red
color:3:-:red color:3:-:red
$ hg grep --all red -r "reverse(all())" $ hg grep --all red -r "reverse(all())"
color:3:-:red color:3:-:red
color:1:+:red color:1:+:red
$ hg grep --diff red -r "all()"
color:1:+:red
color:3:-:red
$ hg grep --diff red -r "reverse(all())"
color:3:-:red
color:1:+:red
$ cd .. $ cd ..
$ hg init a $ hg init a
$ cd a $ cd a
$ cp "$TESTDIR/binfile.bin" . $ cp "$TESTDIR/binfile.bin" .
$ hg add binfile.bin $ hg add binfile.bin
$ hg ci -m 'add binfile.bin' $ hg ci -m 'add binfile.bin'
$ hg grep "MaCam" --all $ hg grep "MaCam" --all
binfile.bin:0:+: Binary file matches binfile.bin:0:+: Binary file matches
$ hg grep "MaCam" --diff
binfile.bin:0:+: Binary file matches
$ cd .. $ cd ..
Fix_Wdir(): test that passing wdir() t -r flag does greps on the Fix_Wdir(): test that passing wdir() t -r flag does greps on the
files modified in the working directory files modified in the working directory
$ cd a $ cd a
$ echo "abracadara" >> a $ echo "abracadara" >> a
$ hg add a $ hg add a
$ hg grep -r "wdir()" "abra" $ hg grep -r "wdir()" "abra"
a:2147483647:abracadara a:2147483647:abracadara
$ cd .. $ cd ..