Skip to content

filter

stac_fastapi.extensions.core.filter.filter

Filter Extension.

CollectionSearchFilterExtension

Bases: FilterExtension

Collection Search Filter Extension.

Source code in stac_fastapi/extensions/core/filter/filter.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
@attr.s
class CollectionSearchFilterExtension(FilterExtension):
    """Collection Search Filter Extension."""

    conformance_classes: List[str] = attr.ib(
        default=[
            FilterConformanceClasses.FILTER,
            FilterConformanceClasses.COLLECTIONS,
            FilterConformanceClasses.BASIC_CQL2,
            FilterConformanceClasses.CQL2_JSON,
            FilterConformanceClasses.CQL2_TEXT,
        ]
    )

    def register(self, app: FastAPI) -> None:
        """Register the extension with a FastAPI application.

        Args:
            app: target FastAPI application.

        Returns:
            None
        """
        pass

register 

register(app: FastAPI) -> None

Register the extension with a FastAPI application.

Parameters:

  • app (FastAPI) –

    target FastAPI application.

Returns:

  • None –

    None

Source code in stac_fastapi/extensions/core/filter/filter.py 
234
235
236
237
238
239
240
241
242
243
def register(self, app: FastAPI) -> None:
    """Register the extension with a FastAPI application.

    Args:
        app: target FastAPI application.

    Returns:
        None
    """
    pass

FilterConformanceClasses

Bases: str, Enum

Conformance classes for the Filter extension.

See stac-api-extensions/filter

Source code in stac_fastapi/extensions/core/filter/filter.py 
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
class FilterConformanceClasses(str, Enum):
    """Conformance classes for the Filter extension.

    See
    https://github.com/stac-api-extensions/filter
    """

    FILTER = "http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter"

    SEARCH = "https://api.stacspec.org/v1.0.0-rc.2/item-search#filter"
    ITEMS = "http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter"
    COLLECTIONS = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#filter"

    CQL2_TEXT = "http://www.opengis.net/spec/cql2/1.0/conf/cql2-text"
    CQL2_JSON = "http://www.opengis.net/spec/cql2/1.0/conf/cql2-json"
    BASIC_CQL2 = "http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2"
    BASIC_SPATIAL_FUNCTIONS = (
        "http://www.opengis.net/spec/cql2/1.0/conf/basic-spatial-functions"
    )
    TEMPORAL_FUNCTIONS = "http://www.opengis.net/spec/cql2/1.0/conf/temporal-functions"
    ADVANCED_COMPARISON_OPERATORS = (
        "http://www.opengis.net/spec/cql2/1.0/conf/advanced-comparison-operators"
    )
    SPATIAL_FUNCTIONS = "http://www.opengis.net/spec/cql2/1.0/conf/spatial-functions"
    FUNCTIONS = "http://www.opengis.net/spec/cql2/1.0/conf/functions"
    ARITHMETIC = "http://www.opengis.net/spec/cql2/1.0/conf/arithmetic"
    ARRAY_FUNCTIONS = "http://www.opengis.net/spec/cql2/1.0/conf/array-functions"
    PROPERTY_PROPERTY = "http://www.opengis.net/spec/cql2/1.0/conf/property-property"
    CASE_INSENSITIVE_COMPARISON = (
        "http://www.opengis.net/spec/cql2/1.0/conf/case-insensitive-comparison"
    )
    ACCENT_INSENSITIVE_COMPARISON = (
        "http://www.opengis.net/spec/cql2/1.0/conf/accent-insensitive-comparison"
    )
    BASIC_SPATIAL_FUNCTIONS_PLUS = (
        "http://www.opengis.net/spec/cql2/1.0/conf/basic-spatial-functions-plus"
    )

FilterExtension

Bases: ApiExtension

Filter Extension.

The filter extension adds several endpoints which allow the retrieval of queryables and provides an expressive mechanism for searching based on Item Attributes: GET /queryables GET /collections/{collection_id}/queryables

github.com/stac-api-extensions/filter/blob/main/README.md

