comparison mercurial/match.py @ 42087:2e2699af5649

match: let regex match function return a boolean

Match function for regex pattern kind is built through
_buildregexmatch() and _buildmatch() using _rematcher() that returns a
re.match function, which either returns a match object or None. This
does not conform to Mercurial's matcher interface for __call__() or
exact(), which are expected to return a boolean value. We fix this by
building a lambda around _rematcher() in _buildregexmatch().

Accordingly, we update doctest examples to remove bool() calls that are
now useless.

42086:1721b92f2b5e

    >>> m = match('foo', '', ['re:.*\.c$', 'relpath:a'])

    1. Calling the matcher with a file name returns True if any pattern
    matches that file name:
    >>> bool(m('a'))
    True
    >>> bool(m('main.c'))
    True
    >>> bool(m('test.py'))
    False

    2. Using the exact() method only returns True if the file name matches one
    of the exact patterns (i.e. not re: or glob: patterns):
    >>> m.exact('a')

    ...     ('path', 'foo/a', ''),
    ...     ('relpath', 'b', ''),
    ...     ('glob', '*.h', ''),
    ... ]
    >>> m = patternmatcher('foo', kindpats)
    >>> bool(m('main.c'))  # matches re:.*\.c$
    True
    >>> bool(m('b.txt'))
    False
    >>> bool(m('foo/a'))  # matches path:foo/a
    True
    >>> bool(m('a'))  # does not match path:b, since 'root' is 'foo'
    False
    >>> bool(m('b'))  # matches relpath:b, since 'root' is 'foo'
    True
    >>> bool(m('lib.h'))  # matches glob:*.h
    True

    >>> m.files()
    ['.', 'foo/a', 'b', '.']
    >>> m.exact('foo/a')

    The paths are remapped to remove/insert the path as needed:

    >>> from . import pycompat
    >>> m1 = match(b'root', b'', [b'a.txt', b'sub/b.txt'])
    >>> m2 = subdirmatcher(b'sub', m1)
    >>> bool(m2(b'a.txt'))
    False
    >>> bool(m2(b'b.txt'))
    True
    >>> bool(m2.matchfn(b'a.txt'))
    False
    >>> bool(m2.matchfn(b'b.txt'))
    True
    >>> m2.files()
    ['b.txt']
    >>> m2.exact(b'b.txt')
    True

    The prefix path should usually be the relative path from the root of
    this matcher to the root of the wrapped matcher.

    >>> m1 = match(util.localpath(b'root/d/e'), b'f', [b'../a.txt', b'b.txt'])
    >>> m2 = prefixdirmatcher(b'd/e', m1)
    >>> bool(m2(b'a.txt'),)
    False
    >>> bool(m2(b'd/e/a.txt'))
    True
    >>> bool(m2(b'd/e/b.txt'))
    False
    >>> m2.files()
    ['d/e/a.txt', 'd/e/f/b.txt']
    >>> m2.exact(b'd/e/a.txt')
    True

                startidx = idx
                groupsize = 0
            groupsize += piecesize + 1

        if startidx == 0:
            func = _rematcher(fullregexp)
        else:
            group = regexps[startidx:]
            allgroups.append(_joinregexes(group))
            allmatchers = [_rematcher(g) for g in allgroups]
            func = lambda s: any(m(s) for m in allmatchers)

42087:2e2699af5649

    >>> m = match('foo', '', ['re:.*\.c$', 'relpath:a'])

    1. Calling the matcher with a file name returns True if any pattern
    matches that file name:
    >>> m('a')
    True
    >>> m('main.c')
    True
    >>> m('test.py')
    False

    2. Using the exact() method only returns True if the file name matches one
    of the exact patterns (i.e. not re: or glob: patterns):
    >>> m.exact('a')

    ...     ('path', 'foo/a', ''),
    ...     ('relpath', 'b', ''),
    ...     ('glob', '*.h', ''),
    ... ]
    >>> m = patternmatcher('foo', kindpats)
    >>> m('main.c')  # matches re:.*\.c$
    True
    >>> m('b.txt')
    False
    >>> m('foo/a')  # matches path:foo/a
    True
    >>> m('a')  # does not match path:b, since 'root' is 'foo'
    False
    >>> m('b')  # matches relpath:b, since 'root' is 'foo'
    True
    >>> m('lib.h')  # matches glob:*.h
    True

    >>> m.files()
    ['.', 'foo/a', 'b', '.']
    >>> m.exact('foo/a')

    The paths are remapped to remove/insert the path as needed:

    >>> from . import pycompat
    >>> m1 = match(b'root', b'', [b'a.txt', b'sub/b.txt'])
    >>> m2 = subdirmatcher(b'sub', m1)
    >>> m2(b'a.txt')
    False
    >>> m2(b'b.txt')
    True
    >>> m2.matchfn(b'a.txt')
    False
    >>> m2.matchfn(b'b.txt')
    True
    >>> m2.files()
    ['b.txt']
    >>> m2.exact(b'b.txt')
    True

    The prefix path should usually be the relative path from the root of
    this matcher to the root of the wrapped matcher.

    >>> m1 = match(util.localpath(b'root/d/e'), b'f', [b'../a.txt', b'b.txt'])
    >>> m2 = prefixdirmatcher(b'd/e', m1)
    >>> m2(b'a.txt')
    False
    >>> m2(b'd/e/a.txt')
    True
    >>> m2(b'd/e/b.txt')
    False
    >>> m2.files()
    ['d/e/a.txt', 'd/e/f/b.txt']
    >>> m2.exact(b'd/e/a.txt')
    True

                startidx = idx
                groupsize = 0
            groupsize += piecesize + 1

        if startidx == 0:
            matcher = _rematcher(fullregexp)
            func = lambda s: matcher(s) is not None
        else:
            group = regexps[startidx:]
            allgroups.append(_joinregexes(group))
            allmatchers = [_rematcher(g) for g in allgroups]
            func = lambda s: any(m(s) for m in allmatchers)