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 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
|
"""Utility stuff for json tools.
"""
import argparse
from collections import Counter, OrderedDict
from fnmatch import fnmatch
import json
import re
import os
from io import StringIO
SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
JSON_DIR = os.path.normpath(
os.path.join(SCRIPT_DIR, "..", "..", "data", "json"))
JSON_FNMATCH = "*.json"
def import_data(json_dir=JSON_DIR, json_fmatch=JSON_FNMATCH):
"""Use a UNIX like file match expression to weed out the JSON files.
returns tuple, first element containing json read, second element
containing list of any errors found. error list will be empty if
no errors
"""
data = []
errors = []
candidates = None
for d_descriptor in os.walk(json_dir):
d = d_descriptor[0]
for f in d_descriptor[2]:
if fnmatch(f, json_fmatch):
json_file = os.path.join(d, f)
with open(json_file, "r", encoding="utf-8") as file:
try:
candidates = json.load(
file, object_pairs_hook=OrderedDict)
except Exception as err:
errors.append(
"Problem reading file {},".format(json_file) +
" reason: {}".format(err))
if type(candidates) != list:
if type(candidates) == OrderedDict:
data.append(candidates)
else:
errors.append(
"Problem parsing data from" +
" file {},".format(json_file) +
" reason: expected a list.")
else:
data += candidates
return (data, errors)
def match_primitive_values(item_value, where_value):
"""Perform any odd logic on item matching.
"""
# Matching interpolation for keyboard constrained input.
if type(item_value) == str:
# Direct match
return bool(re.match(where_value, item_value))
elif type(item_value) == int or type(item_value) == float:
# match after string conversion
return bool(re.match(where_value, str(item_value)))
elif type(item_value) == bool:
# help conversion to JSON booleans from the commandline
return bool(re.match(where_value, str(item_value).lower()))
else:
return False
def matches_where(item, where_key, where_value):
"""True if:
where_key exists AND
where_value somehow matches (either directly or guesstimated).
False if:
no where_key passed in
where_key not in item
where_key in item but where_value does not match
"""
if not where_key:
return True
if where_key not in item:
return False
# So we have some value.
item_value = item[where_key]
# Matching interpolation for keyboard constrained input.
if type(item_value) == list:
# 1 level deep.
for next_level in item_value:
if match_primitive_values(next_level, where_value):
return True
# else...
return False
elif type(item_value) == dict:
# Match against the keys of the dictionary... I question my logic.
# 1 level deep.
for next_level in item_value:
if match_primitive_values(next_level, where_value):
return True
# else...
return False
else:
return match_primitive_values(item_value, where_value)
def matches_all_wheres(item, where_fn_list):
"""Takes a list of where functions and attempts to match against them.
Assumes wheres are the type returned from WhereAction, and the function
accepts the item to match against.
True if:
all where's match (effectively AND)
False if:
any where's don't match
"""
for where_fn in where_fn_list:
if not where_fn(item):
return False
# Must be a match.
return True
class WhereAction(argparse.Action):
"""An argparse action callback.
Example application:
parser.add_argument("where",
action=WhereAction, nargs='*', type=str, help="where exclusions")
"""
def where_test_factory(self, where_key, where_value):
"""Wrap the where test we are using and return it as a callable
function.
item in the callback is assumed to be what we're testing against.
"""
def t(item):
return matches_where(item, where_key, where_value)
return t
def __init__(self, option_strings, dest, nargs=None, **kwargs):
if not nargs:
raise ValueError("nargs must be declared")
super(WhereAction, self).__init__(
option_strings, dest, nargs=nargs, **kwargs)
def __call__(self, parser, namespace, values, option_string=None):
try:
where_functions = []
for w in values:
w_key, w_value = w.split("=")
where_functions.append(self.where_test_factory(w_key, w_value))
setattr(namespace, self.dest, where_functions)
except Exception:
raise ValueError(
"Where options are strict. Must be in the form of"
" 'where_key=where_value'")
def key_counter(data, where_fn_list):
"""Count occurences of keys found in data {list of dicts}
that also match each where_fn_list {list of fns}.
Returns a tuple of data.
"""
stats = Counter()
matching_data = [i for i in data if matches_all_wheres(i, where_fn_list)]
for item in matching_data:
# Check each key for nested data
for key in item.keys():
# Skip comments
if key.startswith('//'):
continue
val = item[key]
# If value is an object, tally key.subkey for all object subkeys
if type(val) == OrderedDict:
for subkey in val.keys():
if not subkey.startswith('//'):
stats[key + '.' + subkey] += 1
# If value is a list of objects, tally key.subkey for each
elif type(val) == list:
if all(type(e) == OrderedDict for e in val):
for obj in val:
for subkey in obj.keys():
if not subkey.startswith('//'):
stats[key + '.' + subkey] += 1
# For anything else, it only counts as one
else:
stats[key] += 1
return stats, len(matching_data)
def item_value_counter(_value):
"""Return a Counter for a single value (int, float, string, dict)
recursing into nested dicts and lists.
"""
stats = Counter()
# String or unicode
if isinstance(_value, str):
stats[_value] += 1
# Cast numbers to strings
elif type(_value) == int or type(_value) == float:
stats[str(_value)] += 1
# Pull all values from objects
elif type(_value) == OrderedDict:
stats += list_value_counter(list(_value.values()))
# Pull values from list of objects or strings
elif type(_value) == list:
stats += list_value_counter(_value)
else:
raise ValueError("Value '%s' has unknown type %s" %
(_value, type(_value)))
return stats
def list_value_counter(_list):
"""Return a Counter tallying all values in the given {list of dicts}
or {list of strs}, recursing into nested dicts and lists.
"""
stats = Counter()
for elem in _list:
stats += item_value_counter(elem)
return stats
def value_counter(data, search_key, where_fn_list):
"""Takes a search_key {str}, and for values found in data {list of dicts}
that also match each where_fn_list {list of fns} with those keys,
counts the number of times the value appears.
Returns a tuple of data.
"""
stats = Counter()
matching_data = [i for i in data if matches_all_wheres(i, where_fn_list)]
# Search key may use one level of dotted notation to descend into an
# dict or list-of-dict in the matching data
# Exactly one dot is allowed to look in parent_key.child_key
if search_key.count('.') == 1:
parent_key, child_key = search_key.split('.')
# With no dots, just use the plain key
elif search_key.count('.') == 0:
parent_key = search_key
child_key = None
else:
raise argparse.ArgumentError("Only one '.' allowed in search key")
for item in matching_data:
if parent_key not in item:
stats['MISSING'] += 1
continue
parent_val = item[parent_key]
# List of values within this item to tally stats on
stat_vals = []
# If this value is a list of objects, pull parent_key.child_key
# values from all of them to include in stats
if type(parent_val) == list and all(type(e) == OrderedDict
for e in parent_val):
for od in parent_val:
if child_key in od:
stat_vals.append(od[child_key])
# If this value is a single object, get value at parent_key.child_key
elif type(parent_val) == OrderedDict and child_key in parent_val:
stat_vals.append(parent_val[child_key])
# Other kinds of data cannot be indexed by parent_key.child_key
else:
stat_vals.append(parent_val)
# Tally all stats, recursing into nested values
for val in stat_vals:
stats += item_value_counter(val)
return stats, len(matching_data)
def ui_values_to_columns(values, screen_width=80):
"""Take a list of strings and output in fixed width columns.
"""
max_val_len = len(max(values, key=len)) + 1
cols = screen_width / max_val_len
iters = 0
for v in values:
print(v.ljust(max_val_len), end=' ')
iters += 1
if iters % cols == 0:
print("")
print("")
def ui_counts_to_columns(counts):
"""Take a Counter instance and display in single fixed width key:value
column.
"""
# Values in left column, counts in right, left
# column as wide as longest string length.
key_vals = counts.most_common()
key_field_len = len(max(list(counts.keys()), key=len)) + 1
output_template = "%%-%ds: %%s" % key_field_len
for k_v in key_vals:
print(output_template % k_v)
class CDDAJSONWriter(object):
"""Essentially a one-off class used to write CDDA formatted JSON output.
Expects single object, not a list of objects.
Probable usage:
print CDDSJSONWriter(some_json).dumps()
"""
indent = " "
indent_multiplier = 0
buf = None
def __init__(self, d, indent_multiplier=0):
self.d = d
# Should you wish to change the initial indent for whatever reason.
self.indent_multiplier = indent_multiplier
# buf is initialized on a call to dumps
def indented_write(self, s):
self.buf.write(self.indent * self.indent_multiplier + s)
def write_key(self, k):
self.indented_write("\"%s\": " % k)
def write_primitive_key_val(self, k, v):
self.write_key(k)
self.buf.write(json.dumps(v))
def list_of_lists(self, k, lol):
self.write_key(k)
self.buf.write("[\n")
lol = lol[:]
while lol:
self.indent_multiplier += 1
inner = lol.pop(0)[:]
self.indented_write("[\n")
while inner:
self.indent_multiplier += 1
item = inner.pop(0)
# Print each of these on one line
self.indented_write(json.dumps(item))
if inner:
self.buf.write(",\n")
self.indent_multiplier -= 1
self.buf.write("\n")
self.indented_write("]")
self.buf.write(",\n" if lol else "\n")
self.indent_multiplier -= 1
self.indented_write("]")
def dumps(self):
"""Format the Cataclysm JSON in as friendly of a JSON way as we can.
"""
if self.buf:
self.buf.close()
self.buf = None
self.buf = StringIO()
items = list(self.d.items())
global indent_multiplier
self.indented_write("{\n")
self.indent_multiplier += 1
while items:
k, v = items.pop(0)
# Special cases first.
if (k == "tools" or k == "components") and type(v) == list:
self.list_of_lists(k, v)
else:
self.write_primitive_key_val(k, v)
# Trailing comma or not
if items:
self.buf.write(",\n")
self.buf.write("\n")
self.indent_multiplier -= 1
self.indented_write("}")
return self.buf.getvalue()
|