This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3826

grep: change default behaviour of grep
ClosedPublic

Authored by sangeet259 on Jun 21 2018, 2:42 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG9ef10437bb88: grep: change default behaviour to search working directory files (BC)
Summary

with this patch grep searches on the working directory by default
and looks for all files tracked by the working directory and greps on them

OLD BEHAVIOUR

$ hg init a
$ cd a
$ echo "some text">>file1
$ hg add file1
$ hg commit -m "adds file1"
$ hg mv file1 file2
$ hg grep "some"
file2:1:some text
file1:0:some text

This behaviour is undesirable since file1 is not in the current history and was
renamed as file2, so the second result was redundant and confusing

NEW BEHAVIOUR

$ hg init a
$ cd a
$ echo "some text">>file1
$ hg add file1
$ hg commit -m "adds file1"
$ hg mv file1 file2
$ hg grep "some"
file2:2147483647:some text

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

sangeet259 created this revision.Jun 21 2018, 2:42 PM
sangeet259 updated this revision to Diff 9252.Jun 21 2018, 2:44 PM
sangeet259 retitled this revision from grep : change default behaviour of grep to grep: change default behaviour of grep.Jun 21 2018, 2:48 PM
sangeet259 added a comment.Jun 21 2018, 2:49 PM

I need some help with the tests failing here.

yuja added a subscriber: yuja.Jun 23 2018, 11:23 PM

@@ -2431,6 +2431,10 @@

