Merge lp:~jelmer/bzr-grep/lazy into lp:bzr-grep

[Jelmer Vernooij]

This moves the actual command implementation to a separate file.

It shaves some (limited) time off the bzr startup time.

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 2/19/2011 6:39 PM, Jelmer Vernooij wrote:
> Jelmer Vernooij has proposed merging lp:~jelmer/bzr-grep/lazy into lp:bzr-grep.
>
> Requested reviews:
> Bazaar Developers (bzr)
>
> For more details, see:
> https://code.launchpad.net/~jelmer/bzr-grep/lazy/+merge/50489
>
> This moves the actual command implementation to a separate file.
>
> It shaves some (limited) time off the bzr startup time.

 merge: approve

John
=:->
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk1mlmAACgkQJdeBCYSNAANz3wCeJ9WBF1fIA4FO6F6XiS2MR8qm
QRcAn3zX/97+dZE/VOC0F3nj0AGSOiIn
=rohz
-----END PGP SIGNATURE-----

review: Approve

[lp:~jelmer/bzr-grep/lazy]

143. By Jelmer Vernooij on 2011-02-24

Merge lazy loading of command implementation.

=== modified file '__init__.py'
--- __init__.py	2010-06-26 02:34:08 +0000
+++ __init__.py	2011-02-20 00:38:52 +0000
@@ -13,249 +13,16 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
 """Print lines matching PATTERN for specified files and revisions."""
 
-import os
-import sys
-
-from bzrlib import errors
-from bzrlib.commands import Command, register_command, display_command
-from bzrlib.option import Option, ListOption
-
-from bzrlib.lazy_import import lazy_import
-lazy_import(globals(), """
-import re
-
-from termcolor import allow_color
-import grep
-
-import bzrlib
-from bzrlib.revisionspec import RevisionSpec
-from bzrlib import (
-    osutils,
-    bzrdir,
-    trace,
-    )
-""")
+from bzrlib.commands import plugin_cmds
+
 import version
 
 version_info = version.version_info
 