Attributes:

  • client (Union[AsyncBaseFiltersClient, BaseFiltersClient]) –

    Queryables endpoint logic

  • conformance_classes (List[str]) –

    Conformance classes provided by the extension

Source code in stac_fastapi/extensions/core/filter/filter.py 
 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
@attr.s
class FilterExtension(ApiExtension):
    """Filter Extension.

    The filter extension adds several endpoints which allow the retrieval of
    queryables and provides an expressive mechanism for searching based on Item
    Attributes:
        GET /queryables
        GET /collections/{collection_id}/queryables

    https://github.com/stac-api-extensions/filter/blob/main/README.md

    Attributes:
        client: Queryables endpoint logic
        conformance_classes: Conformance classes provided by the extension
    """

    GET = FilterExtensionGetRequest
    POST = FilterExtensionPostRequest

    client: Union[AsyncBaseFiltersClient, BaseFiltersClient] = attr.ib(
        factory=BaseFiltersClient
    )
    conformance_classes: List[str] = attr.ib(
        default=[
            FilterConformanceClasses.FILTER,
            FilterConformanceClasses.SEARCH,
            FilterConformanceClasses.ITEMS,
            FilterConformanceClasses.BASIC_CQL2,
            FilterConformanceClasses.CQL2_JSON,
            FilterConformanceClasses.CQL2_TEXT,
        ]
    )
    router: APIRouter = attr.ib(factory=APIRouter)
    response_class: Type[Response] = attr.ib(default=JSONSchemaResponse)

    def register(self, app: FastAPI) -> None:
        """Register the extension with a FastAPI application.

        Args:
            app: target FastAPI application.

        Returns:
            None
        """
        self.router.prefix = app.state.router_prefix
        self.router.add_api_route(
            name="Queryables",
            path="/queryables",
            methods=["GET"],
            responses={
                200: {
                    "content": {
                        "application/schema+json": {},
                    },
                    # TODO: add output model in stac-pydantic
                },
            },
            response_class=self.response_class,
            endpoint=create_async_endpoint(self.client.get_queryables, EmptyRequest),
        )
        self.router.add_api_route(
            name="Collection Queryables",
            path="/collections/{collection_id}/queryables",
            methods=["GET"],
            responses={
                200: {
                    "content": {
                        "application/schema+json": {},
                    },
                    # TODO: add output model in stac-pydantic
                },
            },
            response_class=self.response_class,
            endpoint=create_async_endpoint(self.client.get_queryables, CollectionUri),
        )
        app.include_router(self.router, tags=["Filter Extension"])

register 

register(app: FastAPI) -> None

Register the extension with a FastAPI application.

Parameters:

  • app (FastAPI) –

    target FastAPI application.

Returns:

  • None –

    None

Source code in stac_fastapi/extensions/core/filter/filter.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def register(self, app: FastAPI) -> None:
    """Register the extension with a FastAPI application.

    Args:
        app: target FastAPI application.

    Returns:
        None
    """
    self.router.prefix = app.state.router_prefix
    self.router.add_api_route(
        name="Queryables",
        path="/queryables",
        methods=["GET"],
        responses={
            200: {
                "content": {
                    "application/schema+json": {},
                },
                # TODO: add output model in stac-pydantic
            },
        },
        response_class=self.response_class,
        endpoint=create_async_endpoint(self.client.get_queryables, EmptyRequest),
    )
    self.router.add_api_route(
        name="Collection Queryables",
        path="/collections/{collection_id}/queryables",
        methods=["GET"],
        responses={
            200: {
                "content": {
                    "application/schema+json": {},
                },
                # TODO: add output model in stac-pydantic
            },
        },
        response_class=self.response_class,
        endpoint=create_async_endpoint(self.client.get_queryables, CollectionUri),
    )
    app.include_router(self.router, tags=["Filter Extension"])

ItemCollectionFilterExtension

Bases: FilterExtension

Item Collection Filter Extension.

