Add -p to repo forall to improve output formatting

When trying to read log output from many projects at once it can
be difficult to make sense of which messages came from where.

For many professional developers it is common to want to view the
last week's worth of your work, so you can write a weekly summary
of your activity for your status report.

This is easier with the new -p option:

  repo forall -pc git log --reverse --since=1.week.ago --author=sop

produces a report of all commits written by me in the last week,
formatted in a paged output display, with headers inserted in
front of each project's output.

Where this can be even more useful is with git log's pickaxe,
e.g. now we can use:

  repo forall -pc git log -Sbar v1.0..v1.1

to locate all additions or removals of the symbol 'bar' since v1.0,
up to and including v1.1.  Before displaying the matching commits in
a project, a project header is shown, giving the user some context
information for the matching results.

Signed-off-by: Shawn O. Pearce <sop@google.com>
This commit is contained in:
Shawn O. Pearce 2009-04-18 13:49:13 -07:00
parent 50fa1ac6db
commit db45da1208
4 changed files with 151 additions and 5 deletions

View File

@ -110,6 +110,9 @@ class Coloring(object):
def write(self, fmt, *args): def write(self, fmt, *args):
self._out.write(fmt % args) self._out.write(fmt % args)
def flush(self):
self._out.flush()
def nl(self): def nl(self):
self._out.write('\n') self._out.write('\n')

View File

@ -27,6 +27,9 @@ class Command(object):
manifest = None manifest = None
_optparse = None _optparse = None
def WantPager(self, opt):
return False
@property @property
def OptionParser(self): def OptionParser(self):
if self._optparse is None: if self._optparse is None:
@ -109,11 +112,15 @@ class InteractiveCommand(Command):
"""Command which requires user interaction on the tty and """Command which requires user interaction on the tty and
must not run within a pager, even if the user asks to. must not run within a pager, even if the user asks to.
""" """
def WantPager(self, opt):
return False
class PagedCommand(Command): class PagedCommand(Command):
"""Command which defaults to output in a pager, as its """Command which defaults to output in a pager, as its
display tends to be larger than one screen full. display tends to be larger than one screen full.
""" """
def WantPager(self, opt):
return True
class MirrorSafeCommand(object): class MirrorSafeCommand(object):
"""Command permits itself to run within a mirror, """Command permits itself to run within a mirror,

View File

@ -105,6 +105,8 @@ class _Repo(object):
% name % name
sys.exit(1) sys.exit(1)
copts, cargs = cmd.OptionParser.parse_args(argv)
if not gopts.no_pager and not isinstance(cmd, InteractiveCommand): if not gopts.no_pager and not isinstance(cmd, InteractiveCommand):
config = cmd.manifest.globalConfig config = cmd.manifest.globalConfig
if gopts.pager: if gopts.pager:
@ -112,11 +114,10 @@ class _Repo(object):
else: else:
use_pager = config.GetBoolean('pager.%s' % name) use_pager = config.GetBoolean('pager.%s' % name)
if use_pager is None: if use_pager is None:
use_pager = isinstance(cmd, PagedCommand) use_pager = cmd.WantPager(copts)
if use_pager: if use_pager:
RunPager(config) RunPager(config)
copts, cargs = cmd.OptionParser.parse_args(argv)
try: try:
cmd.Execute(copts, cargs) cmd.Execute(copts, cargs)
except ManifestInvalidRevisionError, e: except ManifestInvalidRevisionError, e:

View File

