Module stac_fastapi.opensearch.app¶

FastAPI application.

Variables¶

python3 ENABLE_CATALOGS_ROUTE

python3 ENABLE_COLLECTIONS_SEARCH

python3 ENABLE_COLLECTIONS_SEARCH_ROUTE

python3 TRANSACTIONS_EXTENSIONS

python3 aggregation_extension

python3 api

python3 app

python3 app_config

python3 collection_search_extensions

python3 database_logic

python3 extensions

python3 fields_extension

python3 filter_extension

python3 handler

python3 logger

python3 search_extensions

python3 sentry_enable

python3 session

python3 settings

Functions¶

create_handler¶

python3 def create_handler( app )

Create a handler to use with AWS Lambda if mangum available.

lifespan¶

python3 def lifespan( app: fastapi.applications.FastAPI )

Lifespan handler for FastAPI app. Initializes index templates and collections at startup.

run¶

```python3 def run(

) -> None ```

Run app from command line using uvicorn if available.

Classes¶

collections_get_request_model¶

python3 class collections_get_request_model( bbox: Annotated[Optional[str], Query(PydanticUndefined)] = None, datetime: Annotated[Optional[str], Query(PydanticUndefined)] = None, limit: Annotated[Optional[Annotated[int, Gt(gt=0), AfterValidator(func=<function crop at 0x7f8cac00b7e0>)]], Query(PydanticUndefined)] = 10, query: Annotated[Optional[str], Query(PydanticUndefined)] = None, sortby: Annotated[Optional[str], Query(PydanticUndefined)] = None, fields: Annotated[Optional[str], Query(PydanticUndefined)] = None, filter_expr: Annotated[Optional[str], Query(PydanticUndefined)] = None, filter_crs: Annotated[Optional[str], Query(PydanticUndefined)] = None, filter_lang: Annotated[Optional[Literal['cql2-json', 'cql2-text']], Query(PydanticUndefined)] = 'cql2-text', q: Annotated[Optional[str], Query(PydanticUndefined)] = None )

Basics additional Collection-Search parameters for the GET request.

Ancestors (in MRO)¶

stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest
stac_fastapi.extensions.core.query.request.QueryExtensionGetRequest
stac_fastapi.extensions.core.sort.request.SortExtensionGetRequest
stac_fastapi.extensions.core.fields.request.FieldsExtensionGetRequest
stac_fastapi.extensions.core.filter.request.FilterExtensionGetRequest
stac_fastapi.extensions.core.free_text.request.FreeTextExtensionGetRequest
stac_fastapi.types.search.APIRequest
stac_fastapi.types.search.DatetimeMixin

Instance variables¶

python3 end_date

End Date.

python3 start_date

Start Date.

Methods¶

kwargs¶

python3 def kwargs( self ) -> Dict

Transform api request params into format which matches the signature of the

endpoint.

parse_datetime¶

python3 def parse_datetime( self ) -> Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType]

Return Datetime objects.

items_get_request_model¶

python3 class items_get_request_model( collection_id: Annotated[str, Path(PydanticUndefined)], limit: Annotated[Optional[Annotated[int, Gt(gt=0), AfterValidator(func=<function crop at 0x7f8cac00b7e0>)]], Query(PydanticUndefined)] = 10, bbox: Annotated[Optional[str], Query(PydanticUndefined)] = None, datetime: Annotated[Optional[str], Query(PydanticUndefined)] = None, sortby: Annotated[Optional[str], Query(PydanticUndefined)] = None, query: Annotated[Optional[str], Query(PydanticUndefined)] = None, filter_expr: Annotated[Optional[str], Query(PydanticUndefined)] = None, filter_crs: Annotated[Optional[str], Query(PydanticUndefined)] = None, filter_lang: Annotated[Optional[Literal['cql2-json', 'cql2-text']], Query(PydanticUndefined)] = 'cql2-text', fields: Annotated[Optional[str], Query(PydanticUndefined)] = None, q: Annotated[Optional[str], Query(PydanticUndefined)] = None )

Get item collection.

Ancestors (in MRO)¶