-# FIXME: _parse_levels should be shared with bzrlib.builtins. this is a copy
-# to avoid the error
-#   "IllegalUseOfScopeReplacer: ScopeReplacer object '_parse_levels' was used
-#   incorrectly: Object already cleaned up, did you assign it to another
-#   variable?: _factory
-# with lazy import
-def _parse_levels(s):
-    try:
-        return int(s)
-    except ValueError:
-        msg = "The levels argument must be an integer."
-        raise errors.BzrCommandError(msg)
-
-
-class GrepOptions(object):
-    """Container to pass around grep options.
-
-    This class is used as a container to pass around user option and
-    some other params (like outf) to processing functions. This makes
-    it easier to add more options as grep evolves.
-    """
-    verbose = False
-    ignore_case = False
-    no_recursive = False
-    from_root = False
-    null = False
-    levels = None
-    line_number = False
-    path_list = None
-    revision = None
-    pattern = None
-    include = None
-    exclude = None
-    fixed_string = False
-    files_with_matches = False
-    files_without_match = False
-    color = None
-    diff = False
-
-    # derived options
-    recursive = None
-    eol_marker = None
-    patternc = None
-    sub_patternc = None
-    print_revno = None
-    fixed_string = None
-    outf = None
-    show_color = False
-
-
-class cmd_grep(Command):
-    """Print lines matching PATTERN for specified files and revisions.
-
-    This command searches the specified files and revisions for a given
-    pattern.  The pattern is specified as a Python regular expressions[1].
-
-    If the file name is not specified, the revisions starting with the
-    current directory are searched recursively. If the revision number is
-    not specified, the working copy is searched. To search the last committed
-    revision, use the '-r -1' or '-r last:1' option.
-
-    Unversioned files are not searched unless explicitly specified on the
-    command line. Unversioned directores are not searched.
-
-    When searching a pattern, the output is shown in the 'filepath:string'
-    format. If a revision is explicitly searched, the output is shown as
-    'filepath~N:string', where N is the revision number.
-
-    --include and --exclude options can be used to search only (or exclude
-    from search) files with base name matches the specified Unix style GLOB
-    pattern.  The GLOB pattern an use *, ?, and [...] as wildcards, and \\
-    to quote wildcard or backslash character literally. Note that the glob
-    pattern is not a regular expression.
-
-    [1] http://docs.python.org/library/re.html#regular-expression-syntax
-    """
-
-    encoding_type = 'replace'
-    takes_args = ['pattern', 'path*']
-    takes_options = [
-        'verbose',
-        'revision',
-        Option('color', type=str, argname='when',
-               help='Show match in color. WHEN is never, always or auto.'),
-        Option('diff', short_name='p',
-               help='Grep for pattern in changeset for each revision.'),
-        ListOption('exclude', type=str, argname='glob', short_name='X',
-            help="Skip files whose base name matches GLOB."),
-        ListOption('include', type=str, argname='glob', short_name='I',
-            help="Search only files whose base name matches GLOB."),
-        Option('files-with-matches', short_name='l',
-               help='Print only the name of each input file in '
-               'which PATTERN is found.'),
-        Option('files-without-match', short_name='L',
-               help='Print only the name of each input file in '
-               'which PATTERN is not found.'),
-        Option('fixed-string', short_name='F',
-               help='Interpret PATTERN is a single fixed string (not regex).'),
-        Option('from-root',
-               help='Search for pattern starting from the root of the branch. '
-               '(implies --recursive)'),
-        Option('ignore-case', short_name='i',
-               help='ignore case distinctions while matching.'),
-        Option('levels',
-           help='Number of levels to display - 0 for all, 1 for collapsed '
-           '(1 is default).',
-           argname='N',
-           type=_parse_levels),
-        Option('line-number', short_name='n',
-               help='show 1-based line number.'),
-        Option('no-recursive',
-               help="Don't recurse into subdirectories. (default is --recursive)"),
-        Option('null', short_name='Z',
-               help='Write an ASCII NUL (\\0) separator '
-               'between output lines rather than a newline.'),
-        ]
-
-
-    @display_command
-    def run(self, verbose=False, ignore_case=False, no_recursive=False,
-            from_root=False, null=False, levels=None, line_number=False,
-            path_list=None, revision=None, pattern=None, include=None,
-            exclude=None, fixed_string=False, files_with_matches=False,
-            files_without_match=False, color='never', diff=False):
-
-        if path_list == None:
-            path_list = ['.']
-        else:
-            if from_root:
-                raise errors.BzrCommandError('cannot specify both --from-root and PATH.')
-
-        if files_with_matches and files_without_match:
-            raise errors.BzrCommandError('cannot specify both '
-                '-l/--files-with-matches and -L/--files-without-matches.')
-
-        if color not in ['always', 'never', 'auto']:
-            raise errors.BzrCommandError('Valid values for --color are '
-                '"always", "never" or "auto".')
-
-        if levels==None:
-            levels=1
-
-        print_revno = False
-        if revision != None or levels == 0:
-            # print revision numbers as we may be showing multiple revisions
-            print_revno = True
-
-        eol_marker = '\n'
-        if null:
-            eol_marker = '\0'
-
-        if not ignore_case and grep.is_fixed_string(pattern):
-            # if the pattern isalnum, implicitly use to -F for faster grep
-            fixed_string = True
-        elif ignore_case and fixed_string:
-            # GZ 2010-06-02: Fall back to regexp rather than lowercasing
-            #                pattern and text which will cause pain later
-            fixed_string = False
-            pattern = re.escape(pattern)
-
-        patternc = None
-        re_flags = re.MULTILINE
-        if ignore_case:
-            re_flags |= re.IGNORECASE
-
-        if not fixed_string:
-            patternc = grep.compile_pattern(pattern, re_flags)
-
-        if color == 'always':
-            show_color = True
-        elif color == 'never':
-            show_color = False
-        elif color == 'auto':
-            show_color = allow_color()
-
-        GrepOptions.verbose = verbose
-        GrepOptions.ignore_case = ignore_case
-        GrepOptions.no_recursive = no_recursive
-        GrepOptions.from_root = from_root
-        GrepOptions.null = null
-        GrepOptions.levels = levels
-        GrepOptions.line_number = line_number
-        GrepOptions.path_list = path_list
-        GrepOptions.revision = revision
-        GrepOptions.pattern = pattern
-        GrepOptions.include = include
-        GrepOptions.exclude = exclude
-        GrepOptions.fixed_string = fixed_string
-        GrepOptions.files_with_matches = files_with_matches
-        GrepOptions.files_without_match = files_without_match
-        GrepOptions.color = color
-        GrepOptions.diff = False
-
-        GrepOptions.eol_marker = eol_marker
-        GrepOptions.print_revno = print_revno
-        GrepOptions.patternc = patternc
-        GrepOptions.recursive = not no_recursive
-        GrepOptions.fixed_string = fixed_string
-        GrepOptions.outf = self.outf
-        GrepOptions.show_color = show_color
-
-        if diff == True:
-            # options not used:
-            # files_with_matches, files_without_match
-            # levels(?), line_number, from_root
-            # include, exclude
-            # These are silently ignored.
-            grep.grep_diff(GrepOptions)
-        elif revision == None:
-            grep.workingtree_grep(GrepOptions)
-        else:
-            grep.versioned_grep(GrepOptions)
-
-
-register_command(cmd_grep)
+plugin_cmds.register_lazy("cmd_grep", [], "bzrlib.plugins.grep.cmds")
 
 def test_suite():
     from bzrlib.tests import TestUtil

