Skip to content

Collection

pystac.Collection

Bases: Container

Source code in src/pystac/collection.py 
 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
class Collection(Container):
    @classmethod
    def get_type(cls) -> str:
        return COLLECTION_TYPE

    def __init__(
        self,
        id: str,
        description: str,
        extent: Extent | dict[str, Any] | None = None,
        title: str | None = None,
        stac_extensions: list[str] | None = None,
        *,
        keywords: list[str] | None = None,
        license: str = DEFAULT_LICENSE,
        providers: list[Provider | dict[str, Any]] | None = None,
        summaries: dict[str, Any] | None = None,
        assets: dict[str, Asset | dict[str, Any]] | None = None,
        item_assets: dict[str, ItemAsset | dict[str, Any]] | None = None,
        stac_version: str | None = None,
        links: list[Link | dict[str, Any]] | None = None,
        **kwargs: Any,
    ):
        """Creates a new collection."""
        self.description = description
        self.title = title
        self.keywords = keywords
        self.license = license
        self.summaries = summaries

        if providers is None:
            self.providers = None
        else:
            self.providers = [
                provider
                if isinstance(provider, Provider)
                else Provider.from_dict(provider)
                for provider in providers
            ]

        if extent is None:
            self.extent = Extent()
        elif isinstance(extent, Extent):
            self.extent = extent
        else:
            self.extent = Extent.from_dict(extent)

        if item_assets is None:
            self.item_assets = None
        else:
            self.item_assets = dict(
                (
                    key,
                    item_asset
                    if isinstance(item_asset, ItemAsset)
                    else ItemAsset.from_dict(item_asset),
                )
                for key, item_asset in item_assets.items()
            )

        super().__init__(
            id=id,
            stac_version=stac_version,
            stac_extensions=stac_extensions,
            links=links,
            assets=assets,
            **kwargs,
        )

    def _to_dict(self) -> dict[str, Any]:
        """Converts this collection to a dictionary."""
        d: dict[str, Any] = {
            "type": self.get_type(),
            "stac_version": self.stac_version,
        }
        if self.stac_extensions is not None:
            d["stac_extensions"] = self.stac_extensions
        d["id"] = self.id
        if self.title is not None:
            d["title"] = self.title
        d["description"] = self.description
        if self.keywords is not None:
            d["keywords"] = self.keywords
        d["license"] = self.license
        if self.providers is not None:
            d["providers"] = [provider.to_dict() for provider in self.providers]
        d["extent"] = self.extent.to_dict()
        if self.summaries is not None:
            d["summaries"] = self.summaries
        d["links"] = [link.to_dict() for link in self.iter_links()]
        if self.assets:
            d["assets"] = dict(
                (key, asset.to_dict()) for key, asset in self.assets.items()
            )
        if self.item_assets is not None:
            d["item_assets"] = dict(
                (key, item_asset.to_dict())
                for key, item_asset in self.item_assets.items()
            )
        d.update(copy.deepcopy(self.extra_fields))
        return d

__init__ 

__init__(
    id: str,
    description: str,
    extent: Extent | dict[str, Any] | None = None,
    title: str | None = None,
    stac_extensions: list[str] | None = None,
    *,
    keywords: list[str] | None = None,
    license: str = DEFAULT_LICENSE,
    providers: list[Provider | dict[str, Any]]
    | None = None,
    summaries: dict[str, Any] | None = None,
    assets: dict[str, Asset | dict[str, Any]] | None = None,
    item_assets: dict[str, ItemAsset | dict[str, Any]]
    | None = None,
    stac_version: str | None = None,
    links: list[Link | dict[str, Any]] | None = None,
    **kwargs: Any,
)

Creates a new collection.

Source code in src/pystac/collection.py 
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
def __init__(
    self,
    id: str,
    description: str,
    extent: Extent | dict[str, Any] | None = None,
    title: str | None = None,
    stac_extensions: list[str] | None = None,
    *,
    keywords: list[str] | None = None,
    license: str = DEFAULT_LICENSE,
    providers: list[Provider | dict[str, Any]] | None = None,
    summaries: dict[str, Any] | None = None,
    assets: dict[str, Asset | dict[str, Any]] | None = None,
    item_assets: dict[str, ItemAsset | dict[str, Any]] | None = None,
    stac_version: str | None = None,
    links: list[Link | dict[str, Any]] | None = None,
    **kwargs: Any,
):
    """Creates a new collection."""
    self.description = description
    self.title = title
    self.keywords = keywords
    self.license = license
    self.summaries = summaries

    if providers is None:
        self.providers = None
    else:
        self.providers = [
            provider
            if isinstance(provider, Provider)
            else Provider.from_dict(provider)
            for provider in providers
        ]

    if extent is None:
        self.extent = Extent()
    elif isinstance(extent, Extent):
        self.extent = extent
    else:
        self.extent = Extent.from_dict(extent)

    if item_assets is None:
        self.item_assets = None
    else:
        self.item_assets = dict(
            (
                key,
                item_asset
                if isinstance(item_asset, ItemAsset)
                else ItemAsset.from_dict(item_asset),
            )
            for key, item_asset in item_assets.items()
        )

    super().__init__(
        id=id,
        stac_version=stac_version,
        stac_extensions=stac_extensions,
        links=links,
        assets=assets,
        **kwargs,
    )

_to_dict 

_to_dict() -> dict[str, Any]

Converts this collection to a dictionary.

Source code in src/pystac/collection.py 
 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
def _to_dict(self) -> dict[str, Any]:
    """Converts this collection to a dictionary."""
    d: dict[str, Any] = {
        "type": self.get_type(),
        "stac_version": self.stac_version,
    }
    if self.stac_extensions is not None:
        d["stac_extensions"] = self.stac_extensions
    d["id"] = self.id
    if self.title is not None:
        d["title"] = self.title
    d["description"] = self.description
    if self.keywords is not None:
        d["keywords"] = self.keywords
    d["license"] = self.license
    if self.providers is not None:
        d["providers"] = [provider.to_dict() for provider in self.providers]
    d["extent"] = self.extent.to_dict()
    if self.summaries is not None:
        d["summaries"] = self.summaries
    d["links"] = [link.to_dict() for link in self.iter_links()]
    if self.assets:
        d["assets"] = dict(
            (key, asset.to_dict()) for key, asset in self.assets.items()
        )
    if self.item_assets is not None:
        d["item_assets"] = dict(
            (key, item_asset.to_dict())
            for key, item_asset in self.item_assets.items()
        )
    d.update(copy.deepcopy(self.extra_fields))
    return d