stac_fastapi.api.models.ItemCollectionUri
stac_fastapi.extensions.core.sort.request.SortExtensionGetRequest
stac_fastapi.extensions.core.query.request.QueryExtensionGetRequest
stac_fastapi.extensions.core.filter.request.FilterExtensionGetRequest
stac_fastapi.extensions.core.fields.request.FieldsExtensionGetRequest
stac_fastapi.extensions.core.free_text.request.FreeTextExtensionGetRequest
stac_fastapi.types.search.APIRequest
stac_fastapi.types.search.DatetimeMixin

Instance variables¶

python3 end_date

End Date.

python3 start_date

Start Date.

Methods¶

kwargs¶

python3 def kwargs( self ) -> Dict

Transform api request params into format which matches the signature of the

endpoint.

parse_datetime¶

python3 def parse_datetime( self ) -> Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType]

Return Datetime objects.

post_request_model¶

python3 class post_request_model( /, **data: 'Any' )

Base arguments for POST Request.

Ancestors (in MRO)¶

stac_fastapi.types.search.BaseSearchPostRequest
stac_pydantic.api.search.Search
pydantic.main.BaseModel

Class variables¶

python3 model_computed_fields

python3 model_config

python3 model_fields

Static methods¶

construct¶

python3 def construct( _fields_set: 'set[str] | None' = None, **values: 'Any' ) -> 'Self'

from_orm¶

python3 def from_orm( obj: 'Any' ) -> 'Self'

model_construct¶

python3 def model_construct( _fields_set: 'set[str] | None' = None, **values: 'Any' ) -> 'Self'

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

Note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance's __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:

Name	Type	Description	Default
_fields_set	None	A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [`model_fields_set`][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the `values` argument will be used.	None
values	None	Trusted or pre-validated data dictionary.	None

Returns:

Type	Description
None	A new instance of the `Model` class with validated data.

model_json_schema¶

python3 def model_json_schema( by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}', schema_generator: 'type[GenerateJsonSchema]' = <class 'pydantic.json_schema.GenerateJsonSchema'>, mode: 'JsonSchemaMode' = 'validation', *, union_format: "Literal['any_of', 'primitive_type_array']" = 'any_of' ) -> 'dict[str, Any]'

Generates a JSON schema for a model class.

Parameters:

Name	Type	Description	Default
by_alias	None	Whether to use attribute aliases or not.	None
ref_template	None	The reference template.	None
union_format	None	The format to use when combining schemas from unions together. Can be one of: - `'any_of'`: Use the `anyOf` keyword to combine schemas (the default). - `'primitive_type_array'`: Use the `type` keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (`string`, `boolean`, `null`, `integer` or `number`) or contains constraints/metadata, falls back to `any_of`.	None
schema_generator	None	To override the logic used to generate the JSON schema, as a subclass of `GenerateJsonSchema` with your desired modifications	None
mode	None	The mode in which to generate the schema.	None

Returns:

Type	Description
None	The JSON schema for the given model class.

model_parametrized_name¶

python3 def model_parametrized_name( params: 'tuple[type[Any], ...]' ) -> 'str'

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:

Name	Type	Description	Default
params	None	Tuple of types of the class. Given a generic class `Model` with 2 type variables and a concrete model `Model[str, int]`, the value `(str, int)` would be passed to `params`.	None

Returns:

Type	Description
None	String representing the new class where `params` are passed to `cls` as type variables.

Raises:

Type	Description
TypeError	Raised when trying to generate concrete names for non-generic models.

model_rebuild¶

python3 def model_rebuild( *, force: 'bool' = False, raise_errors: 'bool' = True, _parent_namespace_depth: 'int' = 2, _types_namespace: 'MappingNamespace | None' = None ) -> 'bool | None'

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Parameters:

Name	Type	Description	Default
force	None	Whether to force the rebuilding of the model schema, defaults to `False`.	None
raise_errors	None	Whether to raise errors, defaults to `True`.	None
_parent_namespace_depth	None	The depth level of the parent namespace, defaults to 2.	None
_types_namespace	None	The types namespace, defaults to `None`.	None

Returns:

Type	Description
None	Returns `None` if the schema is already "complete" and rebuilding was not required. If rebuilding was required, returns `True` if rebuilding was successful, otherwise `False`.

model_validate¶

Validate a pydantic model instance.

Parameters:

Name	Type	Description	Default
obj	None	The object to validate.	None
strict	None	Whether to enforce types strictly.	None
extra	None	Whether to ignore, allow, or forbid extra data during model validation. See the [`extra` configuration value][pydantic.ConfigDict.extra] for details.	None
from_attributes	None	Whether to extract data from object attributes.	None
context	None	Additional context to pass to the validator.	None
by_alias	None	Whether to use the field's alias when validating against the provided input data.	None
by_name	None	Whether to use the field's name when validating against the provided input data.	None

Returns:

Type	Description
None	The validated model instance.

Raises:

Type	Description
ValidationError	If the object could not be validated.

model_validate_json¶

Usage Documentation

JSON Parsing

Validate the given JSON data against the Pydantic model.

Parameters:

Name	Type	Description	Default
json_data	None	The JSON data to validate.	None
strict	None	Whether to enforce types strictly.	None
extra	None	Whether to ignore, allow, or forbid extra data during model validation. See the [`extra` configuration value][pydantic.ConfigDict.extra] for details.	None
context	None	Extra variables to pass to the validator.	None
by_alias	None	Whether to use the field's alias when validating against the provided input data.	None
by_name	None	Whether to use the field's name when validating against the provided input data.	None

Returns:

Type	Description
None	The validated Pydantic model.

Raises:

Type	Description
ValidationError	If `json_data` is not a JSON string or the object could not be validated.

model_validate_strings¶

Validate the given object with string data against the Pydantic model.

Parameters:

Name	Type	Description	Default
obj	None	The object containing string data to validate.	None
strict	None	Whether to enforce types strictly.	None
extra	None	Whether to ignore, allow, or forbid extra data during model validation. See the [`extra` configuration value][pydantic.ConfigDict.extra] for details.	None
context	None	Extra variables to pass to the validator.	None
by_alias	None	Whether to use the field's alias when validating against the provided input data.	None
by_name	None	Whether to use the field's name when validating against the provided input data.	None

Returns:

Type	Description
None	The validated Pydantic model.

parse_file¶

python3 def parse_file( path: 'str | Path', *, content_type: 'str | None' = None, encoding: 'str' = 'utf8', proto: 'DeprecatedParseProtocol | None' = None, allow_pickle: 'bool' = False ) -> 'Self'

parse_obj¶

python3 def parse_obj( obj: 'Any' ) -> 'Self'

parse_raw¶

python3 def parse_raw( b: 'str | bytes', *, content_type: 'str | None' = None, encoding: 'str' = 'utf8', proto: 'DeprecatedParseProtocol | None' = None, allow_pickle: 'bool' = False ) -> 'Self'

schema¶

python3 def schema( by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}' ) -> 'Dict[str, Any]'

schema_json¶

python3 def schema_json( *, by_alias: 'bool' = True, ref_template: 'str' = '#/$defs/{model}', **dumps_kwargs: 'Any' ) -> 'str'

update_forward_refs¶

python3 def update_forward_refs( **localns: 'Any' ) -> 'None'

validate¶

python3 def validate( value: 'Any' ) -> 'Self'

validate_spatial¶

python3 def validate_spatial( values: Dict[str, Any] ) -> Dict[str, Any]

Instance variables¶

python3 end_date

python3 model_extra

Get extra fields set during validation.

python3 model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

python3 spatial_filter

Return a geojson-pydantic object representing the spatial filter for the search request.

Check for both because the bbox and intersects parameters are mutually exclusive.

python3 start_date

Methods¶

copy¶

Returns a copy of the model.

Deprecated

This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data)

Parameters:

Name	Type	Description	Default
include	None	Optional set or mapping specifying which fields to include in the copied model.	None
exclude	None	Optional set or mapping specifying which fields to exclude in the copied model.	None
update	None	Optional dictionary of field-value pairs to override field values in the copied model.	None
deep	None	If True, the values of fields that are Pydantic models will be deep-copied.	None

Returns:

Type	Description
None	A copy of the model with included, excluded and updated fields as specified.

dict¶

python3 def dict( self, *, include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, by_alias: 'bool' = False, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False ) -> 'Dict[str, Any]'

json¶

python3 def json( self, *, include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, by_alias: 'bool' = False, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, encoder: 'Callable[[Any], Any] | None' = PydanticUndefined, models_as_dict: 'bool' = PydanticUndefined, **dumps_kwargs: 'Any' ) -> 'str'

model_copy¶

python3 def model_copy( self, *, update: 'Mapping[str, Any] | None' = None, deep: 'bool' = False ) -> 'Self'