=== added file 'cmds.py'
--- cmds.py	1970-01-01 00:00:00 +0000
+++ cmds.py	2011-02-20 00:38:52 +0000
@@ -0,0 +1,238 @@
+# Copyright (C) 2010 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+"""Print lines matching PATTERN for specified files and revisions."""
+
+from bzrlib import errors
+from bzrlib.commands import Command, display_command
+from bzrlib.option import Option, ListOption
+
+# FIXME: _parse_levels should be shared with bzrlib.builtins. this is a copy
+# to avoid the error
+#   "IllegalUseOfScopeReplacer: ScopeReplacer object '_parse_levels' was used
+#   incorrectly: Object already cleaned up, did you assign it to another
+#   variable?: _factory
+# with lazy import
+def _parse_levels(s):
+    try:
+        return int(s)
+    except ValueError:
+        msg = "The levels argument must be an integer."
+        raise errors.BzrCommandError(msg)
+
+
+class GrepOptions(object):
+    """Container to pass around grep options.
+
+    This class is used as a container to pass around user option and
+    some other params (like outf) to processing functions. This makes
+    it easier to add more options as grep evolves.
+    """
+    verbose = False
+    ignore_case = False
+    no_recursive = False
+    from_root = False
+    null = False
+    levels = None
+    line_number = False
+    path_list = None
+    revision = None
+    pattern = None
+    include = None
+    exclude = None
+    fixed_string = False
+    files_with_matches = False
+    files_without_match = False
+    color = None
+    diff = False
+
+    # derived options
+    recursive = None
+    eol_marker = None
+    patternc = None
+    sub_patternc = None
+    print_revno = None
+    fixed_string = None
+    outf = None
+    show_color = False
+
+
+class cmd_grep(Command):
+    """Print lines matching PATTERN for specified files and revisions.
+
+    This command searches the specified files and revisions for a given
+    pattern.  The pattern is specified as a Python regular expressions[1].
+
+    If the file name is not specified, the revisions starting with the
+    current directory are searched recursively. If the revision number is
+    not specified, the working copy is searched. To search the last committed
+    revision, use the '-r -1' or '-r last:1' option.
+
+    Unversioned files are not searched unless explicitly specified on the
+    command line. Unversioned directores are not searched.
+
+    When searching a pattern, the output is shown in the 'filepath:string'
+    format. If a revision is explicitly searched, the output is shown as
+    'filepath~N:string', where N is the revision number.
+
+    --include and --exclude options can be used to search only (or exclude
+    from search) files with base name matches the specified Unix style GLOB
+    pattern.  The GLOB pattern an use *, ?, and [...] as wildcards, and \\
+    to quote wildcard or backslash character literally. Note that the glob
+    pattern is not a regular expression.
+
+    [1] http://docs.python.org/library/re.html#regular-expression-syntax
+    """
+
+    encoding_type = 'replace'
+    takes_args = ['pattern', 'path*']
+    takes_options = [
+        'verbose',
+        'revision',
+        Option('color', type=str, argname='when',
+               help='Show match in color. WHEN is never, always or auto.'),
+        Option('diff', short_name='p',
+               help='Grep for pattern in changeset for each revision.'),
+        ListOption('exclude', type=str, argname='glob', short_name='X',
+            help="Skip files whose base name matches GLOB."),
+        ListOption('include', type=str, argname='glob', short_name='I',
+            help="Search only files whose base name matches GLOB."),
+        Option('files-with-matches', short_name='l',
+               help='Print only the name of each input file in '
+               'which PATTERN is found.'),
+        Option('files-without-match', short_name='L',
+               help='Print only the name of each input file in '
+               'which PATTERN is not found.'),
+        Option('fixed-string', short_name='F',
+               help='Interpret PATTERN is a single fixed string (not regex).'),
+        Option('from-root',
+               help='Search for pattern starting from the root of the branch. '
+               '(implies --recursive)'),
+        Option('ignore-case', short_name='i',
+               help='ignore case distinctions while matching.'),
+        Option('levels',
+           help='Number of levels to display - 0 for all, 1 for collapsed '
+           '(1 is default).',
+           argname='N',
+           type=_parse_levels),
+        Option('line-number', short_name='n',
+               help='show 1-based line number.'),
+        Option('no-recursive',
+               help="Don't recurse into subdirectories. (default is --recursive)"),
+        Option('null', short_name='Z',
+               help='Write an ASCII NUL (\\0) separator '
+               'between output lines rather than a newline.'),
+        ]
+
+
+    @display_command
+    def run(self, verbose=False, ignore_case=False, no_recursive=False,
+            from_root=False, null=False, levels=None, line_number=False,
+            path_list=None, revision=None, pattern=None, include=None,
+            exclude=None, fixed_string=False, files_with_matches=False,
+            files_without_match=False, color='never', diff=False):
+        from bzrlib.plugins.grep import (
+            grep,
+            termcolor,
+            )
+        import re
+        if path_list == None:
+            path_list = ['.']
+        else:
+            if from_root:
+                raise errors.BzrCommandError('cannot specify both --from-root and PATH.')
+
+        if files_with_matches and files_without_match:
+            raise errors.BzrCommandError('cannot specify both '
+                '-l/--files-with-matches and -L/--files-without-matches.')
+
+        if color not in ['always', 'never', 'auto']:
+            raise errors.BzrCommandError('Valid values for --color are '
+                '"always", "never" or "auto".')
+
+        if levels==None:
+            levels=1
+
+        print_revno = False
+        if revision != None or levels == 0:
+            # print revision numbers as we may be showing multiple revisions
+            print_revno = True
+
+        eol_marker = '\n'
+        if null:
+            eol_marker = '\0'
+
+        if not ignore_case and grep.is_fixed_string(pattern):
+            # if the pattern isalnum, implicitly use to -F for faster grep
+            fixed_string = True
+        elif ignore_case and fixed_string:
+            # GZ 2010-06-02: Fall back to regexp rather than lowercasing
+            #                pattern and text which will cause pain later
+            fixed_string = False
+            pattern = re.escape(pattern)
+
+        patternc = None
+        re_flags = re.MULTILINE
+        if ignore_case:
+            re_flags |= re.IGNORECASE
+
+        if not fixed_string:
+            patternc = grep.compile_pattern(pattern, re_flags)
+
+        if color == 'always':
+            show_color = True
+        elif color == 'never':
+            show_color = False
+        elif color == 'auto':
+            show_color = termcolor.allow_color()
+
+        GrepOptions.verbose = verbose
+        GrepOptions.ignore_case = ignore_case
+        GrepOptions.no_recursive = no_recursive
+        GrepOptions.from_root = from_root
+        GrepOptions.null = null
+        GrepOptions.levels = levels
+        GrepOptions.line_number = line_number
+        GrepOptions.path_list = path_list
+        GrepOptions.revision = revision
+        GrepOptions.pattern = pattern
+        GrepOptions.include = include
+        GrepOptions.exclude = exclude
+        GrepOptions.fixed_string = fixed_string
+        GrepOptions.files_with_matches = files_with_matches
+        GrepOptions.files_without_match = files_without_match
+        GrepOptions.color = color
+        GrepOptions.diff = False
+
+        GrepOptions.eol_marker = eol_marker
+        GrepOptions.print_revno = print_revno
+        GrepOptions.patternc = patternc
+        GrepOptions.recursive = not no_recursive
+        GrepOptions.fixed_string = fixed_string
+        GrepOptions.outf = self.outf
+        GrepOptions.show_color = show_color
+
+        if diff == True:
+            # options not used:
+            # files_with_matches, files_without_match
+            # levels(?), line_number, from_root
+            # include, exclude
+            # These are silently ignored.
+            grep.grep_diff(GrepOptions)
+        elif revision == None:
+            grep.workingtree_grep(GrepOptions)
+        else:
+            grep.versioned_grep(GrepOptions)