blob: 40ab39d86dde31af80535f0b07aae8818e9da181 [file] [log] [blame]
# vim:ts=4 sw=4 expandtab softtabstop=4
from jsonmerge import strategies
from jsonschema.validators import Draft4Validator
class Walk(object):
def __init__(self, merger):
self.merger = merger
self.resolver = merger.validator.resolver
def is_type(self, instance, type):
"""Check if instance if a specific JSON type."""
return self.merger.validator.is_type(instance, type)
def descend(self, schema, *args):
if schema is not None:
ref = schema.get("$ref")
if ref is not None:
with self.resolver.resolving(ref) as resolved:
return self.descend(resolved, *args)
name = schema.get("mergeStrategy")
opts = schema.get("mergeOptions")
if opts is None:
opts = {}
name = None
opts = {}
if name is None:
name = self.default_strategy(schema, *args, **opts)
strategy = self.merger.strategies[name]
return, schema, *args, **opts)
class WalkInstance(Walk):
def add_meta(self, head, meta):
if meta is None:
rv = dict()
rv = dict(meta)
rv['value'] = head
return rv
def default_strategy(self, schema, base, head, meta, **kwargs):
if self.is_type(head, "object"):
return "objectMerge"
return "overwrite"
def work(self, strategy, schema, base, head, meta, **kwargs):
return strategy.merge(self, base, head, schema, meta, **kwargs)
class WalkSchema(Walk):
def resolve_refs(self, schema, resolve_base=False):
if (not resolve_base) and self.resolver.base_uri == self.merger.schema.get('id', ''):
# no need to resolve refs in the context of the original schema - they
# are still valid
return schema
elif self.is_type(schema, "array"):
return [ self.resolve_refs(v) for v in schema ]
elif self.is_type(schema, "object"):
ref = schema.get("$ref")
if ref is not None:
with self.resolver.resolving(ref) as resolved:
return self.resolve_refs(resolved)
return dict( ((k, self.resolve_refs(v)) for k, v in schema.items()) )
return schema
def schema_is_object(self, schema):
objonly = (
for k in objonly:
if k in schema:
return True
if schema.get('type') == 'object':
return True
return False
def default_strategy(self, schema, meta, **kwargs):
if self.schema_is_object(schema):
return "objectMerge"
return "overwrite"
def work(self, strategy, schema, meta, **kwargs):
schema = dict(schema)
schema.pop("mergeStrategy", None)
schema.pop("mergeOptions", None)
return strategy.get_schema(self, schema, meta, **kwargs)
class Merger(object):
"overwrite": strategies.Overwrite(),
"version": strategies.Version(),
"append": strategies.Append(),
"objectMerge": strategies.ObjectMerge(),
"arrayMergeById": strategies.ArrayMergeById()
def __init__(self, schema, strategies=()):
"""Create a new Merger object.
schema -- JSON schema to use when merging.
strategies -- Any additional merge strategies to use during merge.
strategies argument should be a dict mapping strategy names to
instances of Strategy subclasses.
self.schema = schema
self.validator = Draft4Validator(schema)
self.strategies = dict(self.STRATEGIES)
def cache_schema(self, schema, uri=None):
"""Cache an external schema reference.
schema -- JSON schema to cache
uri -- Optional URI for the schema
If the JSON schema for merging contains external references, they will
be fetched using HTTP from their respective URLs. Alternatively, this
method can be used to pre-populate the cache with any external schemas
that are already known.
If URI is omitted, it is obtained from the 'id' keyword of the schema.
if uri is None:
uri = schema.get('id', ''), schema),))
def merge(self, base, head, meta=None):
"""Merge head into base.
base -- Old JSON document you are merging into.
head -- New JSON document for merging into base.
meta -- Optional dictionary with meta-data.
Any elements in the meta dictionary will be added to
the dictionaries appended by the version strategies.
Returns an updated base document
walk = WalkInstance(self)
return walk.descend(self.schema, base, head, meta)
def get_schema(self, meta=None):
"""Get JSON schema for the merged document.
meta -- Optional JSON schema for the meta-data.
Returns a JSON schema for documents returned by the
merge() method.
if meta is not None:
# This is kind of ugly - schema for meta data
# can again contain references to external schemas.
# Since we already have in place all the machinery
# to resolve these references in the merge schema,
# we (ab)use it here to do the same for meta data
# schema.
m = Merger(meta)
w = WalkSchema(m)
meta = w.resolve_refs(meta, resolve_base=True)
walk = WalkSchema(self)
return walk.descend(self.schema, meta)
def merge(base, head, schema={}):
"""Merge two JSON documents using strategies defined in schema.
base -- Old JSON document you are merging into.
head -- New JSON document for merging into base.
schema -- JSON schema to use when merging.
Merge strategy for each value can be specified in the schema
using the "mergeStrategy" keyword. If not specified, default
strategy is to use "objectMerge" for objects and "overwrite"
for all other types.
merger = Merger(schema)
return merger.merge(base, head)