annotate doc/check-seclevel.py @ 50338:81c7d04f4722 stable

match: match explicit file using a set

The matcher as all the logic to do quick comparison against explicit patterns,
however the pattern matcher was shadowing the code using that set and used the
compiled regex pattern in all cases, which is quite slow. We restore the usage
of the set based matching to boost performance.

Building the regexp is still consuming a large amount of time (actually, the
majority of the time), which is still silly. Maybe using re2 would help that,
but this is a quest for another adventure.

Another path to improve this is to have a pattern type dedicated to match the
exact path to a file only (not a directory). This pattern could use the set
matching only and be skipped in the regex all together.


Benchmarks
==========

In the following benchmark we are comparing the `hg cat` and `hg files` run
time when matching against all files in the repository. They are
run:
 - without the rust extensions
 - with the standard python engine (so without re2)


Performance improvement in this series
--------------------------------------

###### hg files ###############################################################
### mercurial-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:    0.230092 seconds
prev-changeset:    0.230069 seconds
this-changeset:    0.211425 seconds    (-8.36%)
### mercurial-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset:    0.234235 seconds
prev-changeset:    0.231165 seconds    (-1.38%)
this-changeset:    0.212300 seconds    (-9.43%)

### pypy-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:    0.613567 seconds
prev-changeset:    0.616799 seconds
this-changeset:    0.510852 seconds   (-16.82%)
### pypy-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset:    0.801880 seconds
prev-changeset:    0.616393 seconds   (-23.22%)
this-changeset:    0.511903 seconds   (-36.23%)

### netbeans-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:   21.541828 seconds
prev-changeset:   21.586773 seconds
this-changeset:   13.648347 seconds   (-36.76%)
### netbeans-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset:  172.759857 seconds
prev-changeset:   21.908197 seconds   (-87.32%)
this-changeset:   13.945110 seconds   (-91.93%)

### mozilla-central-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:   62.474221 seconds
prev-changeset:   61.279490 seconds    (-1.22%)
this-changeset:   29.529469 seconds   (-52.40%)
### mozilla-central-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset: 1364.180218 seconds
prev-changeset:   62.473549 seconds   (-95.40%)
this-changeset:   30.625249 seconds   (-97.75%)

###### hg cat #################################################################
### mercurial-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:    0.764407 seconds
prev-changeset:    0.763883 seconds
this-changeset:    0.737326 seconds    (-3.68%)
### mercurial-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset:    0.768924 seconds
prev-changeset:    0.765848 seconds
this-changeset:    0.174d0b seconds    (-4.44%)

### pypy-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:    2.065220 seconds
prev-changeset:    2.070498 seconds
this-changeset:    1.939482 seconds    (-6.08%)
### pypy-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset:    2.276388 seconds
prev-changeset:    2.069197 seconds    (-9.15%)
this-changeset:    1.931746 seconds   (-15.19%)

### netbeans-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:   40.967983 seconds
prev-changeset:   41.392423 seconds
this-changeset:   32.181681 seconds   (-22.20%)
### netbeans-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset:  216.388709 seconds
prev-changeset:   41.648689 seconds   (-80.88%)
this-changeset:   32.580817 seconds   (-85.04%)

### mozilla-central-2018-08-01-zstd-sparse-revlog ### sorted
base-changeset:  105.228510 seconds
prev-changeset:  103.315670 seconds    (-1.23%)
this-changeset:   69.416118 seconds   (-33.64%)
### mozilla-central-2018-08-01-zstd-sparse-revlog ### shuffled
base-changeset: 1448.722784 seconds
prev-changeset:  104.369358 seconds   (-92.80%)
this-changeset:   70.554789 seconds   (-95.13%)

Different way to list the same data with this revision
------------------------------------------------------

