1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
|
# -*- coding: utf-8 -*-
"""
Analyze the naming conventions by recording all variable assignments and
classifying them according to context.
"""
from __future__ import unicode_literals
import argparse
import io
import logging
import os
import re
import sys
import cmakelang
from cmakelang import common
from cmakelang.format import __main__
from cmakelang import configuration
from cmakelang import lex
from cmakelang import parse
from cmakelang.lex import TokenType
from cmakelang.lint.basic_checker import (
Scope, get_scope_of_assignment, find_statements_in_subtree)
logger = logging.getLogger(__name__)
class NameCollector(object):
def __init__(self):
self.varnames = []
def collect_names(self, parse_tree):
for stmt in find_statements_in_subtree(parse_tree, ["set", "list"]):
scope = get_scope_of_assignment(stmt)
if stmt.get_funname() == "set":
token = stmt.argtree.varname
else:
token = stmt.argtree.parg_groups[0].get_tokens(kind="semantic")[1]
self.varnames.append((scope, token.spelling))
for stmt in find_statements_in_subtree(parse_tree, ["foreach"]):
tokens = stmt.get_semantic_tokens()
tokens.pop(0) # statement name "foreach"
tokens.pop(0) # lparen
token = tokens.pop(0) # loopvar
self.varnames.append((Scope.LOOP, token.spelling))
for stmt in find_statements_in_subtree(parse_tree, ["function", "macro"]):
tokens = stmt.argtree.get_semantic_tokens()[1:]
for token in tokens: # named arguments
if token.type is TokenType.RIGHT_PAREN:
break
if token.type is not TokenType.WORD:
logger.warning(
"Unexpected token %s at %s", token.spelling, token.get_location())
else:
self.varnames.append((Scope.ARGUMENT, token.spelling))
def setup_argparse(argparser):
argparser.add_argument('-v', '--version', action='version',
version=cmakelang.__version__)
argparser.add_argument(
'-l', '--log-level', default="info",
choices=["error", "warning", "info", "debug"])
argparser.add_argument(
'-o', '--outfile-path', default=None,
help='Write errors to this file. Default is stdout.')
argparser.add_argument('infilepaths', nargs='*')
USAGE_STRING = """
analyze_naming [-h] [-o OUTFILE_PATH] infilepath [infilepath ...]
"""
def inner_main():
"""Parse arguments, open files, start work."""
logging.basicConfig(level=logging.INFO, format="%(levelname)s %(message)s")
argparser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter,
usage=USAGE_STRING)
setup_argparse(argparser)
args = argparser.parse_args()
logging.getLogger().setLevel(getattr(logging, args.log_level.upper()))
if args.outfile_path is None:
args.outfile_path = '-'
if '-' in args.infilepaths:
assert len(args.infilepaths) == 1, \
"You cannot mix stdin as an input with other input files"
if args.outfile_path == '-':
outfile = io.open(os.dup(sys.stdout.fileno()),
mode='w', encoding="utf-8", newline='')
else:
outfile = io.open(args.outfile_path, 'w', encoding="utf-8", newline='')
returncode = 0
cfg = configuration.Configuration()
collector = NameCollector()
for infile_path in args.infilepaths:
# NOTE(josh): have to load config once for every file, because we may pick
# up a new config file location for each path
if infile_path == '-':
infile_path = os.dup(sys.stdin.fileno())
try:
infile = io.open(
infile_path, mode='r', encoding=cfg.encode.input_encoding, newline='')
except (IOError, OSError):
logger.error("Failed to open %s for read", infile_path)
returncode = 1
continue
try:
with infile:
infile_content = infile.read()
except UnicodeDecodeError:
logger.error(
"Unable to read %s as %s", infile_path, cfg.encode.input_encoding)
returncode = 1
continue
tokens = lex.tokenize(infile_content)
parse_db = parse.funs.get_parse_db()
ctx = parse.ParseContext(parse_db, config=cfg)
parse_tree = parse.parse(tokens, ctx)
parse_tree.build_ancestry()
collector.collect_names(parse_tree)
regexes = [re.compile(pattern) for pattern in [
r"[A-Z][A-Z0-9_]+", # upper snake-case
r"[a-z][a-z0-9_]+", # lower snake-case
r"_[A-Z0-9_]+", # upper snake-case with underscore prefix
r"_[a-z0-9_]+", # lower snake-case with underscore prefix
]]
outmap = {}
patmap = {}
for scope, varname in sorted(collector.varnames):
if scope not in outmap:
outmap[scope] = {}
if scope not in patmap:
patmap[scope] = {}
for regex in regexes:
patmap[scope][str(regex)] = 0
patmap[scope]["other"] = 0
for regex in regexes:
if regex.match(varname):
patmap[scope][str(regex)] += 1
break
else:
patmap[scope]["other"] += 1
if varname not in outmap[scope]:
outmap[scope][varname] = 0
outmap[scope][varname] += 1
for scope, countmap in sorted(outmap.items()):
outfile.write("\n{}\n{}\n".format(scope.name, "=" * len(scope.name)))
for varname, count in sorted(countmap.items()):
outfile.write("{}: {}\n".format(varname, count))
for scope, countmap in sorted(patmap.items()):
outfile.write("\n{}\n{}\n".format(scope.name, "=" * len(scope.name)))
for varname, count in sorted(countmap.items()):
outfile.write("{}: {}\n".format(varname, count))
outfile.close()
return returncode
def main():
try:
return inner_main()
except SystemExit:
return 0
except common.UserError as ex:
logger.fatal(ex.msg)
return 1
except common.InternalError as ex:
logger.exception(ex.msg)
return 2
except AssertionError as ex:
logger.exception(
"An internal error occured. Please consider filing a bug report at "
"github.com/cheshirekow/cmakelang/issues")
return 2
except: # pylint: disable=bare-except
logger.exception(
"An internal error occured. Please consider filing a bug report at "
"github.com/cheshirekow/cmakelang/issues")
return 2
if __name__ == "__main__":
sys.exit(main())
|