import os
from copy import deepcopy
from enum import Enum
import pystac
from pystac import STACError
from pystac.stac_object import STACObject
from pystac.layout import (BestPracticesLayoutStrategy, LayoutTemplate)
from pystac.link import Link
from pystac.cache import ResolvedObjectCache
from pystac.utils import (is_absolute_href, make_absolute_href)
[docs]class CatalogType(str, Enum):
def __str__(self):
return str(self.value)
SELF_CONTAINED = 'SELF_CONTAINED'
"""A 'self-contained catalog' is one that is designed for portability.
Users may want to download a catalog from online and be able to use it on their
local computer, so all links need to be relative.
See:
`The best practices documentation on self-contained catalogs <https://github.com/radiantearth/stac-spec/blob/v0.8.1/best-practices.md#self-contained-catalogs>`_
""" # noqa E501
ABSOLUTE_PUBLISHED = 'ABSOLUTE_PUBLISHED'
"""
Absolute Published Catalog is a catalog that uses absolute links for everything,
both in the links objects and in the asset hrefs.
See:
`The best practices documentation on published catalogs <https://github.com/radiantearth/stac-spec/blob/v0.8.1/best-practices.md#published-catalogs>`_
""" # noqa E501
RELATIVE_PUBLISHED = 'RELATIVE_PUBLISHED'
"""
Relative Published Catalog is a catalog that uses relative links for everything,
but includes an absolute self link at the root catalog, to identify its online location.
See:
`The best practices documentation on published catalogs <https://github.com/radiantearth/stac-spec/blob/v0.8.1/best-practices.md#published-catalogs>`_
""" # noqa E501
@classmethod
def determine_type(cls, stac_json):
"""Determines the catalog type based on a STAC JSON dict.
Only applies to Catalogs or Collections
Args:
stac_json (dict): The STAC JSON dict to determine the catalog type
Returns:
str or None: The catalog type of the catalog or collection.
Will return None if it cannot be determined.
"""
self_link = None
relative = False
for link in stac_json['links']:
if link['rel'] == 'self':
self_link = link
else:
relative |= not is_absolute_href(link['href'])
if self_link:
if relative:
return cls.RELATIVE_PUBLISHED
else:
return cls.ABSOLUTE_PUBLISHED
else:
if relative:
return cls.SELF_CONTAINED
else:
return None
[docs]class Catalog(STACObject):
"""A PySTAC Catalog represents a STAC catalog in memory.
A Catalog is a :class:`~pystac.STACObject` that may contain children,
which are instances of :class:`~pystac.Catalog` or :class:`~pystac.Collection`,
as well as :class:`~pystac.Item` s.
Args:
id (str): Identifier for the catalog. Must be unique within the STAC.
description (str): Detailed multi-line description to fully explain the catalog.
`CommonMark 0.28 syntax <http://commonmark.org/>`_ MAY be used for rich text
representation.
title (str or None): Optional short descriptive one-line title for the catalog.
stac_extensions (List[str]): Optional list of extensions the Catalog implements.
href (str or None): Optional HREF for this catalog, which be set as the catalog's
self link's HREF.
catalog_type (str or None): Optional catalog type for this catalog. Must
be one of the values in :class`~pystac.CatalogType`.
Attributes:
id (str): Identifier for the catalog.
description (str): Detailed multi-line description to fully explain the catalog.
title (str or None): Optional short descriptive one-line title for the catalog.
stac_extensions (List[str] or None): Optional list of extensions the Catalog implements.
extra_fields (dict or None): Extra fields that are part of the top-level JSON properties
of the Catalog.
links (List[Link]): A list of :class:`~pystac.Link` objects representing
all links associated with this Catalog.
catalog_type (str or None): The catalog type, or None if not known.
"""
STAC_OBJECT_TYPE = pystac.STACObjectType.CATALOG
DEFAULT_FILE_NAME = "catalog.json"
"""Default file name that will be given to this STAC object in a cononical format."""
def __init__(self,
id,
description,
title=None,
stac_extensions=None,
extra_fields=None,
href=None,
catalog_type=CatalogType.ABSOLUTE_PUBLISHED):
super().__init__(stac_extensions)
self.id = id
self.description = description
self.title = title
if extra_fields is None:
self.extra_fields = {}
else:
self.extra_fields = extra_fields
self._resolved_objects = ResolvedObjectCache()
self.add_link(Link.root(self))
if href is not None:
self.set_self_href(href)
self.catalog_type = catalog_type
self._resolved_objects.cache(self)
def __repr__(self):
return '<Catalog id={}>'.format(self.id)
[docs] def set_root(self, root):
STACObject.set_root(self, root)
if root is not None:
root._resolved_objects = ResolvedObjectCache.merge(root._resolved_objects,
self._resolved_objects)
[docs] def is_relative(self):
return self.catalog_type in [CatalogType.RELATIVE_PUBLISHED, CatalogType.SELF_CONTAINED]
[docs] def add_child(self, child, title=None, strategy=None):
"""Adds a link to a child :class:`~pystac.Catalog` or :class:`~pystac.Collection`.
This method will set the child's parent to this object, and its root to
this Catalog's root.
Args:
child (Catalog or Collection): The child to add.
title (str): Optional title to give to the :class:`~pystac.Link`
"""
# Prevent typo confusion
if isinstance(child, pystac.Item):
raise STACError('Cannot add item as child. Use add_item instead.')
if strategy is None:
strategy = BestPracticesLayoutStrategy()
child.set_root(self.get_root())
child.set_parent(self)
# set self link
self_href = self.get_self_href()
if self_href:
child_href = strategy.get_href(child, os.path.dirname(self_href))
child.set_self_href(child_href)
self.add_link(Link.child(child, title=title))
[docs] def add_children(self, children):
"""Adds links to multiple :class:`~pystac.Catalog` or `~pystac.Collection`s.
This method will set each child's parent to this object, and their root to
this Catalog's root.
Args:
children (Iterable[Catalog or Collection]): The children to add.
"""
for child in children:
self.add_child(child)
[docs] def add_item(self, item, title=None, strategy=None):
"""Adds a link to an :class:`~pystac.Item`.
This method will set the item's parent to this object, and its root to
this Catalog's root.
Args:
item (Item): The item to add.
title (str): Optional title to give to the :class:`~pystac.Link`
"""
# Prevent typo confusion
if isinstance(item, pystac.Catalog):
raise STACError('Cannot add catalog as item. Use add_child instead.')
if strategy is None:
strategy = BestPracticesLayoutStrategy()
item.set_root(self.get_root())
item.set_parent(self)
# set self link
self_href = self.get_self_href()
if self_href:
item_href = strategy.get_href(item, os.path.dirname(self_href))
item.set_self_href(item_href)
self.add_link(Link.item(item, title=title))
[docs] def add_items(self, items):
"""Adds links to multiple :class:`~pystac.Item` s.
This method will set each item's parent to this object, and their root to
this Catalog's root.
Args:
items (Iterable[Item]): The items to add.
"""
for item in items:
self.add_item(item)
[docs] def get_child(self, id, recursive=False):
"""Gets the child of this catalog with the given ID, if it exists.
Args:
id (str): The ID of the child to find.
recursive (bool): If True, search this catalog and all children for the item;
otherwise, only search the children of this catalog. Defaults to False.
Return:
Item or None: The item with the given ID, or None if not found.
"""
if not recursive:
return next((c for c in self.get_children() if c.id == id), None)
else:
for root, _, _ in self.walk():
child = root.get_child(id, recursive=False)
if child is not None:
return child
return None
[docs] def get_children(self):
"""Return all children of this catalog.
Return:
Generator[Catalog or Collection]: Generator of children who's parent
is this catalog.
"""
return self.get_stac_objects('child')
[docs] def get_child_links(self):
"""Return all child links of this catalog.
Return:
List[Link]: List of links of this catalog with ``rel == 'child'``
"""
return self.get_links('child')
[docs] def clear_children(self):
"""Removes all children from this catalog.
Return:
Catalog: Returns ``self``
"""
child_ids = [child.id for child in self.get_children()]
for child_id in child_ids:
self.remove_child(child_id)
return self
[docs] def remove_child(self, child_id):
"""Removes an child from this catalog.
Args:
child_id (str): The ID of the child to remove.
"""
new_links = []
root = self.get_root()
for link in self.links:
if link.rel != 'child':
new_links.append(link)
else:
link.resolve_stac_object(root=root)
if link.target.id != child_id:
new_links.append(link)
else:
child = link.target
child.set_parent(None)
child.set_root(None)
self.links = new_links
[docs] def get_item(self, id, recursive=False):
"""Returns an item with a given ID.
Args:
id (str): The ID of the item to find.
recursive (bool): If True, search this catalog and all children for the item;
otherwise, only search the items of this catalog. Defaults to False.
Return:
Item or None: The item with the given ID, or None if not found.
"""
if not recursive:
return next((i for i in self.get_items() if i.id == id), None)
else:
for root, children, items in self.walk():
item = root.get_item(id, recursive=False)
if item is not None:
return item
return None
[docs] def get_items(self):
"""Return all items of this catalog.
Return:
Generator[Item]: Generator of items who's parent is this catalog.
"""
return self.get_stac_objects('item')
[docs] def clear_items(self):
"""Removes all items from this catalog.
Return:
Catalog: Returns ``self``
"""
for link in self.get_item_links():
if link.is_resolved():
item = link.target
item.set_parent(None)
item.set_root(None)
self.links = [link for link in self.links if link.rel != 'item']
return self
[docs] def remove_item(self, item_id):
"""Removes an item from this catalog.
Args:
item_id (str): The ID of the item to remove.
"""
new_links = []
root = self.get_root()
for link in self.links:
if link.rel != 'item':
new_links.append(link)
else:
link.resolve_stac_object(root=root)
if link.target.id != item_id:
new_links.append(link)
else:
item = link.target
item.set_parent(None)
item.set_root(None)
self.links = new_links
[docs] def get_all_items(self):
"""Get all items from this catalog and all subcatalogs. Will traverse
any subcatalogs recursively.
Returns:
Generator[Item]: All items that belong to this catalog, and all
catalogs or collections connected to this catalog through
child links.
"""
yield from self.get_items()
for child in self.get_children():
yield from child.get_all_items()
[docs] def get_item_links(self):
"""Return all item links of this catalog.
Return:
List[Link]: List of links of this catalog with ``rel == 'item'``
"""
return self.get_links('item')
[docs] def to_dict(self, include_self_link=True):
links = self.links
if not include_self_link:
links = filter(lambda l: l.rel != 'self', links)
d = {
'id': self.id,
'stac_version': pystac.get_stac_version(),
'description': self.description,
'links': [link.to_dict() for link in links]
}
if self.stac_extensions is not None:
d['stac_extensions'] = self.stac_extensions
for key in self.extra_fields:
d[key] = self.extra_fields[key]
if self.title is not None:
d['title'] = self.title
return d
[docs] def clone(self):
clone = Catalog(id=self.id,
description=self.description,
title=self.title,
stac_extensions=self.stac_extensions,
extra_fields=deepcopy(self.extra_fields),
catalog_type=self.catalog_type)
clone._resolved_objects.cache(clone)
for link in self.links:
if link.rel == 'root':
# Catalog __init__ sets correct root to clone; don't reset
# if the root link points to self
root_is_self = link.is_resolved() and link.target is self
if not root_is_self:
clone.set_root(None)
clone.add_link(link.clone())
else:
clone.add_link(link.clone())
return clone
[docs] def make_all_asset_hrefs_relative(self):
"""Makes all the HREFs of assets belonging to items in this catalog
and all children to be relative, recursively.
"""
for _, _, items in self.walk():
for item in items:
item.make_asset_hrefs_relative()
[docs] def make_all_asset_hrefs_absolute(self):
"""Makes all the HREFs of assets belonging to items in this catalog
and all children to be absolute, recursively.
"""
for _, _, items in self.walk():
for item in items:
item.make_asset_hrefs_absolute()
[docs] def normalize_and_save(self, root_href, catalog_type=None, strategy=None):
"""Normalizes link HREFs to the given root_href, and saves the catalog.
This is a convenience method that simply calls :func:`Catalog.normalize_hrefs
<pystac.Catalog.normalize_hrefs>` and :func:`Catalog.save <pystac.Catalog.save>`
in sequence.
Args:
root_href (str): The absolute HREF that all links will be normalized against.
catalog_type (str): The catalog type that dictates the structure of
the catalog to save. Use a member of :class:`~pystac.CatalogType`.
Defaults to the root catalog.catalog_type or the current catalog catalog_type
if there is no root catalog.
strategy (HrefLayoutStrategy): The layout strategy to use in setting the HREFS
for this catalog. Defaults to :class:`~pystac.layout.BestPracticesLayoutStrategy`
"""
self.normalize_hrefs(root_href, strategy=strategy)
self.save(catalog_type)
[docs] def normalize_hrefs(self, root_href, strategy=None):
"""Normalize HREFs will regenerate all link HREFs based on
an absolute root_href and the canonical catalog layout as specified
in the STAC specification's best practices.
This method mutates the entire catalog tree.
Args:
root_href (str): The absolute HREF that all links will be normalized against.
strategy (HrefLayoutStrategy): The layout strategy to use in setting the HREFS
for this catalog. Defaults to :class:`~pystac.layout.BestPracticesLayoutStrategy`
See:
`STAC best practices document <https://github.com/radiantearth/stac-spec/blob/v0.8.1/best-practices.md#catalog-layout>`_ for the canonical layout of a STAC.
""" # noqa E501
if strategy is None:
strategy = BestPracticesLayoutStrategy()
# Normalizing requires an absolute path
if not is_absolute_href(root_href):
root_href = make_absolute_href(root_href, os.getcwd(), start_is_dir=True)
def process_item(item, _root_href):
item.resolve_links()
new_self_href = strategy.get_href(item, _root_href)
def fn():
item.set_self_href(new_self_href)
return fn
def process_catalog(cat, _root_href, is_root):
setter_funcs = []
cat.resolve_links()
new_self_href = strategy.get_href(cat, _root_href, is_root)
new_root = os.path.dirname(new_self_href)
for item in cat.get_items():
setter_funcs.append(process_item(item, new_root))
for child in cat.get_children():
setter_funcs.extend(process_catalog(child, new_root, is_root=False))
def fn():
cat.set_self_href(new_self_href)
setter_funcs.append(fn)
return setter_funcs
# Collect functions that will actually mutate the objects.
# Delay mutation as setting hrefs while walking the catalog
# can result in bad links.
setter_funcs = process_catalog(self, root_href, is_root=True)
for fn in setter_funcs:
fn()
return self
[docs] def generate_subcatalogs(self, template, defaults=None, parent_ids=None, **kwargs):
"""Walks through the catalog and generates subcatalogs
for items based on the template string. See :class:`~pystac.layout.LayoutTemplate`
for details on the construction of template strings. This template string
will be applied to the items, and subcatalogs will be created that separate
and organize the items based on template values.
Args:
template (str): A template string that
can be consumed by a :class:`~pystac.layout.LayoutTemplate`
defaults (dict): Default values for the template variables
that will be used if the property cannot be found on
the item.
parent_ids (List[str]): Optional list of the parent catalogs'
identifiers. If the bottom-most subcatalags already match the
template, no subcatalog is added.
Returns:
[catalog]: List of new catalogs created
"""
result = []
parent_ids = parent_ids or list()
parent_ids.append(self.id)
for child in self.get_children():
result.extend(
child.generate_subcatalogs(template,
defaults=defaults,
parent_ids=parent_ids.copy()))
layout_template = LayoutTemplate(template, defaults=defaults)
keep_item_links = []
item_links = [lk for lk in self.links if lk.rel == 'item']
for link in item_links:
link.resolve_stac_object(root=self.get_root())
item = link.target
item_parts = layout_template.get_template_values(item)
id_iter = reversed(parent_ids)
if all(['{}'.format(id) == next(id_iter, None)
for id in reversed(item_parts.values())]):
# Skip items for which the sub-catalog structure already
# matches the template. The list of parent IDs can include more
# elements on the root side, so compare the reversed sequences.
keep_item_links.append(link)
continue
curr_parent = self
for k, v in item_parts.items():
subcat_id = '{}'.format(v)
subcat = curr_parent.get_child(subcat_id)
if subcat is None:
subcat_desc = 'Catalog of items from {} with {} of {}'.format(
curr_parent.id, k, v)
subcat = pystac.Catalog(id=subcat_id, description=subcat_desc)
curr_parent.add_child(subcat)
result.append(subcat)
curr_parent = subcat
# resolve collection link so when added back points to correct location
link = item.get_single_link('collection')
if link is not None:
link.resolve_stac_object()
curr_parent.add_item(item)
# keep only non-item links and item links that have not been moved elsewhere
self.links = [lk for lk in self.links if lk.rel != 'item'] + keep_item_links
return result
[docs] def save(self, catalog_type=None):
"""Save this catalog and all it's children/item to files determined by the object's
self link HREF.
Args:
catalog_type (str): The catalog type that dictates the structure of
the catalog to save. Use a member of :class:`~pystac.CatalogType`.
If not supplied, the catalog_type of this catalog will be used.
If that attribute is not set, an exception will be raised.
Note:
If the catalog type is ``CatalogType.ABSOLUTE_PUBLISHED``,
all self links will be included, and hierarchical links be absolute URLs.
If the catalog type is ``CatalogType.RELATIVE_PUBLISHED``, this catalog's self
link will be included, but no child catalog will have self links, and
hierarchical links will be relative URLs
If the catalog type is ``CatalogType.SELF_CONTAINED``, no self links will be
included and hierarchical links will be relative URLs.
"""
root = self.get_root()
if root is None:
raise Exception('There is no root catalog')
if catalog_type is not None:
root.catalog_type = catalog_type
items_include_self_link = root.catalog_type in [CatalogType.ABSOLUTE_PUBLISHED]
for child_link in self.get_child_links():
if child_link.is_resolved():
child_link.target.save()
for item_link in self.get_item_links():
if item_link.is_resolved():
item_link.target.save_object(include_self_link=items_include_self_link)
include_self_link = False
# include a self link if this is the root catalog or if ABSOLUTE_PUBLISHED catalog
if ((self.get_self_href() == self.get_root_link().get_absolute_href()
and root.catalog_type != CatalogType.SELF_CONTAINED)
or root.catalog_type == CatalogType.ABSOLUTE_PUBLISHED):
include_self_link = True
self.save_object(include_self_link=include_self_link)
self.catalog_type = catalog_type
[docs] def walk(self):
"""Walks through children and items of catalogs.
For each catalog in the STAC's tree rooted at this catalog (including this catalog
itself), it yields a 3-tuple (root, subcatalogs, items). The root in that
3-tuple refers to the current catalog being walked, the subcatalogs are any
catalogs or collections for which the root is a parent, and items represents
any items that have the root as a parent.
This has similar functionality to Python's :func:`os.walk`.
Returns:
Generator[(Catalog, Generator[Catalog], Generator[Item])]: A generator that
yields a 3-tuple (parent_catalog, children, items).
"""
children = self.get_children()
items = self.get_items()
yield (self, children, items)
for child in self.get_children():
yield from child.walk()
[docs] def validate_all(self):
"""Validates each catalog, collection contained within this catalog.
Walks through the children and items of the catalog and validates each
stac object.
Raises:
STACValidationError: Raises this error on any item that is invalid.
Will raise on the first invalid stac object encountered.
"""
self.validate()
for child in self.get_children():
child.validate_all()
for item in self.get_items():
item.validate()
def _object_links(self):
return ['child', 'item'] + (pystac.STAC_EXTENSIONS.get_extended_object_links(self))
[docs] def map_items(self, item_mapper):
"""Creates a copy of a catalog, with each item passed through the
item_mapper function.
Args:
item_mapper (Callable): A function that takes in an item, and returns either
an item or list of items. The item that is passed into the item_mapper
is a copy, so the method can mutate it safely.
Returns:
Catalog: A full copy of this catalog, with items manipulated according
to the item_mapper function.
"""
new_cat = self.full_copy()
def process_catalog(catalog):
for child in catalog.get_children():
process_catalog(child)
item_links = []
for item_link in catalog.get_item_links():
item_link.resolve_stac_object(root=self.get_root())
mapped = item_mapper(item_link.target)
if mapped is None:
raise Exception('item_mapper cannot return None.')
if type(mapped) is not list:
item_link.target = mapped
item_links.append(item_link)
else:
for i in mapped:
new_link = item_link.clone()
new_link.target = i
item_links.append(new_link)
catalog.clear_items()
catalog.add_links(item_links)
process_catalog(new_cat)
return new_cat
[docs] def map_assets(self, asset_mapper):
"""Creates a copy of a catalog, with each Asset for each Item passed
through the asset_mapper function.
Args:
asset_mapper (Callable): A function that takes in an key and an Asset, and returns
either an Asset, a (key, Asset), or a dictionary of Assets with unique keys.
The Asset that is passed into the item_mapper is a copy, so the method can
mutate it safely.
Returns:
Catalog: A full copy of this catalog, with assets manipulated according
to the asset_mapper function.
"""
def apply_asset_mapper(tup):
k, v = tup
result = asset_mapper(k, v)
if result is None:
raise Exception('asset_mapper cannot return None.')
if isinstance(result, pystac.Asset):
return [(k, result)]
elif isinstance(result, tuple):
return [result]
else:
assets = list(result.items())
if len(assets) < 1:
raise Exception('asset_mapper must return a non-empy list')
return assets
def item_mapper(item):
new_assets = [
x for result in map(apply_asset_mapper, item.assets.items()) for x in result
]
item.assets = dict(new_assets)
return item
return self.map_items(item_mapper)
[docs] def describe(self, include_hrefs=False, _indent=0):
"""Prints out information about this Catalog and all contained
STACObjects.
Args:
include_hrefs (bool) - If True, print out each object's self link
HREF along with the object ID.
"""
s = '{}* {}'.format(' ' * _indent, self)
if include_hrefs:
s += ' {}'.format(self.get_self_href())
print(s)
for child in self.get_children():
child.describe(include_hrefs=include_hrefs, _indent=_indent + 4)
for item in self.get_items():
s = '{}* {}'.format(' ' * (_indent + 2), item)
if include_hrefs:
s += ' {}'.format(item.get_self_href())
print(s)
[docs] @classmethod
def from_dict(cls, d, href=None, root=None):
catalog_type = CatalogType.determine_type(d)
d = deepcopy(d)
id = d.pop('id')
description = d.pop('description')
title = d.pop('title', None)
stac_extensions = d.pop('stac_extensions', None)
links = d.pop('links')
d.pop('stac_version')
cat = Catalog(id=id,
description=description,
title=title,
stac_extensions=stac_extensions,
extra_fields=d,
href=href,
catalog_type=catalog_type)
for link in links:
if link['rel'] == 'root':
# Remove the link that's generated in Catalog's constructor.
cat.remove_links('root')
if link['rel'] != 'self' or href is None:
cat.add_link(Link.from_dict(link))
return cat