@ -13,12 +13,29 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
import fcntl
import re import re
import os import os
import select
import sys import sys
import subprocess import subprocess
from color import Coloring
from command import Command, MirrorSafeCommand from command import Command, MirrorSafeCommand
_CAN_COLOR = [
'branch',
'diff',
'grep',
'log',
]
class ForallColoring(Coloring):
def __init__(self, config):
Coloring.__init__(self, config, 'forall')
self.project = self.printer('project', attr='bold')
class Forall(Command, MirrorSafeCommand): class Forall(Command, MirrorSafeCommand):
common = False common = False
helpSummary = "Run a shell command in each project" helpSummary = "Run a shell command in each project"
@ -28,6 +45,24 @@ class Forall(Command, MirrorSafeCommand):
helpDescription = """ helpDescription = """
Executes the same shell command in each project. Executes the same shell command in each project.
Output Formatting
-----------------
The -p option causes '%prog' to bind pipes to the command's stdin,
stdout and stderr streams, and pipe all output into a continuous
stream that is displayed in a single pager session. Project headings
are inserted before the output of each command is displayed. If the
command produces no output in a project, no heading is displayed.
The formatting convention used by -p is very suitable for some
types of searching, e.g. `repo forall -p -c git log -SFoo` will
print all commits that add or remove references to Foo.
The -v option causes '%prog' to display stderr messages if a
command produces output only on stderr. Normally the -p option
causes command output to be suppressed until the command produces
at least one byte of output on stdout.
Environment Environment
----------- -----------
@ -50,8 +85,8 @@ as written in the manifest.
shell positional arguments ($1, $2, .., $#) are set to any arguments shell positional arguments ($1, $2, .., $#) are set to any arguments
following <command>. following <command>.
stdin, stdout, stderr are inherited from the terminal and are Unless -p is used, stdin, stdout, stderr are inherited from the
not redirected. terminal and are not redirected.
""" """
def _Options(self, p): def _Options(self, p):
@ -65,6 +100,17 @@ not redirected.
action='callback', action='callback',
callback=cmd) callback=cmd)
g = p.add_option_group('Output')
g.add_option('-p',
dest='project_header', action='store_true',
help='Show project headers before output')
g.add_option('-v', '--verbose',
dest='verbose', action='store_true',
help='Show command error messages')
def WantPager(self, opt):
return opt.project_header
def Execute(self, opt, args): def Execute(self, opt, args):
if not opt.command: if not opt.command:
self.Usage() self.Usage()
@ -79,8 +125,31 @@ not redirected.
cmd.append(cmd[0]) cmd.append(cmd[0])
cmd.extend(opt.command[1:]) cmd.extend(opt.command[1:])
if opt.project_header \
and not shell \
and cmd[0] == 'git':
# If this is a direct git command that can enable colorized
# output and the user prefers coloring, add --color into the
# command line because we are going to wrap the command into
# a pipe and git won't know coloring should activate.
#
for cn in cmd[1:]:
if not cn.startswith('-'):
break
if cn in _CAN_COLOR:
class ColorCmd(Coloring):
def __init__(self, config, cmd):
Coloring.__init__(self, config, cmd)
if ColorCmd(self.manifest.manifestProject.config, cn).is_on:
cmd.insert(cmd.index(cn) + 1, '--color')
mirror = self.manifest.IsMirror mirror = self.manifest.IsMirror
out = ForallColoring(self.manifest.manifestProject.config)
out.redirect(sys.stderr)
rc = 0 rc = 0
first = True
for project in self.GetProjects(args): for project in self.GetProjects(args):
env = dict(os.environ.iteritems()) env = dict(os.environ.iteritems())
def setenv(name, val): def setenv(name, val):
@ -102,10 +171,76 @@ not redirected.
else: else:
cwd = project.worktree cwd = project.worktree
if opt.project_header:
stdin = subprocess.PIPE
stdout = subprocess.PIPE
stderr = subprocess.PIPE
else:
stdin = None
stdout = None
stderr = None
p = subprocess.Popen(cmd, p = subprocess.Popen(cmd,
cwd = cwd, cwd = cwd,
shell = shell, shell = shell,
env = env) env = env,
stdin = stdin,
stdout = stdout,
stderr = stderr)
if opt.project_header:
class sfd(object):
def __init__(self, fd, dest):
self.fd = fd
self.dest = dest
def fileno(self):
return self.fd.fileno()
empty = True
didout = False
errbuf = ''
p.stdin.close()
s_in = [sfd(p.stdout, sys.stdout),
sfd(p.stderr, sys.stderr)]
for s in s_in:
flags = fcntl.fcntl(s.fd, fcntl.F_GETFL)
fcntl.fcntl(s.fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
while s_in:
in_ready, out_ready, err_ready = select.select(s_in, [], [])
for s in in_ready:
buf = s.fd.read(4096)
if not buf:
s.fd.close()
s_in.remove(s)
continue
if not opt.verbose:
if s.fd == p.stdout:
didout = True
else:
errbuf += buf
continue
if empty:
if first:
first = False
else:
out.nl()
out.project('project %s/', project.relpath)
out.nl()
out.flush()
if errbuf:
sys.stderr.write(errbuf)
sys.stderr.flush()
errbuf = ''
empty = False
s.dest.write(buf)
s.dest.flush()
r = p.wait() r = p.wait()
if r != 0 and r != rc: if r != 0 and r != rc:
rc = r rc = r