Source code in stac_fastapi/extensions/core/filter/filter.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
@attr.s
class ItemCollectionFilterExtension(FilterExtension):
    """Item Collection Filter Extension."""

    conformance_classes: List[str] = attr.ib(
        default=[
            FilterConformanceClasses.FILTER,
            FilterConformanceClasses.ITEMS,
            FilterConformanceClasses.BASIC_CQL2,
            FilterConformanceClasses.CQL2_JSON,
            FilterConformanceClasses.CQL2_TEXT,
        ]
    )

    def register(self, app: FastAPI) -> None:
        """Register the extension with a FastAPI application.

        Args:
            app: target FastAPI application.

        Returns:
            None
        """
        self.router.prefix = app.state.router_prefix
        self.router.add_api_route(
            name="Collection Queryables",
            path="/collections/{collection_id}/queryables",
            methods=["GET"],
            responses={
                200: {
                    "content": {
                        "application/schema+json": {},
                    },
                    # TODO: add output model in stac-pydantic
                },
            },
            response_class=self.response_class,
            endpoint=create_async_endpoint(self.client.get_queryables, CollectionUri),
        )
        app.include_router(self.router, tags=["Filter Extension"])

register 

register(app: FastAPI) -> None

Register the extension with a FastAPI application.

Parameters:

  • app (FastAPI) –

    target FastAPI application.

Returns:

  • None –

    None

Source code in stac_fastapi/extensions/core/filter/filter.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def register(self, app: FastAPI) -> None:
    """Register the extension with a FastAPI application.

    Args:
        app: target FastAPI application.

    Returns:
        None
    """
    self.router.prefix = app.state.router_prefix
    self.router.add_api_route(
        name="Collection Queryables",
        path="/collections/{collection_id}/queryables",
        methods=["GET"],
        responses={
            200: {
                "content": {
                    "application/schema+json": {},
                },
                # TODO: add output model in stac-pydantic
            },
        },
        response_class=self.response_class,
        endpoint=create_async_endpoint(self.client.get_queryables, CollectionUri),
    )
    app.include_router(self.router, tags=["Filter Extension"])

SearchFilterExtension

Bases: FilterExtension

Item Search Filter Extension.

Source code in stac_fastapi/extensions/core/filter/filter.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
@attr.s
class SearchFilterExtension(FilterExtension):
    """Item Search Filter Extension."""

    conformance_classes: List[str] = attr.ib(
        default=[
            FilterConformanceClasses.FILTER,
            FilterConformanceClasses.SEARCH,
            FilterConformanceClasses.BASIC_CQL2,
            FilterConformanceClasses.CQL2_JSON,
            FilterConformanceClasses.CQL2_TEXT,
        ]
    )

    def register(self, app: FastAPI) -> None:
        """Register the extension with a FastAPI application.

        Args:
            app: target FastAPI application.

        Returns:
            None
        """
        self.router.prefix = app.state.router_prefix
        self.router.add_api_route(
            name="Queryables",
            path="/queryables",
            methods=["GET"],
            responses={
                200: {
                    "content": {
                        "application/schema+json": {},
                    },
                    # TODO: add output model in stac-pydantic
                },
            },
            response_class=self.response_class,
            endpoint=create_async_endpoint(self.client.get_queryables, EmptyRequest),
        )
        app.include_router(self.router, tags=["Filter Extension"])

register 

register(app: FastAPI) -> None

Register the extension with a FastAPI application.

Parameters:

  • app (FastAPI) –

    target FastAPI application.

Returns:

  • None –

    None

Source code in stac_fastapi/extensions/core/filter/filter.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def register(self, app: FastAPI) -> None:
    """Register the extension with a FastAPI application.

    Args:
        app: target FastAPI application.

    Returns:
        None
    """
    self.router.prefix = app.state.router_prefix
    self.router.add_api_route(
        name="Queryables",
        path="/queryables",
        methods=["GET"],
        responses={
            200: {
                "content": {
                    "application/schema+json": {},
                },
                # TODO: add output model in stac-pydantic
            },
        },
        response_class=self.response_class,
        endpoint=create_async_endpoint(self.client.get_queryables, EmptyRequest),
    )
    app.include_router(self.router, tags=["Filter Extension"])