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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
|
from copy import deepcopy
from fnmatch import fnmatchcase
from typing import Sequence, Tuple, Iterator, Any, Union, Optional, MutableMapping, MutableSequence
from dpath import options
from dpath.exceptions import InvalidGlob, InvalidKeyName, PathNotFound
from dpath.types import PathSegment, Creator, Hints, Glob, Path, ListIndex
def make_walkable(node) -> Iterator[Tuple[PathSegment, Any]]:
"""
Returns an iterator which yields tuple pairs of (node index, node value), regardless of node type.
* For dict nodes `node.items()` will be returned.
* For sequence nodes (lists/tuples/etc.) a zip between index number and index value will be returned.
* Edge cases will result in an empty iterator being returned.
make_walkable(node) -> (generator -> (key, value))
"""
try:
return iter(node.items())
except AttributeError:
try:
indices = range(len(node))
# Convert all list indices to objects so negative indices are supported.
indices = map(lambda i: ListIndex(i, len(node)), indices)
return zip(indices, node)
except TypeError:
# This can happen in cases where the node isn't leaf(node) == True,
# but also isn't actually iterable. Instead of this being an error
# we will treat this node as if it has no children.
return enumerate([])
def leaf(thing):
"""
Return True if thing is a leaf, otherwise False.
"""
leaves = (bytes, str, int, float, bool, type(None))
return isinstance(thing, leaves)
def leafy(thing):
"""
Same as leaf(thing), but also treats empty sequences and
dictionaries as True.
"""
try:
return leaf(thing) or len(thing) == 0
except TypeError:
# In case thing has no len()
return False
def walk(obj, location=()):
"""
Yield all valid (segments, value) pairs (from a breadth-first
search, right-to-left on sequences).
walk(obj) -> (generator -> (segments, value))
"""
if not leaf(obj):
for k, v in make_walkable(obj):
length = None
try:
length = len(k)
except TypeError:
pass
if length is not None and length == 0 and not options.ALLOW_EMPTY_STRING_KEYS:
raise InvalidKeyName("Empty string keys not allowed without "
"dpath.options.ALLOW_EMPTY_STRING_KEYS=True: "
f"{location + (k,)}")
yield (location + (k,)), v
for k, v in make_walkable(obj):
for found in walk(v, location + (k,)):
yield found
def get(obj, segments: Path):
"""
Return the value at the path indicated by segments.
get(obj, segments) -> value
"""
current = obj
for i, segment in enumerate(segments):
if leaf(current):
raise PathNotFound(f"Path: {segments}[{i}]")
if isinstance(current, Sequence) and isinstance(segment, str) and segment.isdecimal():
segment = int(segment)
current = current[segment]
return current
def has(obj, segments):
"""
Return True if the path exists in the obj. Otherwise return False.
has(obj, segments) -> bool
"""
try:
get(obj, segments)
return True
except:
return False
def expand(segments):
"""
Yield a tuple of segments for each possible length of segments.
Starting from the shortest length of segments and increasing by 1.
expand(keys) -> (..., keys[:-2], keys[:-1])
"""
index = 0
for _ in segments:
index += 1
yield segments[:index]
def types(obj, segments):
"""
For each segment produce a tuple of (segment, type(value)).
types(obj, segments) -> ((segment[0], type0), (segment[1], type1), ...)
"""
result = []
for depth in expand(segments):
result.append((depth[-1], type(get(obj, depth))))
return tuple(result)
def leaves(obj):
"""
Yield all leaves as (segment, value) pairs.
leaves(obj) -> (generator -> (segment, value))
"""
return filter(lambda p: leafy(p[1]), walk(obj))
def int_str(segment: PathSegment) -> PathSegment:
"""
If the segment is an integer, return the string conversion.
Otherwise return the segment unchanged. The conversion uses 'str'.
int_str(segment) -> str
"""
if isinstance(segment, int):
return str(segment)
return segment
class Star(object):
"""
Used to create a global STAR symbol for tracking stars added when
expanding star-star globs.
"""
pass
STAR = Star()
def match(segments: Path, glob: Glob):
"""
Return True if the segments match the given glob, otherwise False.
For the purposes of matching, integers are converted to their string
equivalent (via str(segment)). This conversion happens on both the
segments and the glob. This implies you cannot (with this function)
differentiate a list index 0 from a dictionary key '0'.
Star-star segments are a special case in that they will expand to 0
or more star segments and the type will be coerced to match that of
the segment.
A segment is considered to match a glob if the function
fnmatch.fnmatchcase returns True. If fnmatchcase returns False or
throws an exception the result will be False.
match(segments, glob) -> bool
"""
segments = tuple(segments)
glob = tuple(glob)
path_len = len(segments)
glob_len = len(glob)
# The star-star normalized glob ('**' has been removed).
ss_glob = glob
if '**' in glob:
# Index of the star-star in the glob.
ss = glob.index('**')
if '**' in glob[ss + 1:]:
raise InvalidGlob(f"Invalid glob. Only one '**' is permitted per glob: {glob}")
# Convert '**' segment into multiple '*' segments such that the
# lengths of the path and glob match. '**' also can collapse and
# result in the removal of 1 segment.
if path_len >= glob_len:
# Path and glob have the same number of stars or the glob
# needs more stars (which we add).
more_stars = (STAR,) * (path_len - glob_len + 1)
ss_glob = glob[:ss] + more_stars + glob[ss + 1:]
elif path_len == glob_len - 1:
# Glob has one more segment than the path. Here we remove
# the '**' segment altogether to match the lengths up.
ss_glob = glob[:ss] + glob[ss + 1:]
# If we were successful in matching up the lengths, then we can
# compare them using fnmatch.
if path_len == len(ss_glob):
i = zip(segments, ss_glob)
for s, g in i:
# Match the stars we added to the glob to the type of the
# segment itself.
if g is STAR:
if isinstance(s, bytes):
g = b'*'
else:
g = '*'
try:
# If search path segment (s) is an int then assume currently evaluated index (g) might be a sequence
# index as well. Try converting it to an int.
if isinstance(s, int) and s == int(g):
continue
except:
# Will reach this point if g can't be converted to an int (e.g. when g is a RegEx pattern).
# In this case convert s to a str so fnmatch can work on it.
s = str(s)
try:
# Let's see if the glob matches. We will turn any kind of
# exception while attempting to match into a False for the
# match.
if not fnmatchcase(s, g):
return False
except:
return False
# All of the segments matched so we have a complete match.
return True
# Otherwise the lengths aren't the same and we couldn't have a
# match.
return False
def extend(thing: MutableSequence, index: int, value=None):
"""
Extend a sequence like thing such that it contains at least index +
1 many elements. The extension values will be None (default).
extend(thing, int) -> [thing..., None, ...]
"""
try:
expansion = type(thing)()
# Using this rather than the multiply notation in order to support a
# wider variety of sequence like things.
extra = (index + 1) - len(thing)
for i in range(extra):
expansion += [value]
thing.extend(expansion)
except TypeError:
# We attempted to extend something that doesn't support it. In
# this case we assume thing is actually more like a dictionary
# and doesn't need to be extended.
pass
return thing
def _default_creator(
current: Union[MutableMapping, Sequence],
segments: Sequence[PathSegment],
i: int,
hints: Sequence[Tuple[PathSegment, type]] = ()
):
"""
Create missing path components. If the segment is an int, then it will
create a list. Otherwise a dictionary is created.
set(obj, segments, value) -> obj
"""
segment = segments[i]
length = len(segments)
if isinstance(current, Sequence):
segment = int(segment)
if isinstance(current, MutableSequence):
extend(current, segment)
# Infer the type from the hints provided.
if i < len(hints):
current[segment] = hints[i][1]()
else:
# Peek at the next segment to determine if we should be
# creating an array for it to access or dictionary.
if i + 1 < length:
segment_next = segments[i + 1]
else:
segment_next = None
if isinstance(segment_next, int) or (isinstance(segment_next, str) and segment_next.isdecimal()):
current[segment] = []
else:
current[segment] = {}
def set(
obj: MutableMapping,
segments: Sequence[PathSegment],
value,
creator: Optional[Creator] = _default_creator,
hints: Hints = ()
) -> MutableMapping:
"""
Set the value in obj at the place indicated by segments. If creator is not
None (default _default_creator), then call the creator function to
create any missing path components.
set(obj, segments, value) -> obj
"""
current = obj
length = len(segments)
# For everything except the last value, walk down the path and
# create if creator is set.
for (i, segment) in enumerate(segments[:-1]):
# If segment is non-int but supposed to be a sequence index
if isinstance(segment, str) and isinstance(current, Sequence) and segment.isdecimal():
segment = int(segment)
try:
# Optimistically try to get the next value. This makes the
# code agnostic to whether current is a list or a dict.
# Unfortunately, for our use, 'x in thing' for lists checks
# values, not keys whereas dicts check keys.
current[segment]
except:
if creator is not None:
creator(current, segments, i, hints)
else:
raise
current = current[segment]
if i != length - 1 and leaf(current):
raise PathNotFound(f"Path: {segments}[{i}]")
last_segment = segments[-1]
# Resolve ambiguity of last segment
if isinstance(last_segment, str) and isinstance(current, Sequence) and last_segment.isdecimal():
last_segment = int(last_segment)
if isinstance(last_segment, int):
extend(current, last_segment)
current[last_segment] = value
return obj
def fold(obj, f, acc):
"""
Walk obj applying f to each path and returning accumulator acc.
The function f will be called, for each result in walk(obj):
f(obj, (segments, value), acc)
If the function f returns False (exactly False), then processing
will stop. Otherwise processing will continue with the next value
retrieved from the walk.
fold(obj, f(obj, (segments, value), acc) -> bool, acc) -> acc
"""
for pair in walk(obj):
if f(obj, pair, acc) is False:
break
return acc
def foldm(obj, f, acc):
"""
Same as fold(), but permits mutating obj.
This requires all paths in walk(obj) to be loaded into memory
(whereas fold does not).
foldm(obj, f(obj, (segments, value), acc) -> bool, acc) -> acc
"""
pairs = tuple(walk(obj))
for pair in pairs:
if f(obj, pair, acc) is False:
break
return acc
def view(obj: MutableMapping, glob: Glob):
"""
Return a view of the object where the glob matches. A view retains
the same form as the obj, but is limited to only the paths that
matched. Views are new objects (a deepcopy of the matching values).
view(obj, glob) -> obj'
"""
def f(obj, pair, result):
(segments, value) = pair
if match(segments, glob):
if not has(result, segments):
set(result, segments, deepcopy(value), hints=types(obj, segments))
return fold(obj, f, type(obj)())
|