Usage Documentation

model_copy

Returns a copy of the model.

Note

The underlying instance's [__dict__][object.dict] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters:

Name	Type	Description	Default
update	None	Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.	None
deep	None	Set to `True` to make a deep copy of the model.	None

Returns:

Type	Description
None	New model instance.

model_dump¶

python3 def model_dump( self, *, mode: "Literal['json', 'python'] | str" = 'python', include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, exclude_computed_fields: 'bool' = False, round_trip: 'bool' = False, warnings: "bool | Literal['none', 'warn', 'error']" = True, fallback: 'Callable[[Any], Any] | None' = None, serialize_as_any: 'bool' = False ) -> 'dict[str, Any]'

Usage Documentation

model_dump

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

Name	Type	Description	Default
mode	None	The mode in which `to_python` should run. If mode is 'json', the output will only contain JSON serializable types. If mode is 'python', the output may contain non-JSON-serializable Python objects.	None
include	None	A set of fields to include in the output.	None
exclude	None	A set of fields to exclude from the output.	None
context	None	Additional context to pass to the serializer.	None
by_alias	None	Whether to use the field's alias in the dictionary key if defined.	None
exclude_unset	None	Whether to exclude fields that have not been explicitly set.	None
exclude_defaults	None	Whether to exclude fields that are set to their default value.	None
exclude_none	None	Whether to exclude fields that have a value of `None`.	None
exclude_computed_fields	None	Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated `round_trip` parameter instead.	None
round_trip	None	If True, dumped values should be valid as input for non-idempotent types such as Json[T].	None
warnings	None	How to handle serialization errors. False/"none" ignores them, True/"warn" logs errors, "error" raises a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError].	None
fallback	None	A function to call when an unknown value is encountered. If not provided, a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError] error is raised.	None
serialize_as_any	None	Whether to serialize fields with duck-typing serialization behavior.	None

Returns:

Type	Description
None	A dictionary representation of the model.

model_dump_json¶

python3 def model_dump_json( self, *, indent: 'int | None' = None, ensure_ascii: 'bool' = False, include: 'IncEx | None' = None, exclude: 'IncEx | None' = None, context: 'Any | None' = None, by_alias: 'bool | None' = None, exclude_unset: 'bool' = False, exclude_defaults: 'bool' = False, exclude_none: 'bool' = False, exclude_computed_fields: 'bool' = False, round_trip: 'bool' = False, warnings: "bool | Literal['none', 'warn', 'error']" = True, fallback: 'Callable[[Any], Any] | None' = None, serialize_as_any: 'bool' = False ) -> 'str'

Usage Documentation

model_dump_json

Generates a JSON representation of the model using Pydantic's to_json method.

Parameters:

Name	Type	Description	Default
indent	None	Indentation to use in the JSON output. If None is passed, the output will be compact.	None
ensure_ascii	None	If `True`, the output is guaranteed to have all incoming non-ASCII characters escaped. If `False` (the default), these characters will be output as-is.	None
include	None	Field(s) to include in the JSON output.	None
exclude	None	Field(s) to exclude from the JSON output.	None
context	None	Additional context to pass to the serializer.	None
by_alias	None	Whether to serialize using field aliases.	None
exclude_unset	None	Whether to exclude fields that have not been explicitly set.	None
exclude_defaults	None	Whether to exclude fields that are set to their default value.	None
exclude_none	None	Whether to exclude fields that have a value of `None`.	None
exclude_computed_fields	None	Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated `round_trip` parameter instead.	None
round_trip	None	If True, dumped values should be valid as input for non-idempotent types such as Json[T].	None
warnings	None	How to handle serialization errors. False/"none" ignores them, True/"warn" logs errors, "error" raises a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError].	None
fallback	None	A function to call when an unknown value is encountered. If not provided, a [`PydanticSerializationError`][pydantic_core.PydanticSerializationError] error is raised.	None
serialize_as_any	None	Whether to serialize fields with duck-typing serialization behavior.	None

Returns:

Type	Description
None	A JSON string representation of the model.

model_post_init¶

python3 def model_post_init( self, context: 'Any', / ) -> 'None'

Override this method to perform additional initialization after __init__ and model_construct.

This is useful if you want to do some validation that requires the entire model to be initialized.