def from_file(cls, href):
"""Reads a STACObject implementation from a file.
Args:
href (str): The HREF to read the object from.
Returns:
The specific STACObject implementation class that is represented
by the JSON read from the file located at HREF.
"""
if not is_absolute_href(href):
href = make_absolute_href(href)
d = STAC_IO.read_json(href)
if cls == STACObject:
o = STAC_IO.stac_object_from_dict(d, href=href)
else:
o = cls.from_dict(d, href=href)
# Set the self HREF, if it's not already set to something else.
if o.get_self_href() is None:
o.set_self_href(href)
# If this is a root catalog, set the root to the catalog instance.
root_link = o.get_root_link()
if root_link is not None:
if not root_link.is_resolved():
if root_link.get_absolute_href() == href:
o.set_root(o, link_type=root_link.link_type)
return o
def merge_common_properties(item_dict, collection_cache=None, json_href=None):
"""Merges Collection properties into an Item.
Args:
item_dict: JSON dict of the Item which properties should be merged
into.
collection_cache: Optional cache of Collection JSON that has previously
read. Keyed to either the Collection ID or an HREF.
json_href: The HREF of the file that this JSON comes from. Used
to resolve relative paths.
Returns:
bool: True if Collection properties have been merged, otherwise False.
"""
properties_merged = False
collection = None
collection_href = None
# Try the cache if we have a collection ID.
if 'collection' in item_dict:
collection_id = item_dict['collection']
if collection_cache is not None:
collection = collection_cache.get(collection_id)
# Next, try the collection link.
if collection is None:
links = item_dict['links']
collection_link = next((l for l in links if l['rel'] == 'collection'),
None)
if collection_link is not None:
collection_href = collection_link['href']
if json_href is not None:
collection_href = make_absolute_href(collection_href,
json_href)
if collection_cache is not None:
collection = collection_cache.get(collection_href)
if collection is None:
collection = STAC_IO.read_json(collection_href)
if collection is not None:
if 'properties' in collection:
for k in collection['properties']:
if k not in item_dict['properties']:
properties_merged = True
item_dict['properties'][k] = collection['properties'][k]
if collection_cache is not None and collection[
'id'] not in collection_cache:
collection_id = collection['id']
collection_cache[collection_id] = collection
if collection_href is not None:
collection_cache[collection_href] = collection
return properties_merged
def merge_common_properties(item_dict, collection_cache=None, json_href=None):
"""Merges Collection properties into an Item.
Args:
item_dict (dict): JSON dict of the Item which properties should be merged
into.
collection_cache (CollectionCache): Optional CollectionCache
that will be used to read and write cached collections.
json_href: The HREF of the file that this JSON comes from. Used
to resolve relative paths.
Returns:
bool: True if Collection properties have been merged, otherwise False.
"""
properties_merged = False
collection = None
collection_id = None
collection_href = None
# Check to see if this is an item 0.9 or later that
# doesn't extend the commons extension, in which case
# we don't have to merge.
stac_version = item_dict.get('stac_version')
if stac_version is not None and stac_version >= '0.9.0':
stac_extensions = item_dict.get('stac_extensions')
if type(stac_extensions) is list:
if 'commons' not in stac_extensions:
return False
# Try the cache if we have a collection ID.
if 'collection' in item_dict:
collection_id = item_dict['collection']
if collection_cache is not None:
collection = collection_cache.get_by_id(collection_id)
# Next, try the collection link.
if collection is None:
links = item_dict['links']
# Account for 0.5 links, which were dicts
if isinstance(links, dict):
links = list(links.values())
collection_link = next(
(link for link in links if link['rel'] == 'collection'), None)
if collection_link is not None:
collection_href = collection_link['href']
if json_href is not None:
collection_href = make_absolute_href(collection_href,
json_href)
if collection_cache is not None:
collection = collection_cache.get_by_href(collection_href)
if collection is None:
collection = STAC_IO.read_json(collection_href)
if collection is not None:
collection_id = None
collection_props = None
if isinstance(collection, Collection):
collection_id = collection.id
collection_props = collection.properties
else:
collection_id = collection['id']
if 'properties' in collection:
collection_props = collection['properties']
if collection_props is not None:
for k in collection_props:
if k not in item_dict['properties']:
properties_merged = True
item_dict['properties'][k] = collection_props[k]
if collection_cache is not None and not collection_cache.contains_id(
collection_id):
collection_cache.cache(collection, href=collection_href)
return properties_merged
