EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Tools / scripts / patchcheck.py

import re\r
import sys\r
import shutil\r
import os.path\r
import subprocess\r
\r
import reindent\r
import untabify\r
\r
\r
def n_files_str(count):\r
    """Return 'N file(s)' with the proper plurality on 'file'."""\r
    return "{} file{}".format(count, "s" if count != 1 else "")\r
\r
\r
def status(message, modal=False, info=None):\r
    """Decorator to output status info to stdout."""\r
    def decorated_fxn(fxn):\r
        def call_fxn(*args, **kwargs):\r
            sys.stdout.write(message + ' ... ')\r
            sys.stdout.flush()\r
            result = fxn(*args, **kwargs)\r
            if not modal and not info:\r
                print "done"\r
            elif info:\r
                print info(result)\r
            else:\r
                print "yes" if result else "NO"\r
            return result\r
        return call_fxn\r
    return decorated_fxn\r
\r
\r
@status("Getting the list of files that have been added/changed",\r
        info=lambda x: n_files_str(len(x)))\r
def changed_files():\r
    """Get the list of changed or added files from the VCS."""\r
    if os.path.isdir('.hg'):\r
        vcs = 'hg'\r
        cmd = 'hg status --added --modified --no-status'\r
    elif os.path.isdir('.svn'):\r
        vcs = 'svn'\r
        cmd = 'svn status --quiet --non-interactive --ignore-externals'\r
    else:\r
        sys.exit('need a checkout to get modified files')\r
\r
    st = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)\r
    try:\r
        st.wait()\r
        if vcs == 'hg':\r
            return [x.decode().rstrip() for x in st.stdout]\r
        else:\r
            output = (x.decode().rstrip().rsplit(None, 1)[-1]\r
                      for x in st.stdout if x[0] in 'AM')\r
        return set(path for path in output if os.path.isfile(path))\r
    finally:\r
        st.stdout.close()\r
\r
\r
def report_modified_files(file_paths):\r
    count = len(file_paths)\r
    if count == 0:\r
        return n_files_str(count)\r
    else:\r
        lines = ["{}:".format(n_files_str(count))]\r
        for path in file_paths:\r
            lines.append("  {}".format(path))\r
        return "\n".join(lines)\r
\r
\r
@status("Fixing whitespace", info=report_modified_files)\r
def normalize_whitespace(file_paths):\r
    """Make sure that the whitespace for .py files have been normalized."""\r
    reindent.makebackup = False  # No need to create backups.\r
    fixed = []\r
    for path in (x for x in file_paths if x.endswith('.py')):\r
        if reindent.check(path):\r
            fixed.append(path)\r
    return fixed\r
\r
\r
@status("Fixing C file whitespace", info=report_modified_files)\r
def normalize_c_whitespace(file_paths):\r
    """Report if any C files """\r
    fixed = []\r
    for path in file_paths:\r
        with open(path, 'r') as f:\r
            if '\t' not in f.read():\r
                continue\r
        untabify.process(path, 8, verbose=False)\r
        fixed.append(path)\r
    return fixed\r
\r
\r
ws_re = re.compile(br'\s+(\r?\n)$')\r
\r
@status("Fixing docs whitespace", info=report_modified_files)\r
def normalize_docs_whitespace(file_paths):\r
    fixed = []\r
    for path in file_paths:\r
        try:\r
            with open(path, 'rb') as f:\r
                lines = f.readlines()\r
            new_lines = [ws_re.sub(br'\1', line) for line in lines]\r
            if new_lines != lines:\r
                shutil.copyfile(path, path + '.bak')\r
                with open(path, 'wb') as f:\r
                    f.writelines(new_lines)\r
                fixed.append(path)\r
        except Exception as err:\r
            print 'Cannot fix %s: %s' % (path, err)\r
    return fixed\r
\r
\r
@status("Docs modified", modal=True)\r
def docs_modified(file_paths):\r
    """Report if any file in the Doc directory has been changed."""\r
    return bool(file_paths)\r
\r
\r
@status("Misc/ACKS updated", modal=True)\r
def credit_given(file_paths):\r
    """Check if Misc/ACKS has been changed."""\r
    return 'Misc/ACKS' in file_paths\r
\r
\r
@status("Misc/NEWS updated", modal=True)\r
def reported_news(file_paths):\r
    """Check if Misc/NEWS has been changed."""\r
    return 'Misc/NEWS' in file_paths\r
\r
\r
def main():\r
    file_paths = changed_files()\r
    python_files = [fn for fn in file_paths if fn.endswith('.py')]\r
    c_files = [fn for fn in file_paths if fn.endswith(('.c', '.h'))]\r
    doc_files = [fn for fn in file_paths if fn.startswith('Doc')]\r
    special_files = {'Misc/ACKS', 'Misc/NEWS'} & set(file_paths)\r
    # PEP 8 whitespace rules enforcement.\r
    normalize_whitespace(python_files)\r
    # C rules enforcement.\r
    normalize_c_whitespace(c_files)\r
    # Doc whitespace enforcement.\r
    normalize_docs_whitespace(doc_files)\r
    # Docs updated.\r
    docs_modified(doc_files)\r
    # Misc/ACKS changed.\r
    credit_given(special_files)\r
    # Misc/NEWS changed.\r
    reported_news(special_files)\r
\r
    # Test suite run and passed.\r
    print\r
    print "Did you run the test suite?"\r
\r
\r
if __name__ == '__main__':\r
    main()\r