view doc/docchecker @ 45898:4f6816e8440b

make: switch the PYTHON default to `py.exe -3` on Windows

Python3 _is_ named `python.exe` on Windows, but that isn't necessarily on PATH
when installing from python.org.  I do happen to have a python.exe on PATH in
`$LOCALAPPDATA/Microsoft/WindowsApps`, but it appears to be 0 bytes (likely
because of permission issues), and doesn't run:

    $ python -V
     - Cannot open

Pulkit hit the same error as I did though, so it isn't just my system:

    $ make -C . local
    make: Entering directory `/home/Dell/repos/hg-committed`
    python setup.py  \
              build_py -c -d . \
              build_ext  -i \
              build_hgexe  -i \
              build_mo
     - Cannot openmake: *** [local] Error 1

The `py.exe` dispatcher lives in the Windows directory (so it is on PATH), looks
up the python.org installation, and invokes that interpreter directly.  I get a
warning with py39, but if it's our issue, it was an existing one:

    $ make -C .. local
    make: Entering directory `/c/Users/Matt/hg'
    py -3 setup.py  \
              build_py -c -d . \
              build_ext  -i \
              build_hgexe  -i \
              build_mo
    C:\Users\Matt\AppData\Local\Programs\Python\Python39\lib\site-packages\setuptools\distutils_patch.py:25:
        UserWarning: Distutils was imported before Setuptools. This usage is discouraged and may
        exhibit undesirable behaviors or errors. Please use Setuptools' objects directly or at least
        import Setuptools first.
      warnings.warn(

The end result is a py3 based hg.exe that annoyingly won't run because it can't
find python39.dll.  It will run tests (the ones without the `python3` shbang
line anyway), because the test runner adjusts PATH to include the python running
it.

Differential Revision: https://phab.mercurial-scm.org/D9361

#!/usr/bin/env python3
#
# docchecker - look for problematic markup
#
# Copyright 2016 timeless <[e-mail]> and others
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.

from __future__ import absolute_import, print_function

import os
import re
import sys

try:
    import msvcrt

    msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
    msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)
except ImportError:
    pass

stdout = getattr(sys.stdout, 'buffer', sys.stdout)

leadingline = re.compile(br'(^\s*)(\S.*)$')

checks = [
    (
        br""":hg:`[^`]*'[^`]*`""",
        b"""warning: please avoid nesting ' in :hg:`...`""",
    ),
    (br'\w:hg:`', b'warning: please have a space before :hg:'),
    (
        br"""(?:[^a-z][^'.])hg ([^,;"`]*'(?!hg)){2}""",
        b'''warning: please use " instead of ' for hg ... "..."''',
    ),
]


def check(line):
    messages = []
    for match, msg in checks:
        if re.search(match, line):
            messages.append(msg)
    if messages:
        stdout.write(b'%s\n' % line)
        for msg in messages:
            stdout.write(b'%s\n' % msg)


def work(file):
    (llead, lline) = (b'', b'')

    for line in file:
        # this section unwraps lines
        match = leadingline.match(line)
        if not match:
            check(lline)
            (llead, lline) = (b'', b'')
            continue

        lead, line = match.group(1), match.group(2)
        if lead == llead:
            if lline != b'':
                lline += b' ' + line
            else:
                lline = line
        else:
            check(lline)
            (llead, lline) = (lead, line)
    check(lline)


def main():
    for f in sys.argv[1:]:
        try:
            with open(f, 'rb') as file:
                work(file)
        except BaseException as e:
            sys.stdout.write(r"failed to process %s: %s\n" % (f, e))


main()