Source code for tamr_unify_client.categorization.taxonomy

from tamr_unify_client.base_resource import BaseResource
from tamr_unify_client.categorization.category.collection import CategoryCollection


class Taxonomy(BaseResource):
    """A project's taxonomy"""

    @classmethod
    def from_json(cls, client, data, api_path):
        return super().from_data(client, data, api_path)

    @property
    def name(self):
        """:type: str"""
        return self._data.get("name")

    def categories(self):
        """Retrieves the categories of this taxonomy.

        :returns: A collection of the taxonomy categories.
        :rtype: :class:`~tamr_unify_client.categorization.category.collection.CategoryCollection`
        """
        alias = self.api_path + "/categories"
        return CategoryCollection(self.client, alias)

    def __repr__(self):
        return (
            f"{self.__class__.__module__}."
            f"{self.__class__.__qualname__}("
            f"relative_id={self.relative_id!r}, "
            f"name={self.name!r})"
        )