###### hg files ###############################################################
### mercurial-2018-08-01-zstd-sparse-revlog
root:            0.119182 seconds
glob:            0.120697 seconds    (+1.27%)
sorted:          0.211425 seconds   (+77.40%)
shuffled:        0.212300 seconds   (+78.13%)
### pypy-2018-08-01-zstd-sparse-revlog
root:            0.121986 seconds
glob:            0.124822 seconds    (+2.32%)
sorted:          0.510852 seconds  (+318.78%)
shuffled:        0.511903 seconds  (+319.64%)
### netbeans-2018-08-01-zstd-sparse-revlog
root:            0.173984 seconds
glob:            0.227203 seconds   (+30.59%)
sorted:         13.648347 seconds (+7744.59%)
shuffled:       13.945110 seconds (+7915.16%)
### mozilla-central-2018-08-01-zstd-sparse-revlog
root:            0.366463 seconds
glob:            0.491030 seconds   (+33.99%)
sorted:         29.529469 seconds (+7957.96%)
shuffled:       30.625249 seconds (+8256.97%)

###### hg cat #################################################################
### mercurial-2018-08-01-zstd-sparse-revlog
glob:            0.647471 seconds
root:            0.643120 seconds
shuffled:        0.174d0b seconds   (+13.92%)
sorted:          0.737326 seconds   (+13.88%)
### mozilla-central-2018-08-01-zstd-sparse-revlog
glob:           40.596983 seconds
root:           40.129136 seconds
shuffled:       70.554789 seconds   (+73.79%)
sorted:         69.416118 seconds   (+70.99%)
### netbeans-2018-08-01-zstd-sparse-revlog
glob:           18.777924 seconds
root:           18.613905 seconds
shuffled:       32.580817 seconds   (+73.51%)
sorted:         32.181681 seconds   (+71.38%)
### pypy-2018-08-01-zstd-sparse-revlog
glob:            1.555319 seconds
root:            1.536534 seconds
shuffled:        1.931746 seconds   (+24.20%)
sorted:          1.939482 seconds   (+24.70%)

#!/usr/bin/env python3
#
# checkseclevel - checking section title levels in each online help document


import optparse
import os
import sys

# import from the live mercurial repo
os.environ['HGMODULEPOLICY'] = 'py'
sys.path.insert(0, os.path.abspath(".."))
from mercurial import demandimport

demandimport.enable()
from mercurial import (
    commands,
    extensions,
    help,
    minirst,
    ui as uimod,
)

table = commands.table
helptable = help.helptable

level2mark = [b'"', b'=', b'-', b'.', b'#']
reservedmarks = [b'"']

mark2level = {}
for m, l in zip(level2mark, range(len(level2mark))):
    if m not in reservedmarks:
        mark2level[m] = l

initlevel_topic = 0
initlevel_cmd = 1
initlevel_ext = 1
initlevel_ext_cmd = 3


def showavailables(ui, initlevel):
    avail = '    available marks and order of them in this help: %s\n' % (
        ', '.join(['%r' % (m * 4) for m in level2mark[initlevel + 1 :]])
    )
    ui.warn(avail.encode('utf-8'))


def checkseclevel(ui, doc, name, initlevel):
    ui.notenoi18n(('checking "%s"\n' % name).encode('utf-8'))
    if not isinstance(doc, bytes):
        doc = doc.encode('utf-8')
    blocks, pruned = minirst.parse(doc, 0, ['verbose'])
    errorcnt = 0
    curlevel = initlevel
    for block in blocks:
        if block[b'type'] != b'section':
            continue
        mark = block[b'underline']
        title = block[b'lines'][0]
        if (mark not in mark2level) or (mark2level[mark] <= initlevel):
            ui.warn(
                (
                    'invalid section mark %r for "%s" of %s\n'
                    % (mark * 4, title, name)
                ).encode('utf-8')
            )
            showavailables(ui, initlevel)
            errorcnt += 1
            continue
        nextlevel = mark2level[mark]
        if curlevel < nextlevel and curlevel + 1 != nextlevel:
            ui.warnnoi18n(
                ('gap of section level at "%s" of %s\n' % (title, name)).encode(
                    'utf-8'
                )
            )
            showavailables(ui, initlevel)
            errorcnt += 1
            continue
        ui.notenoi18n(
            (
                'appropriate section level for "%s %s"\n'
                % (mark * (nextlevel * 2), title)
            ).encode('utf-8')
        )
        curlevel = nextlevel

    return errorcnt