Returns 0 if a match is found, 1 otherwise.
"""
opts = pycompat.byteskwargs(opts)

+
+ if len(opts.get('rev')) ==1:
+ opts['allfiles'] = True

So, -rA implies --allfiles but -rA -rB doesn't? which seems worse than
the current situation.

And we'll need an option to get back the original behavior.

sangeet259 updated this revision to Diff 9461.Jul 5 2018, 3:12 PM
sangeet259 updated this revision to Diff 9462.Jul 5 2018, 3:30 PM
yuja added a comment.Jul 6 2018, 11:02 PM

+ if not opts.get('rev'):
+ opts.get('rev').append("wdir()")
+ opts['allfiles'] = True

So, this breaks hg grep --diff|--all?

And this is a behavior change. We should at least document how we can get
back the original behavior.

sangeet259 updated this revision to Diff 9470.Jul 7 2018, 11:44 PM
sangeet259 edited the summary of this revision. (Show Details)Jul 9 2018, 5:50 AM
sangeet259 updated this revision to Diff 9472.
sangeet259 edited the summary of this revision. (Show Details)Jul 9 2018, 6:02 AM
sangeet259 updated this revision to Diff 9473.
sangeet259 updated this revision to Diff 9474.
yuja added a comment.Jul 9 2018, 8:23 AM

Looks mostly good. Can you rebase this onto the current tip and update the
help?

$ hg grep '.*'
  • port:4:export
  • port:4:vaportight
  • port:4:import/export

+ port:2147483647:export
+ port:2147483647:vaportight
+ port:2147483647:import/export

[snip]

It's probably better to leave the existing tests to test the old behavior
by adding some arguments (maybe -r tip:0) unless we're sure that the new
behavior covers things that should be tested.

+ if not opts.get('rev') and not diff:
+ opts.get('rev').append("wdir()")

Nit: If you want to care for missing opts['rev'], this should be
opts['rev'] = ["wdir()"].

sangeet259 edited the summary of this revision. (Show Details)Jul 9 2018, 12:38 PM
sangeet259 updated this revision to Diff 9480.
sangeet259 updated this revision to Diff 9481.Jul 9 2018, 12:45 PM
sangeet259 updated this revision to Diff 9482.Jul 9 2018, 12:51 PM
durin42 requested changes to this revision.Jul 9 2018, 4:53 PM
durin42 added a subscriber: durin42.
durin42 added inline comments.
mercurial/commands.py
2517–2518

I think you need to update this line in the help? That is, by default we now search the working directory, and you have to say something else to search history.

This revision now requires changes to proceed.Jul 9 2018, 4:53 PM
sangeet259 updated this revision to Diff 9492.Jul 10 2018, 5:29 AM
yuja added a comment.Jul 10 2018, 9:36 AM

Queued, thanks.

$ hg up -q null
  • $ hg grep -f port
  • [1]

+ $ hg grep -r tip:0 -f port

I've changed this to -r 'reverse(:.)' since it was the default for -f.

  • 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
  • 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
  • --diff flag.

+ By default, grep searches the expression on the working directory
+ , to search history and show the most recent revision number for each
+ file in which it finds a match, use hg grep -r tip:0.
+ To get it to print every revision 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 --diff flag.

Perhaps this needs an English tweak, but I'm not a right person. So I only
fixed trivial stuffs.

Closed by commit rHG9ef10437bb88: grep: change default behaviour to search working directory files (BC) (authored by sangeet259). · Explain WhyJul 10 2018, 9:41 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (15 lines)
Mtests/test-grep.t (49 lines)

Diff 9500

mercurial/commands.py

_('[OPTION]... PATTERN [FILE]...'), _('[OPTION]... PATTERN [FILE]...'),
inferrepo=True, inferrepo=True,
intents={INTENT_READONLY}) intents={INTENT_READONLY})
def grep(ui, repo, pattern, *pats, **opts): def grep(ui, repo, pattern, *pats, **opts):
"""search revision history for a pattern in specified files """search revision history for a pattern in specified files
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 searches the expression on the working directory.
durin42Unsubmitted
Not Done

I think you need to update this line in the help? That is, by default we now search the working directory, and you have to say something else to search history.

durin42: I think you need to update this line in the help? That is, by default we now search the working…
file in which it finds a match. To get it to print every revision To search history and show the most recent revision number for each
that contains a change in match status ("-" for a match that becomes file in which it finds a match, use :hg:`grep -r tip:0`.
a non-match, or "+" for a non-match that becomes a match), use the To get it to print every revision that contains a change in match status
--diff flag. ("-" for a match that becomes a non-match, or "+" for a non-match that
becomes a match), use the --diff flag.
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.
Returns 0 if a match is found, 1 otherwise. Returns 0 if a match is found, 1 otherwise.
""" """
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
diff = opts.get('all') or opts.get('diff') diff = opts.get('all') or opts.get('diff')
reflags = re.M reflags = re.M
if opts.get('ignore_case'): if opts.get('ignore_case'):
reflags |= re.I reflags |= re.I
try: try:
regexp = util.re.compile(pattern, reflags) regexp = util.re.compile(pattern, reflags)
except re.error as inst: except re.error as inst:
ui.warn(_("grep: invalid match pattern: %s\n") % pycompat.bytestr(inst)) ui.warn(_("grep: invalid match pattern: %s\n") % pycompat.bytestr(inst))
return 1 return 1
sep, eol = ':', '\n' sep, eol = ':', '\n'
if opts.get('print0'): if opts.get('print0'):
sep = eol = '\0' sep = eol = '\0'
if not opts.get('rev') and not diff:
opts['rev'] = ["wdir()"]
opts['allfiles'] = True
getfile = util.lrucachefunc(repo.file) getfile = util.lrucachefunc(repo.file)
def matchlines(body): def matchlines(body):
begin = 0 begin = 0
linenum = 0 linenum = 0
while begin < len(body): while begin < len(body):
match = regexp.search(body, begin) match = regexp.search(body, begin)
if not match: if not match:

tests/test-grep.t

pattern error pattern error
$ hg grep '**test**' $ hg grep '**test**'
grep: invalid match pattern: nothing to repeat grep: invalid match pattern: nothing to repeat
[1] [1]
simple simple
$ hg grep '.*' $ hg grep -r tip:0 '.*'
port:4:export port:4:export
port:4:vaportight port:4:vaportight
port:4:import/export port:4:import/export
$ hg grep port port $ hg grep -r tip:0 port port
port:4:export port:4:export
port:4:vaportight port:4:vaportight
port:4:import/export port:4:import/export
simple with color simple with color
$ hg --config extensions.color= grep --config color.mode=ansi \ $ hg --config extensions.color= grep --config color.mode=ansi \
> --color=always port port > --color=always port port -r tip:0
\x1b[0;35mport\x1b[0m\x1b[0;36m:\x1b[0m\x1b[0;32m4\x1b[0m\x1b[0;36m:\x1b[0mex\x1b[0;31;1mport\x1b[0m (esc) \x1b[0;35mport\x1b[0m\x1b[0;36m:\x1b[0m\x1b[0;32m4\x1b[0m\x1b[0;36m:\x1b[0mex\x1b[0;31;1mport\x1b[0m (esc)
\x1b[0;35mport\x1b[0m\x1b[0;36m:\x1b[0m\x1b[0;32m4\x1b[0m\x1b[0;36m:\x1b[0mva\x1b[0;31;1mport\x1b[0might (esc) \x1b[0;35mport\x1b[0m\x1b[0;36m:\x1b[0m\x1b[0;32m4\x1b[0m\x1b[0;36m:\x1b[0mva\x1b[0;31;1mport\x1b[0might (esc)
\x1b[0;35mport\x1b[0m\x1b[0;36m:\x1b[0m\x1b[0;32m4\x1b[0m\x1b[0;36m:\x1b[0mim\x1b[0;31;1mport\x1b[0m/ex\x1b[0;31;1mport\x1b[0m (esc) \x1b[0;35mport\x1b[0m\x1b[0;36m:\x1b[0m\x1b[0;32m4\x1b[0m\x1b[0;36m:\x1b[0mim\x1b[0;31;1mport\x1b[0m/ex\x1b[0;31;1mport\x1b[0m (esc)
simple templated simple templated
$ hg grep port \ $ hg grep port -r tip:0 \
> -T '{file}:{rev}:{node|short}:{texts % "{if(matched, text|upper, text)}"}\n' > -T '{file}:{rev}:{node|short}:{texts % "{if(matched, text|upper, text)}"}\n'
port:4:914fa752cdea:exPORT port:4:914fa752cdea:exPORT
port:4:914fa752cdea:vaPORTight port:4:914fa752cdea:vaPORTight
port:4:914fa752cdea:imPORT/exPORT port:4:914fa752cdea:imPORT/exPORT
$ hg grep port -T '{file}:{rev}:{texts}\n' $ hg grep port -r tip:0 -T '{file}:{rev}:{texts}\n'
port:4:export port:4:export
port:4:vaportight port:4:vaportight
port:4:import/export port:4:import/export
$ hg grep port -T '{file}:{tags}:{texts}\n' $ hg grep port -r tip:0 -T '{file}:{tags}:{texts}\n'
port:tip:export port:tip:export
port:tip:vaportight port:tip:vaportight
port:tip:import/export port:tip:import/export
simple JSON (no "change" field) simple JSON (no "change" field)
$ hg grep -Tjson port $ hg grep -r tip:0 -Tjson port
[ [
{ {
"date": [4, 0], "date": [4, 0],
"file": "port", "file": "port",
"line_number": 1, "line_number": 1,
"node": "914fa752cdea87777ac1a8d5c858b0c736218f6c", "node": "914fa752cdea87777ac1a8d5c858b0c736218f6c",
"rev": 4, "rev": 4,
"texts": [{"matched": false, "text": "ex"}, {"matched": true, "text": "port"}], "texts": [{"matched": false, "text": "ex"}, {"matched": true, "text": "port"}],
"rev": 4, "rev": 4,
"texts": [{"matched": false, "text": "im"}, {"matched": true, "text": "port"}, {"matched": false, "text": "/ex"}, {"matched": true, "text": "port"}], "texts": [{"matched": false, "text": "im"}, {"matched": true, "text": "port"}, {"matched": false, "text": "/ex"}, {"matched": true, "text": "port"}],
"user": "spam" "user": "spam"
} }
] ]
simple JSON without matching lines simple JSON without matching lines
$ hg grep -Tjson -l port $ hg grep -r tip:0 -Tjson -l port
[ [
{ {
"date": [4, 0], "date": [4, 0],
"file": "port", "file": "port",
"line_number": 1, "line_number": 1,
"node": "914fa752cdea87777ac1a8d5c858b0c736218f6c", "node": "914fa752cdea87777ac1a8d5c858b0c736218f6c",
"rev": 4, "rev": 4,
"user": "spam" "user": "spam"
"rev": 0, "rev": 0,
"texts": [{"matched": false, "text": "im"}, {"matched": true, "text": "port"}], "texts": [{"matched": false, "text": "im"}, {"matched": true, "text": "port"}],
"user": "spam" "user": "spam"
} }
] ]
other other
$ hg grep -l port port $ hg grep -r tip:0 -l port port
port:4 port:4
$ hg grep import port $ hg grep -r tip:0 import port
port:4:import/export port:4:import/export
$ hg cp port port2 $ hg cp port port2
$ hg commit -m 4 -u spam -d '5 0' $ hg commit -m 4 -u spam -d '5 0'
follow follow
$ hg grep --traceback -f 'import\n\Z' port2 $ hg grep -r tip:0 --traceback -f 'import\n\Z' port2
port:0:import port:0:import
$ echo deport >> port2 $ echo deport >> port2
$ hg commit -m 5 -u eggs -d '6 0' $ hg commit -m 5 -u eggs -d '6 0'
$ hg grep -f --all -nu port port2 $ hg grep -f --all -nu port port2
port2:6:4:+:eggs:deport port2:6:4:+:eggs:deport
port:4:4:-:spam:import/export port:4:4:-:spam:import/export
port:3:4:+:eggs:import/export port:3:4:+:eggs:import/export
port:2:1:-:spam:import port:2:1:-:spam:import
port:2:2:-:spam:export port:2:2:-:spam:export
port:2:1:+:spam:export port:2:1:+:spam:export
port:2:2:+:spam:vaportight port:2:2:+:spam:vaportight
port:2:3:+:spam:import/export port:2:3:+:spam:import/export
port:1:2:+:eggs:export port:1:2:+:eggs:export
port:0:1:+:spam:import port:0:1:+:spam:import
$ hg up -q null $ hg up -q null
$ hg grep -f port $ hg grep -r 'reverse(:.)' -f port
[1] port:0:import
Test wdir Test wdir
(at least, this shouldn't crash) (at least, this shouldn't crash)
$ hg up -q $ hg up -q
$ echo wport >> port2 $ echo wport >> port2
$ hg stat $ hg stat
M port2 M port2
$ hg grep -r 'wdir()' port $ hg grep -r 'wdir()' port
port2:2147483647:export port2:2147483647:export
port2:2147483647:vaportight port2:2147483647:vaportight
port2:2147483647:import/export port2:2147483647:import/export
port2:2147483647:deport port2:2147483647:deport
port2:2147483647:wport port2:2147483647:wport
$ cd .. $ cd ..
$ hg init t2 $ hg init t2
$ cd t2 $ cd t2
$ hg grep foobar foo $ hg grep -r tip:0 foobar foo
[1] [1]
$ hg grep foobar $ hg grep -r tip:0 foobar
[1] [1]
$ echo blue >> color $ echo blue >> color
$ echo black >> color $ echo black >> color
$ hg add color $ hg add color
$ hg ci -m 0 $ hg ci -m 0
$ echo orange >> color $ echo orange >> color
$ hg ci -m 1 $ hg ci -m 1
$ echo black > color $ echo black > color
$ hg ci -m 2 $ hg ci -m 2
$ echo orange >> color $ echo orange >> color
$ echo blue >> color $ echo blue >> color
$ hg ci -m 3 $ hg ci -m 3
$ hg grep orange $ hg grep -r tip:0 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 $ hg grep --diff orange
color:3:+:orange color:3:+:orange
color:2:-:orange color:2:-:orange
color:1:+: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 -r tip:0 '^.' --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
$ $PYTHON -c 'fp = open("noeol", "wb"); fp.write(b"no infinite loop"); fp.close();' $ $PYTHON -c 'fp = open("noeol", "wb"); fp.write(b"no infinite loop"); fp.close();'
$ hg ci -Amnoeol $ hg ci -Amnoeol
adding noeol adding noeol
$ hg grep loop $ hg grep -r tip:0 loop
noeol:4:no infinite loop noeol:4:no infinite loop
$ cd .. $ cd ..
Issue685: traceback in grep -r after rename Issue685: traceback in grep -r after rename
Got a traceback when using grep on a single Got a traceback when using grep on a single
revision with renamed files. revision with renamed files.
$ hg init issue685 $ hg init issue685
$ cd issue685 $ cd issue685
$ echo octarine > color $ echo octarine > color
$ hg ci -Amcolor $ hg ci -Amcolor
adding color adding color
$ hg rename color colour $ hg rename color colour
$ hg ci -Am rename $ hg ci -Am rename
$ hg grep octarine $ hg grep -r tip:0 octarine
colour:1:octarine colour:1:octarine
color:0:octarine color:0:octarine
Used to crash here Used to crash here
$ hg grep -r 1 octarine $ hg grep -r 1 octarine
colour:1:octarine colour:1:octarine
$ cd .. $ cd ..
$ 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 ..
Change Default of grep, that is, the files not in current working directory
should not be grepp-ed on
$ hg init ab
$ cd ab
$ echo "some text">>file1
$ hg add file1
$ hg commit -m "adds file1"
$ hg mv file1 file2
$ hg grep "some"
file2:2147483647:some text