Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

Commit

Permalink
reformat the code, ready to merge (#2943)
Browse files Browse the repository at this point in the history 
* make our code pep8 compilant
  • Loading branch information
@guihao-liang
guihao-liang authored Feb 3, 2020
1 parent 7bf9b6f commit f57ca7c
Show file tree
Hide file tree
Showing 267 changed files with 34,182 additions and 21,208 deletions.
1,983 changes: 1,983 additions & 0 deletions .flake8.log
View file

Large diffs are not rendered by default.

147 changes: 97 additions & 50 deletions scripts/fix_headers.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,80 +8,111 @@
import argparse
from collections import defaultdict

parser = argparse.ArgumentParser(description=
"""
parser = argparse.ArgumentParser(
description="""
Script to fix invalid headers in the repository source files after file moves.
Must be run from the root of the repository.
Examples:
Examples:
To fix one header file in all source files.
./scripts/fix_headers.py <header_name>
To fix all references to a collection of header files (note regex match):
./scripts/fix_headers.py --all-match='src/<subdir/.*\.h.*'
""")

parser.add_argument('--header-root', dest='header_root', default='src', type=str, help="Base source of header info.")

parser.add_argument('--src-match', dest='src_match', default='src/* test/*', type=str, help="Match pattern of files to fix.")
To fix all references to a collection of header files (note regex match):
parser.add_argument('headers', metavar='header', type=str, nargs='*', help="List of headers to fix.")
./scripts/fix_headers.py --all-match='src/<subdir/.*\.h.*'
parser.add_argument('--all-match', dest='fix_all', help="Fix all headers below --header-root matching given regex pattern.", type=str)
"""
)

parser.add_argument(
"--header-root",
dest="header_root",
default="src",
type=str,
help="Base source of header info.",
)

parser.add_argument(
"--src-match",
dest="src_match",
default="src/* test/*",
type=str,
help="Match pattern of files to fix.",
)

parser.add_argument(
"headers", metavar="header", type=str, nargs="*", help="List of headers to fix."
)

parser.add_argument(
"--all-match",
dest="fix_all",
help="Fix all headers below --header-root matching given regex pattern.",
type=str,
)

args = parser.parse_args()

header_root = args.header_root.replace("//", "/")
while header_root.endswith("/"):
header_root=header_root[:-1]
header_root = header_root[:-1]


root_path = os.getcwd()


def error_out(*messages):
print("".join(messages), "\n")
sys.exit(1)

if not exists(header_root + "/") :

if not exists(header_root + "/"):
error_out(header_root + " is not a valid directory.")

if (not exists(join(root_path, ".git/config"))):
if not exists(join(root_path, ".git/config")):
error_out("Script must be run in root of repository.")


def _run_git(cmd):
output = subprocess.check_output(cmd, shell = True)
output = subprocess.check_output(cmd, shell=True)

if type(output) is not str:
output = output.decode("ascii")

return [x.strip() for x in output.split("\n") if len(x.strip()) != 0]


# Generate a global raw header list for lookup
raw_header_list = _run_git("git ls-files '%s/*.h' '%s/*.hpp'" % (header_root, header_root))
raw_header_list = _run_git(
"git ls-files '%s/*.h' '%s/*.hpp'" % (header_root, header_root)
)


def all_repl_cmd(filter_name, *sed_commands):

proc = subprocess.check_call(cmd, shell=True)


def fix_headers_cmd(header_name, true_header):

sed_commands = [
r's|\#include[ ]*\<boost|\#include_boost_|g', #Exclude the boost headers from consideration, as some of them have intersecting names.
r's|\#include[ ]*\<[^\>]*/%s\>|#include <%s>|g' % (header_name, true_header),
r's|\#include[ ]*\<%s\>|#include <%s>|g' % (header_name, true_header),
r's|\#include[ ]*\"[^\"]*/%s\"|#include <%s>|g' % (header_name, true_header),
r's|\#include[ ]*\"[^\"]*/%s\"|#include <%s>|g' % (header_name, true_header),
r's|cdef extern from \"\<[^\>]*%s\>\"|cdef extern from "<%s>"|g' % (header_name, true_header),
r's|\#include_boost_|\#include \<boost|g'] # Place the boost headers back

return (r"git grep -l '%s' %s | grep -v -E '^src/external/.+/.+/.*' | xargs sed -i '' -e %s "
% (header_name, args.src_match, " -e ".join("'%s'" % s for s in sed_commands)))

r"s|\#include[ ]*\<boost|\#include_boost_|g", # Exclude the boost headers from consideration, as some of them have intersecting names.
r"s|\#include[ ]*\<[^\>]*/%s\>|#include <%s>|g" % (header_name, true_header),
r"s|\#include[ ]*\<%s\>|#include <%s>|g" % (header_name, true_header),
r"s|\#include[ ]*\"[^\"]*/%s\"|#include <%s>|g" % (header_name, true_header),
r"s|\#include[ ]*\"[^\"]*/%s\"|#include <%s>|g" % (header_name, true_header),
r's|cdef extern from \"\<[^\>]*%s\>\"|cdef extern from "<%s>"|g'
% (header_name, true_header),
r"s|\#include_boost_|\#include \<boost|g",
] # Place the boost headers back