def checkcmdtable(ui, cmdtable, namefmt, initlevel):
    errorcnt = 0
    for k, entry in cmdtable.items():
        name = k.split(b"|")[0].lstrip(b"^")
        if not entry[0].__doc__:
            ui.notenoi18n(
                (
                    'skip checking %s: no help document\n' % (namefmt % name)
                ).encode('utf-8')
            )
            continue
        errorcnt += checkseclevel(
            ui, entry[0].__doc__, namefmt % name, initlevel
        )
    return errorcnt


def checkhghelps(ui):
    errorcnt = 0
    for h in helptable:
        names, sec, doc = h[0:3]
        if callable(doc):
            doc = doc(ui)
        errorcnt += checkseclevel(
            ui, doc, '%s help topic' % names[0], initlevel_topic
        )

    errorcnt += checkcmdtable(ui, table, '%s command', initlevel_cmd)

    for name in sorted(
        list(extensions.enabled()) + list(extensions.disabled())
    ):
        mod = extensions.load(ui, name, None)
        if not mod.__doc__:
            ui.notenoi18n(
                (
                    'skip checking %s extension: no help document\n' % name
                ).encode('utf-8')
            )
            continue
        errorcnt += checkseclevel(
            ui, mod.__doc__, '%s extension' % name, initlevel_ext
        )

        cmdtable = getattr(mod, 'cmdtable', None)
        if cmdtable:
            errorcnt += checkcmdtable(
                ui,
                cmdtable,
                '%%s command of %s extension' % name,
                initlevel_ext_cmd,
            )
    return errorcnt


def checkfile(ui, filename, initlevel):
    if filename == '-':
        filename = 'stdin'
        doc = sys.stdin.read()
    else:
        with open(filename) as fp:
            doc = fp.read()

    ui.notenoi18n(
        (
            'checking input from %s with initlevel %d\n' % (filename, initlevel)
        ).encode('utf-8')
    )
    return checkseclevel(ui, doc, 'input from %s' % filename, initlevel)


def main():
    optparser = optparse.OptionParser(
        """%prog [options]

This checks all help documents of Mercurial (topics, commands,
extensions and commands of them), if no file is specified by --file
option.
"""
    )
    optparser.add_option(
        "-v", "--verbose", help="enable additional output", action="store_true"
    )
    optparser.add_option(
        "-d", "--debug", help="debug mode", action="store_true"
    )
    optparser.add_option(
        "-f",
        "--file",
        help="filename to read in (or '-' for stdin)",
        action="store",
        default="",
    )

    optparser.add_option(
        "-t",
        "--topic",
        help="parse file as help topic",
        action="store_const",
        dest="initlevel",
        const=0,
    )
    optparser.add_option(
        "-c",
        "--command",
        help="parse file as help of core command",
        action="store_const",
        dest="initlevel",
        const=1,
    )
    optparser.add_option(
        "-e",
        "--extension",
        help="parse file as help of extension",
        action="store_const",
        dest="initlevel",
        const=1,
    )
    optparser.add_option(
        "-C",
        "--extension-command",
        help="parse file as help of extension command",
        action="store_const",
        dest="initlevel",
        const=3,
    )

    optparser.add_option(
        "-l",
        "--initlevel",
        help="set initial section level manually",
        action="store",
        type="int",
        default=0,
    )

    (options, args) = optparser.parse_args()

    ui = uimod.ui.load()
    ui.setconfig(b'ui', b'verbose', options.verbose, b'--verbose')
    ui.setconfig(b'ui', b'debug', options.debug, b'--debug')

    if options.file:
        if checkfile(ui, options.file, options.initlevel):
            sys.exit(1)
    else:
        if checkhghelps(ui):
            sys.exit(1)


if __name__ == "__main__":
    main()