return (
r"git grep -l '%s' %s | grep -v -E '^src/external/.+/.+/.*' | xargs sed -i '' -e %s "
% (header_name, args.src_match, " -e ".join("'%s'" % s for s in sed_commands))
)


def fix_headers(filenames):
Expand All @@ -93,36 +124,50 @@ def fix_headers(filenames):
for filename in filenames:

# Get the correct path of the file.
header_files = [fn for fn in raw_header_list if fn.endswith("/" + filename) and "boost/" not in fn]
header_files = [
fn
for fn in raw_header_list
if fn.endswith("/" + filename) and "boost/" not in fn
]

if len(header_files) == 0:
error_out("File ", filename, " not found in repository.")

if len(header_files) > 1:
error_out("Multiple matches for file ", filename, " found. Please disambiguate by providing part of the path.\n"
"Found: \n"
+ "\n".join(header_files))
error_out(
"Multiple matches for file ",
filename,
" found. Please disambiguate by providing part of the path.\n"
"Found: \n" + "\n".join(header_files),
)

new_file = header_files[0]
assert new_file.startswith( ("%s/" % header_root).replace("//", "/") ), new_file
assert new_file.startswith(("%s/" % header_root).replace("//", "/")), new_file

new_file = new_file[len(header_root) + 1:]
new_file = new_file[len(header_root) + 1 :]

repls.append( (filename, new_file) )
repls.append((filename, new_file))

if len(repls) > 100:
print("Fixing header locations for %d headers." % len(repls))
else:
print("Fixing header locations for headers: \n" + "\n".join(" %s -> %s" % (h, fl) for h, fl in repls))
print(
"Fixing header locations for headers: \n"
+ "\n".join(" %s -> %s" % (h, fl) for h, fl in repls)
)

shell_cmd = "\n".join(
"{2} || echo 'ERROR fixing {0}; ignoring.' && echo 'Fixed {0} (True = {1}). ' \n".format(header, new_file, fix_headers_cmd(header, new_file))
for header, new_file in repls)
"{2} || echo 'ERROR fixing {0}; ignoring.' && echo 'Fixed {0} (True = {1}). ' \n".format(
header, new_file, fix_headers_cmd(header, new_file)
)
for header, new_file in repls
)

open("run_all.out", "w").write(shell_cmd)

import tempfile
with tempfile.NamedTemporaryFile(mode='w', delete=False) as temp:

with tempfile.NamedTemporaryFile(mode="w", delete=False) as temp:
temp.write(shell_cmd)
temp.flush()
subprocess.check_call(["bash", temp.name])
Expand All @@ -134,31 +179,33 @@ def print_usage_and_exit():
print("Usage: %s <command> [args...]" % sys.argv[0])

print("Commands: ")
print(" --fix-headers <header_name> Fixes all import paths of a unique header.")
print(
" --fix-headers <header_name> Fixes all import paths of a unique header."
)
sys.exit(1)


def all_headers_matching(match_regex):

rhl = [h for h in raw_header_list if match_regex.match(h)]


# Sometimes filenames may have multiple versions, which we need to handle.
# We can do this splitting the list into two components -- those that are
# unique, and those that need additional path information to distinguish
# Sometimes filenames may have multiple versions, which we need to handle.
# We can do this splitting the list into two components -- those that are
# unique, and those that need additional path information to distinguish
# which one is being included. The latter we then expand out the directories
# until all files are correctly included
def separate_unique(raw_headers, n):
lookup = defaultdict(lambda: [])

for h in raw_headers:
fn = '/'.join(h.split('/')[-n:])
fn = "/".join(h.split("/")[-n:])
lookup[fn].append(h)

header_list = []

for fn, hl in lookup.items():
if len(hl) == 1:
header_list.append( (fn, hl[0]) )
header_list.append((fn, hl[0]))
else:
# use recursion on this sublist to find distinguishing suffixes
header_list += separate_unique(hl, n + 1)
Expand All @@ -175,8 +222,8 @@ def separate_unique(raw_headers, n):

return ret

if __name__ == "__main__":

if __name__ == "__main__":

if args.fix_all:
filter_regex = re.compile(args.fix_all)
Expand Down
Loading

0 comments on commit f57ca7c

Please sign in to comment.