diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/404.html b/404.html new file mode 100644 index 000000000..7ea27df9c --- /dev/null +++ b/404.html @@ -0,0 +1,1956 @@ + + + + + + + + + + + + + + + + + + + + + stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/app/index.html b/api/stac_fastapi/api/app/index.html new file mode 100644 index 000000000..8e948897c --- /dev/null +++ b/api/stac_fastapi/api/app/index.html @@ -0,0 +1,2767 @@ + + + + + + + + + + + + + + + + + + + + + + + + + app - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.app

+

Fastapi app creation.

+

Variables

+
DEFAULT_STATUS_CODES
+
+
STAC_API_VERSION
+
+

Classes

+

StacApi

+
class StacApi(
+    settings: stac_fastapi.types.config.ApiSettings,
+    client: Union[stac_fastapi.types.core.AsyncBaseCoreClient, stac_fastapi.types.core.BaseCoreClient],
+    extensions: List[stac_fastapi.types.extension.ApiExtension] = NOTHING,
+    exceptions: Dict[Type[Exception], int] = NOTHING,
+    app: fastapi.applications.FastAPI = NOTHING,
+    router: fastapi.routing.APIRouter = NOTHING,
+    title: str = NOTHING,
+    api_version: str = NOTHING,
+    stac_version: str = '1.0.0',
+    description: str = NOTHING,
+    search_get_request_model: Type[stac_fastapi.types.search.BaseSearchGetRequest] = <class 'stac_fastapi.types.search.BaseSearchGetRequest'>,
+    search_post_request_model: Type[stac_fastapi.types.search.BaseSearchPostRequest] = <class 'stac_fastapi.types.search.BaseSearchPostRequest'>,
+    collections_get_request_model: Type[stac_fastapi.types.search.APIRequest] = <class 'stac_fastapi.api.models.EmptyRequest'>,
+    collection_get_request_model: Type[stac_fastapi.types.search.APIRequest] = <class 'stac_fastapi.api.models.CollectionUri'>,
+    items_get_request_model: Type[stac_fastapi.types.search.APIRequest] = <class 'stac_fastapi.api.models.ItemCollectionUri'>,
+    item_get_request_model: Type[stac_fastapi.types.search.APIRequest] = <class 'stac_fastapi.api.models.ItemUri'>,
+    response_class: Type[starlette.responses.Response] = <class 'starlette.responses.JSONResponse'>,
+    middlewares: List[starlette.middleware.Middleware] = NOTHING,
+    route_dependencies: List[Tuple[List[stac_fastapi.api.routes.Scope], List[fastapi.params.Depends]]] = []
+)
+
+

StacApi factory.

+

Factory for creating a STAC-compliant FastAPI application. After +instantation, the application is accessible from the StacApi.app attribute.

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
settingsNoneAPI settings and configuration, potentially using environment
variables. See pydantic-docs.helpmanual.io/usage/settings/.		None
clientNoneA subclass of stac_api.clients.BaseCoreClient. Defines the
application logic which is injected into the API.		None
extensionsNoneAPI extensions to include with the application. This may include
official STAC extensions as well as third-party add ons.		None
exceptionsNoneDefines a global mapping between exceptions and status codes,
allowing configuration of response behavior on certain exceptions
(fastapi.tiangolo.com/tutorial/handling-errors/#install-custom-exception-handlers).		None
appNoneThe FastAPI application, defaults to a fresh application.None
route_dependenciesNoneList of tuples of route scope dicts (eg {'path':<br>'/collections', 'method': 'POST'}) and list of dependencies (e.g.
[Depends(oauth2_scheme)])). Applies specified dependencies to
specified routes. This is useful
for applying custom auth requirements to routes defined elsewhere in
the application.		None
+

Methods

+

add_health_check

+
def add_health_check(
+    self
+)
+
+

Add a health check.

+

add_route_dependencies

+
def add_route_dependencies(
+    self,
+    scopes: List[stac_fastapi.api.routes.Scope],
+    dependencies=typing.List[fastapi.params.Depends]
+) -> None
+
+

Add custom dependencies to routes.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
scopesNonelist of scopes. Each scope should be a dict with a path
and method property.		None
dependenciesNonelist of FastAPI
dependencies
to apply to each scope.		None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

customize_openapi

+
def customize_openapi(
+    self
+) -> Optional[Dict[str, Any]]
+
+

Customize openapi schema.

+

get_extension

+
def get_extension(
+    self,
+    extension: Type[stac_fastapi.types.extension.ApiExtension]
+) -> Optional[stac_fastapi.types.extension.ApiExtension]
+
+

Get an extension.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
extensionNoneextension to check for.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe extension instance, if it exists.
+

register_conformance_classes

+
def register_conformance_classes(
+    self
+)
+
+

Register conformance classes (GET /conformance).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_core

+
def register_core(
+    self
+)
+
+

Register core STAC endpoints.

+

GET / + GET /conformance + GET /collections + GET /collections/{collection_id} + GET /collections/{collection_id}/items + GET /collection/{collection_id}/items/{item_id} + GET /search + POST /search

+

Injects application logic (StacApi.client) into the API layer.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_get_collection

+
def register_get_collection(
+    self
+)
+
+

Register get collection endpoint (GET /collection/{collection_id}).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_get_collections

+
def register_get_collections(
+    self
+)
+
+

Register get collections endpoint (GET /collections).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_get_item

+
def register_get_item(
+    self
+)
+
+

Register get item endpoint (GET /collections/{collection_id}/items/{item_id}).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_get_item_collection

+
def register_get_item_collection(
+    self
+)
+
+

Register get item collection endpoint (GET /collection/{collection_id}/items).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ +
def register_get_search(
+    self
+)
+
+

Register search endpoint (GET /search).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_landing_page

+
def register_landing_page(
+    self
+)
+
+

Register landing page (GET /).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_post_search

+
def register_post_search(
+    self
+)
+
+

Register search endpoint (POST /search).

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/config/index.html b/api/stac_fastapi/api/config/index.html new file mode 100644 index 000000000..48ab920a0 --- /dev/null +++ b/api/stac_fastapi/api/config/index.html @@ -0,0 +1,2252 @@ + + + + + + + + + + + + + + + + + + + + + + + + + config - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.config

+

Application settings.

+

Classes

+

AddOns

+
class AddOns(
+    *args,
+    **kwds
+)
+
+

Enumeration of available third party add ons.

+

Ancestors (in MRO)

+
    +
  • enum.Enum
    • +
+

Class variables

+
bulk_transaction
+
+
name
+
+
value
+
+

ApiExtensions

+
class ApiExtensions(
+    *args,
+    **kwds
+)
+
+

Enumeration of available stac api extensions.

+

Ref: @stac-api-extensions

+

Ancestors (in MRO)

+
    +
  • enum.Enum
    • +
+

Class variables

+
aggregation
+
+
collection_search
+
+
fields
+
+
filter
+
+
free_text
+
+
name
+
+
query
+
+
sort
+
+
transaction
+
+
value
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/errors/index.html b/api/stac_fastapi/api/errors/index.html new file mode 100644 index 000000000..82db1b54d --- /dev/null +++ b/api/stac_fastapi/api/errors/index.html @@ -0,0 +1,2651 @@ + + + + + + + + + + + + + + + + + + + + + + + + + errors - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.errors

+

Error handling.

+

Variables

+
DEFAULT_STATUS_CODES
+
+
logger
+
+

Functions

+

add_exception_handlers

+
def add_exception_handlers(
+    app: fastapi.applications.FastAPI,
+    status_codes: Dict[Type[Exception], int]
+) -> None
+
+

Add exception handlers to the FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonethe FastAPI application.None
status_codesNonemapping between exceptions and status codes.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

exception_handler_factory

+
def exception_handler_factory(
+    status_code: int
+) -> Callable
+
+

Create a FastAPI exception handler for a particular status code.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
status_codeNoneHTTP status code.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
callablean exception handler.
+

Classes

+

ErrorResponse

+
class ErrorResponse(
+    /,
+    *args,
+    **kwargs
+)
+
+

A JSON error response returned by the API.

+

The STAC API spec expects that code and description are both present in +the payload.

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
codeNoneA code representing the error, semantics are up to implementor.None
descriptionNoneA description of the error.None
+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/index.html b/api/stac_fastapi/api/index.html new file mode 100644 index 000000000..58d04d431 --- /dev/null +++ b/api/stac_fastapi/api/index.html @@ -0,0 +1,2067 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/middleware/index.html b/api/stac_fastapi/api/middleware/index.html new file mode 100644 index 000000000..877037a2d --- /dev/null +++ b/api/stac_fastapi/api/middleware/index.html @@ -0,0 +1,2349 @@ + + + + + + + + + + + + + + + + + + + + + + + + + middleware - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.middleware

+

Api middleware.

+

Variables

+
HTTPS_PORT
+
+
HTTP_PORT
+
+

Classes

+

CORSMiddleware

+
class CORSMiddleware(
+    app: Callable[[MutableMapping[str, Any], Callable[[], Awaitable[MutableMapping[str, Any]]], Callable[[MutableMapping[str, Any]], Awaitable[NoneType]]], Awaitable[NoneType]],
+    allow_origins: Sequence[str] = ('*',),
+    allow_methods: Sequence[str] = ('OPTIONS', 'POST', 'GET'),
+    allow_headers: Sequence[str] = ('Content-Type',),
+    allow_credentials: bool = False,
+    allow_origin_regex: Optional[str] = None,
+    expose_headers: Sequence[str] = (),
+    max_age: int = 600
+)
+
+

Subclass of Starlette's standard CORS middleware with default values set to those

+

recommended by the STAC API spec.

+

github.com/radiantearth/stac-api-spec/blob/914cf8108302e2ec734340080a45aaae4859bb63/implementation.md#cors

+

Ancestors (in MRO)

+
    +
  • starlette.middleware.cors.CORSMiddleware
    • +
+

Static methods

+

allow_explicit_origin

+
def allow_explicit_origin(
+    headers: 'MutableHeaders',
+    origin: 'str'
+) -> 'None'
+
+

Methods

+

is_allowed_origin

+
def is_allowed_origin(
+    self,
+    origin: 'str'
+) -> 'bool'
+
+

preflight_response

+
def preflight_response(
+    self,
+    request_headers: 'Headers'
+) -> 'Response'
+
+

send

+
def send(
+    self,
+    message: 'Message',
+    send: 'Send',
+    request_headers: 'Headers'
+) -> 'None'
+
+

simple_response

+
def simple_response(
+    self,
+    scope: 'Scope',
+    receive: 'Receive',
+    send: 'Send',
+    request_headers: 'Headers'
+) -> 'None'
+
+

ProxyHeaderMiddleware

+
class ProxyHeaderMiddleware(
+    app: Callable[[MutableMapping[str, Any], Callable[[], Awaitable[MutableMapping[str, Any]]], Callable[[MutableMapping[str, Any]], Awaitable[NoneType]]], Awaitable[NoneType]]
+)
+
+

Account for forwarding headers when deriving base URL.

+

Prioritise standard Forwarded header, look for non-standard X-Forwarded-* if missing. +Default to what can be derived from the URL if no headers provided. Middleware updates +the host header that is interpreted by starlette when deriving Request.base_url.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/models/index.html b/api/stac_fastapi/api/models/index.html new file mode 100644 index 000000000..0aeef02a2 --- /dev/null +++ b/api/stac_fastapi/api/models/index.html @@ -0,0 +1,3105 @@ + + + + + + + + + + + + + + + + + + + + + + + + + models - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.models

+

Api request/response models.

+

Functions

+

create_get_request_model

+
def create_get_request_model(
+    extensions: Optional[List[stac_fastapi.types.extension.ApiExtension]],
+    base_model: stac_fastapi.types.search.BaseSearchGetRequest = <class 'stac_fastapi.types.search.BaseSearchGetRequest'>
+) -> stac_fastapi.types.search.APIRequest
+
+

Wrap create_request_model to create the GET request model.

+

create_post_request_model

+
def create_post_request_model(
+    extensions: Optional[List[stac_fastapi.types.extension.ApiExtension]],
+    base_model: stac_fastapi.types.search.BaseSearchPostRequest = <class 'stac_fastapi.types.search.BaseSearchPostRequest'>
+) -> Type[pydantic.main.BaseModel]
+
+

Wrap create_request_model to create the POST request model.

+

create_request_model

+
def create_request_model(
+    model_name='SearchGetRequest',
+    base_model: Union[Type[pydantic.main.BaseModel], stac_fastapi.types.search.APIRequest] = <class 'stac_fastapi.types.search.BaseSearchGetRequest'>,
+    extensions: Optional[List[stac_fastapi.types.extension.ApiExtension]] = None,
+    mixins: Union[List[pydantic.main.BaseModel], List[stac_fastapi.types.search.APIRequest], NoneType] = None,
+    request_type: Optional[str] = 'GET'
+) -> Union[Type[pydantic.main.BaseModel], stac_fastapi.types.search.APIRequest]
+
+

Create a pydantic model for validating request bodies.

+

Classes

+

CollectionUri

+
class CollectionUri(
+    collection_id: typing.Annotated[str, Path(PydanticUndefined)]
+)
+
+

Get or delete collection.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.transaction.PostItem
    • +
  • stac_fastapi.extensions.core.transaction.PutCollection
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

EmptyRequest

+
class EmptyRequest(
+
+)
+
+

Empty request.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

GeoJSONResponse

+
class GeoJSONResponse(
+    content: 'typing.Any',
+    status_code: 'int' = 200,
+    headers: 'typing.Mapping[str, str] | None' = None,
+    media_type: 'str | None' = None,
+    background: 'BackgroundTask | None' = None
+)
+
+

JSON with custom, vendor content-type.

+

Ancestors (in MRO)

+
    +
  • starlette.responses.JSONResponse
    • +
  • starlette.responses.Response
    • +
+

Class variables

+
charset
+
+
media_type
+
+

Instance variables

+
headers
+
+

Methods

+ +
def delete_cookie(
+    self,
+    key: 'str',
+    path: 'str' = '/',
+    domain: 'str | None' = None,
+    secure: 'bool' = False,
+    httponly: 'bool' = False,
+    samesite: "typing.Literal['lax', 'strict', 'none'] | None" = 'lax'
+) -> 'None'
+
+

init_headers

+
def init_headers(
+    self,
+    headers: 'typing.Mapping[str, str] | None' = None
+) -> 'None'
+
+

render

+
def render(
+    self,
+    content: 'typing.Any'
+) -> 'bytes'
+
+ +
def set_cookie(
+    self,
+    key: 'str',
+    value: 'str' = '',
+    max_age: 'int | None' = None,
+    expires: 'datetime | str | int | None' = None,
+    path: 'str | None' = '/',
+    domain: 'str | None' = None,
+    secure: 'bool' = False,
+    httponly: 'bool' = False,
+    samesite: "typing.Literal['lax', 'strict', 'none'] | None" = 'lax'
+) -> 'None'
+
+

ItemCollectionUri

+
class ItemCollectionUri(
+    collection_id: typing.Annotated[str, Path(PydanticUndefined)],
+    limit: Annotated[Optional[Annotated[int, Gt(gt=0), AfterValidator(func=<function crop at 0x7f85cf1b1ee0>)]], Query(PydanticUndefined)] = 10,
+    bbox: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    datetime: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Get item collection.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

ItemUri

+
class ItemUri(
+    collection_id: typing.Annotated[str, Path(PydanticUndefined)],
+    item_id: typing.Annotated[str, Path(PydanticUndefined)]
+)
+
+

Get or delete item.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.transaction.PutItem
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

JSONSchemaResponse

+
class JSONSchemaResponse(
+    content: 'typing.Any',
+    status_code: 'int' = 200,
+    headers: 'typing.Mapping[str, str] | None' = None,
+    media_type: 'str | None' = None,
+    background: 'BackgroundTask | None' = None
+)
+
+

JSON with custom, vendor content-type.

+

Ancestors (in MRO)

+
    +
  • starlette.responses.JSONResponse
    • +
  • starlette.responses.Response
    • +
+

Class variables

+
charset
+
+
media_type
+
+

Instance variables

+
headers
+
+

Methods

+ +
def delete_cookie(
+    self,
+    key: 'str',
+    path: 'str' = '/',
+    domain: 'str | None' = None,
+    secure: 'bool' = False,
+    httponly: 'bool' = False,
+    samesite: "typing.Literal['lax', 'strict', 'none'] | None" = 'lax'
+) -> 'None'
+
+

init_headers

+
def init_headers(
+    self,
+    headers: 'typing.Mapping[str, str] | None' = None
+) -> 'None'
+
+

render

+
def render(
+    self,
+    content: 'typing.Any'
+) -> 'bytes'
+
+ +
def set_cookie(
+    self,
+    key: 'str',
+    value: 'str' = '',
+    max_age: 'int | None' = None,
+    expires: 'datetime | str | int | None' = None,
+    path: 'str | None' = '/',
+    domain: 'str | None' = None,
+    secure: 'bool' = False,
+    httponly: 'bool' = False,
+    samesite: "typing.Literal['lax', 'strict', 'none'] | None" = 'lax'
+) -> 'None'
+
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/openapi/index.html b/api/stac_fastapi/api/openapi/index.html new file mode 100644 index 000000000..9c2725ec1 --- /dev/null +++ b/api/stac_fastapi/api/openapi/index.html @@ -0,0 +1,2095 @@ + + + + + + + + + + + + + + + + + + + + + + + + + openapi - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.openapi

+

openapi.

+

Functions

+

update_openapi

+
def update_openapi(
+    app: fastapi.applications.FastAPI
+) -> fastapi.applications.FastAPI
+
+

Update OpenAPI response content-type.

+

This function modifies the openapi route to comply with the STAC API spec's required +content-type response header.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/routes/index.html b/api/stac_fastapi/api/routes/index.html new file mode 100644 index 000000000..c8448adf4 --- /dev/null +++ b/api/stac_fastapi/api/routes/index.html @@ -0,0 +1,2575 @@ + + + + + + + + + + + + + + + + + + + + + + + + + routes - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.routes

+

Route factories.

+

Variables

+
HTTP_204_NO_CONTENT
+
+

Functions

+

add_route_dependencies

+
def add_route_dependencies(
+    routes: List[starlette.routing.BaseRoute],
+    scopes: List[stac_fastapi.api.routes.Scope],
+    dependencies=typing.List[fastapi.params.Depends]
+) -> None
+
+

Add dependencies to routes.

+

Allows a developer to add dependencies to a route after the route has been +defined.

+

"*" can be used for path or method to match all allowed routes.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

create_async_endpoint

+
def create_async_endpoint(
+    func: Callable,
+    request_model: Union[Type[stac_fastapi.types.search.APIRequest], Type[pydantic.main.BaseModel], Dict]
+)
+
+

Wrap a function in a coroutine which may be used to create a FastAPI endpoint.

+

Synchronous functions are executed asynchronously using a background thread.

+

sync_to_async

+
def sync_to_async(
+    func
+)
+
+

Run synchronous function asynchronously in a background thread.

+

Classes

+

Scope

+
class Scope(
+    /,
+    *args,
+    **kwargs
+)
+
+

More strict version of Starlette's Scope.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/api/version/index.html b/api/stac_fastapi/api/version/index.html new file mode 100644 index 000000000..0321b82c9 --- /dev/null +++ b/api/stac_fastapi/api/version/index.html @@ -0,0 +1,2000 @@ + + + + + + + + + + + + + + + + + + + + + + + + + version - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.api.version

+

Library version.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/aggregation/aggregation/index.html b/api/stac_fastapi/extensions/core/aggregation/aggregation/index.html new file mode 100644 index 000000000..616ae0b00 --- /dev/null +++ b/api/stac_fastapi/extensions/core/aggregation/aggregation/index.html @@ -0,0 +1,3160 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.aggregation.aggregation - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.aggregation.aggregation

+

Aggregation Extension.

+

Classes

+

AggregationConformanceClasses

+
class AggregationConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the Aggregation extension.

+

See +stac-api-extensions/aggregation

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
AGGREGATION
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+

AggregationExtension

+
class AggregationExtension(
+    schema_href: Optional[str] = None,
+    client: Union[stac_fastapi.extensions.core.aggregation.client.AsyncBaseAggregationClient, stac_fastapi.extensions.core.aggregation.client.BaseAggregationClient] = NOTHING,
+    conformance_classes: List[str] = [<AggregationConformanceClasses.AGGREGATION: 'https://api.stacspec.org/v0.3.0/aggregation'>],
+    router: fastapi.routing.APIRouter = NOTHING
+)
+
+

Aggregation Extension.

+

The purpose of the Aggregation Extension is to provide an endpoint similar to +the Search endpoint (/search), but which will provide aggregated information +on matching Items rather than the Items themselves. This is highly influenced +by the Elasticsearch and OpenSearch aggregation endpoint, but with a more +regular structure for responses.

+

The Aggregation extension adds several endpoints which allow the retrieval of +available aggregation fields and aggregation buckets based on a seearch query: + GET /aggregations + POST /aggregations + GET /collections/{collection_id}/aggregations + POST /collections/{collection_id}/aggregations + GET /aggregate + POST /aggregate + GET /collections/{collection_id}/aggregate + POST /collections/{collection_id}/aggregate

+

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

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classesNoneConformance classes provided by the extensionNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/aggregation/client/index.html b/api/stac_fastapi/extensions/core/aggregation/client/index.html new file mode 100644 index 000000000..0e7dbc807 --- /dev/null +++ b/api/stac_fastapi/extensions/core/aggregation/client/index.html @@ -0,0 +1,2173 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.aggregation.client - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.aggregation.client

+

Aggregation extensions clients.

+

Classes

+

AsyncBaseAggregationClient

+
class AsyncBaseAggregationClient(
+
+)
+
+

Defines an async pattern for implementing the STAC aggregation extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

aggregate

+
def aggregate(
+    self,
+    collection_id: Optional[str] = None,
+    aggregations: Union[str, List[str], NoneType] = None,
+    collections: Optional[List[str]] = None,
+    ids: Optional[List[str]] = None,
+    bbox: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]], NoneType] = None,
+    intersects: Optional[Annotated[Union[geojson_pydantic.geometries.Point, geojson_pydantic.geometries.MultiPoint, geojson_pydantic.geometries.LineString, geojson_pydantic.geometries.MultiLineString, geojson_pydantic.geometries.Polygon, geojson_pydantic.geometries.MultiPolygon, geojson_pydantic.geometries.GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] = None,
+    datetime: Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType] = None,
+    limit: Optional[int] = 10,
+    **kwargs
+) -> stac_fastapi.extensions.core.aggregation.types.AggregationCollection
+
+

Return the aggregation buckets for a given search result

+

get_aggregations

+
def get_aggregations(
+    self,
+    collection_id: Optional[str] = None,
+    **kwargs
+) -> stac_fastapi.extensions.core.aggregation.types.AggregationCollection
+
+

Get the aggregations available for the given collection_id.

+

If collection_id is None, returns the available aggregations over all +collections.

+

BaseAggregationClient

+
class BaseAggregationClient(
+
+)
+
+

Defines a pattern for implementing the STAC aggregation extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

aggregate

+
def aggregate(
+    self,
+    collection_id: Optional[str] = None,
+    **kwargs
+) -> stac_fastapi.extensions.core.aggregation.types.AggregationCollection
+
+

Return the aggregation buckets for a given search result

+

get_aggregations

+
def get_aggregations(
+    self,
+    collection_id: Optional[str] = None,
+    **kwargs
+) -> stac_fastapi.extensions.core.aggregation.types.AggregationCollection
+
+

Get the aggregations available for the given collection_id.

+

If collection_id is None, returns the available aggregations over all +collections.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/aggregation/index.html b/api/stac_fastapi/extensions/core/aggregation/index.html new file mode 100644 index 000000000..5c146866a --- /dev/null +++ b/api/stac_fastapi/extensions/core/aggregation/index.html @@ -0,0 +1,2195 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.aggregation - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.aggregation

+

Aggregation extension module.

+

Sub-modules

+ +

Classes

+

AggregationExtension

+
class AggregationExtension(
+    schema_href: Optional[str] = None,
+    client: Union[stac_fastapi.extensions.core.aggregation.client.AsyncBaseAggregationClient, stac_fastapi.extensions.core.aggregation.client.BaseAggregationClient] = NOTHING,
+    conformance_classes: List[str] = [<AggregationConformanceClasses.AGGREGATION: 'https://api.stacspec.org/v0.3.0/aggregation'>],
+    router: fastapi.routing.APIRouter = NOTHING
+)
+
+

Aggregation Extension.

+

The purpose of the Aggregation Extension is to provide an endpoint similar to +the Search endpoint (/search), but which will provide aggregated information +on matching Items rather than the Items themselves. This is highly influenced +by the Elasticsearch and OpenSearch aggregation endpoint, but with a more +regular structure for responses.

+

The Aggregation extension adds several endpoints which allow the retrieval of +available aggregation fields and aggregation buckets based on a seearch query: + GET /aggregations + POST /aggregations + GET /collections/{collection_id}/aggregations + POST /collections/{collection_id}/aggregations + GET /aggregate + POST /aggregate + GET /collections/{collection_id}/aggregate + POST /collections/{collection_id}/aggregate

+

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

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classesNoneConformance classes provided by the extensionNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/aggregation/request/index.html b/api/stac_fastapi/extensions/core/aggregation/request/index.html new file mode 100644 index 000000000..6efb43986 --- /dev/null +++ b/api/stac_fastapi/extensions/core/aggregation/request/index.html @@ -0,0 +1,3304 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.aggregation.request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.aggregation.request

+

Request model for the Aggregation extension.

+

Classes

+

AggregationExtensionGetRequest

+
class AggregationExtensionGetRequest(
+    collections: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    ids: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    bbox: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    intersects: 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 0x7f85cf1b1ee0>)]], Query(PydanticUndefined)] = 10,
+    aggregations: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Aggregation Extension GET request model.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.BaseSearchGetRequest
    • +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

AggregationExtensionPostRequest

+
class AggregationExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Aggregation Extension POST request model.

+

Ancestors (in MRO)

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

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

validate_bbox

+
def validate_bbox(
+    v: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]]
+) -> Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]]
+
+

validate_datetime

+
def validate_datetime(
+    value: str
+) -> str
+
+

validate_spatial

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

Instance variables

+
end_date
+
+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+
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.

+
start_date
+
+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

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

We need to both initialize private attributes and call the user-defined model_post_init

+

method.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/aggregation/types/index.html b/api/stac_fastapi/extensions/core/aggregation/types/index.html new file mode 100644 index 000000000..c9064e9f8 --- /dev/null +++ b/api/stac_fastapi/extensions/core/aggregation/types/index.html @@ -0,0 +1,2720 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.aggregation.types - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.aggregation.types

+

Aggregation Extension types.

+

Classes

+

Aggregation

+
class Aggregation(
+    /,
+    *args,
+    **kwargs
+)
+
+

A STAC aggregation.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Class variables

+
buckets
+
+
overflow
+
+
value
+
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

AggregationCollection

+
class AggregationCollection(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Item Aggregation Collection.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

Bucket

+
class Bucket(
+    /,
+    *args,
+    **kwargs
+)
+
+

A STAC aggregation bucket.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Class variables

+
frequency
+
+
to
+
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/collection_search/client/index.html b/api/stac_fastapi/extensions/core/collection_search/client/index.html new file mode 100644 index 000000000..1d7b65852 --- /dev/null +++ b/api/stac_fastapi/extensions/core/collection_search/client/index.html @@ -0,0 +1,2160 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.collection_search.client - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.collection_search.client

+

collection-search extensions clients.

+

Classes

+

AsyncBaseCollectionSearchClient

+
class AsyncBaseCollectionSearchClient(
+
+)
+
+

Defines a pattern for implementing the STAC collection-search POST extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

post_all_collections

+
def post_all_collections(
+    self,
+    search_request: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Get all available collections.

+

Called with POST /collections.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA list of collections.
+

BaseCollectionSearchClient

+
class BaseCollectionSearchClient(
+
+)
+
+

Defines a pattern for implementing the STAC collection-search POST extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

post_all_collections

+
def post_all_collections(
+    self,
+    search_request: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Get all available collections.

+

Called with POST /collections.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA list of collections.
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/collection_search/collection_search/index.html b/api/stac_fastapi/extensions/core/collection_search/collection_search/index.html new file mode 100644 index 000000000..edc464358 --- /dev/null +++ b/api/stac_fastapi/extensions/core/collection_search/collection_search/index.html @@ -0,0 +1,3398 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.collection_search.collection_search - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.collection_search.collection_search

+

Collection-Search extension.

+

Classes

+

CollectionSearchExtension

+
class CollectionSearchExtension(
+    GET: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest'>,
+    conformance_classes: List[str] = [<ConformanceClasses.COLLECTIONSEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search'>, <ConformanceClasses.BASIS: 'http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query'>],
+    schema_href: Optional[str] = None
+)
+
+

Collection-Search Extension.

+

The Collection-Search extension adds functionality to the GET - /collections +endpoint which allows the caller to include or exclude specific from the API +response. +Registering this extension with the application has the added effect of +removing the ItemCollection response model from the /search endpoint, as +the Fields extension allows the API to return potentially invalid responses +by excluding fields which are required by the STAC spec, such as geometry.

+

stac-api-extensions/collection-search

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.collection_search.collection_search.CollectionSearchPostExtension
    • +
+

Class variables

+
GET
+
+
POST
+
+

Static methods

+

from_extensions

+
def from_extensions(
+    extensions: List[stac_fastapi.types.extension.ApiExtension],
+    schema_href: Optional[str] = None
+) -> 'CollectionSearchExtension'
+
+

Create CollectionSearchExtension object from extensions.

+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appfastapi.FastAPItarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

CollectionSearchPostExtension

+
class CollectionSearchPostExtension(
+    client: Union[stac_fastapi.extensions.core.collection_search.client.AsyncBaseCollectionSearchClient, stac_fastapi.extensions.core.collection_search.client.BaseCollectionSearchClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    conformance_classes: List[str] = [<ConformanceClasses.COLLECTIONSEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search'>, <ConformanceClasses.BASIS: 'http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query'>],
+    schema_href: Optional[str] = None,
+    router: fastapi.routing.APIRouter = NOTHING,
+    GET: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest'>,
+    POST: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest'>
+)
+
+

Collection-Search Extension.

+

Extents the collection-search extension with an additional +POST - /collections endpoint

+

NOTE: the POST - /collections endpoint can be conflicting with the +POST /collections endpoint registered for the Transaction extension.

+

stac-api-extensions/collection-search

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.extensions.core.collection_search.collection_search.CollectionSearchExtension
    • +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Static methods

+

from_extensions

+
def from_extensions(
+    extensions: List[stac_fastapi.types.extension.ApiExtension],
+    *,
+    client: Union[stac_fastapi.extensions.core.collection_search.client.AsyncBaseCollectionSearchClient, stac_fastapi.extensions.core.collection_search.client.BaseCollectionSearchClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    schema_href: Optional[str] = None,
+    router: Optional[fastapi.routing.APIRouter] = None
+) -> 'CollectionSearchPostExtension'
+
+

Create CollectionSearchPostExtension object from extensions.

+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

ConformanceClasses

+
class ConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the Collection-Search extension.

+

See +stac-api-extensions/collection-search

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
BASIS
+
+
COLLECTIONSEARCH
+
+
FIELDS
+
+
FILTER
+
+
FREETEXT
+
+
QUERY
+
+
SORT
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/collection_search/index.html b/api/stac_fastapi/extensions/core/collection_search/index.html new file mode 100644 index 000000000..9396c1f29 --- /dev/null +++ b/api/stac_fastapi/extensions/core/collection_search/index.html @@ -0,0 +1,3413 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.collection_search - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.collection_search

+

Collection-Search extension module.

+

Sub-modules

+ +

Classes

+

CollectionSearchExtension

+
class CollectionSearchExtension(
+    GET: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest'>,
+    conformance_classes: List[str] = [<ConformanceClasses.COLLECTIONSEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search'>, <ConformanceClasses.BASIS: 'http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query'>],
+    schema_href: Optional[str] = None
+)
+
+

Collection-Search Extension.

+

The Collection-Search extension adds functionality to the GET - /collections +endpoint which allows the caller to include or exclude specific from the API +response. +Registering this extension with the application has the added effect of +removing the ItemCollection response model from the /search endpoint, as +the Fields extension allows the API to return potentially invalid responses +by excluding fields which are required by the STAC spec, such as geometry.

+

stac-api-extensions/collection-search

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.collection_search.CollectionSearchPostExtension
    • +
+

Class variables

+
GET
+
+
POST
+
+

Static methods

+

from_extensions

+
def from_extensions(
+    extensions: List[stac_fastapi.types.extension.ApiExtension],
+    schema_href: Optional[str] = None
+) -> 'CollectionSearchExtension'
+
+

Create CollectionSearchExtension object from extensions.

+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appfastapi.FastAPItarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

CollectionSearchPostExtension

+
class CollectionSearchPostExtension(
+    client: Union[stac_fastapi.extensions.core.collection_search.client.AsyncBaseCollectionSearchClient, stac_fastapi.extensions.core.collection_search.client.BaseCollectionSearchClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    conformance_classes: List[str] = [<ConformanceClasses.COLLECTIONSEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search'>, <ConformanceClasses.BASIS: 'http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query'>],
+    schema_href: Optional[str] = None,
+    router: fastapi.routing.APIRouter = NOTHING,
+    GET: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest'>,
+    POST: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest'>
+)
+
+

Collection-Search Extension.

+

Extents the collection-search extension with an additional +POST - /collections endpoint

+

NOTE: the POST - /collections endpoint can be conflicting with the +POST /collections endpoint registered for the Transaction extension.

+

stac-api-extensions/collection-search

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.extensions.core.collection_search.CollectionSearchExtension
    • +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Static methods

+

from_extensions

+
def from_extensions(
+    extensions: List[stac_fastapi.types.extension.ApiExtension],
+    *,
+    client: Union[stac_fastapi.extensions.core.collection_search.client.AsyncBaseCollectionSearchClient, stac_fastapi.extensions.core.collection_search.client.BaseCollectionSearchClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    schema_href: Optional[str] = None,
+    router: Optional[fastapi.routing.APIRouter] = None
+) -> 'CollectionSearchPostExtension'
+
+

Create CollectionSearchPostExtension object from extensions.

+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

ConformanceClasses

+
class ConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the Collection-Search extension.

+

See +stac-api-extensions/collection-search

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
BASIS
+
+
COLLECTIONSEARCH
+
+
FIELDS
+
+
FILTER
+
+
FREETEXT
+
+
QUERY
+
+
SORT
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/collection_search/request/index.html b/api/stac_fastapi/extensions/core/collection_search/request/index.html new file mode 100644 index 000000000..e316e8042 --- /dev/null +++ b/api/stac_fastapi/extensions/core/collection_search/request/index.html @@ -0,0 +1,3308 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.collection_search.request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.collection_search.request

+

Request models for the Collection-Search extension.

+

Classes

+

BaseCollectionSearchGetRequest

+
class BaseCollectionSearchGetRequest(
+    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 0x7f85cf1b1ee0>)]], Query(PydanticUndefined)] = 10
+)
+
+

Basics additional Collection-Search parameters for the GET request.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

BaseCollectionSearchPostRequest

+
class BaseCollectionSearchPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Collection-Search POST model.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

validate_bbox

+
def validate_bbox(
+    v: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]]
+) -> Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]]
+
+

validate bbox.

+

validate_datetime

+
def validate_datetime(
+    value: str
+) -> str
+
+

validate datetime.

+

Instance variables

+
end_date
+
+

end date.

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+
start_date
+
+

start date.

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

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

This function is meant to behave like a BaseModel method to initialise private attributes.

+

It takes context as an argument since that's what pydantic-core passes when calling it.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
selfNoneThe BaseModel instance.None
contextNoneThe context.None
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/fields/fields/index.html b/api/stac_fastapi/extensions/core/fields/fields/index.html new file mode 100644 index 000000000..6bcfd1ce2 --- /dev/null +++ b/api/stac_fastapi/extensions/core/fields/fields/index.html @@ -0,0 +1,2310 @@ + + + + + + + + + + + + + + + + + + + + + + + + + fields - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.fields.fields

+

Fields extension.

+

Classes

+

FieldsExtension

+
class FieldsExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Fields Extension.

+

The Fields extension adds functionality to the /search endpoint which +allows the caller to include or exclude specific from the API response. +Registering this extension with the application has the added effect of +removing the ItemCollection response model from the /search endpoint, as +the Fields extension allows the API to return potentially invalid responses +by excluding fields which are required by the STAC spec, such as geometry.

+

stac-api-extensions/fields

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
default_includessetdefines the default set of included fields.None
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appfastapi.FastAPItarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/fields/index.html b/api/stac_fastapi/extensions/core/fields/index.html new file mode 100644 index 000000000..dff746d1b --- /dev/null +++ b/api/stac_fastapi/extensions/core/fields/index.html @@ -0,0 +1,2333 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.fields

+

Fields extension module.

+

Sub-modules

+ +

Classes

+

FieldsExtension

+
class FieldsExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Fields Extension.

+

The Fields extension adds functionality to the /search endpoint which +allows the caller to include or exclude specific from the API response. +Registering this extension with the application has the added effect of +removing the ItemCollection response model from the /search endpoint, as +the Fields extension allows the API to return potentially invalid responses +by excluding fields which are required by the STAC spec, such as geometry.

+

stac-api-extensions/fields

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
default_includessetdefines the default set of included fields.None
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appfastapi.FastAPItarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/fields/request/index.html b/api/stac_fastapi/extensions/core/fields/request/index.html new file mode 100644 index 000000000..1b1512545 --- /dev/null +++ b/api/stac_fastapi/extensions/core/fields/request/index.html @@ -0,0 +1,5108 @@ + + + + + + + + + + + + + + + + + + + + + + + + + request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.fields.request

+

Request models for the fields extension.

+

Classes

+

FieldsExtensionGetRequest

+
class FieldsExtensionGetRequest(
+    fields: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Additional fields for the GET request.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

FieldsExtensionPostRequest

+
class FieldsExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Additional fields and schema for the POST request.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+

PostFieldsExtension

+
class PostFieldsExtension(
+    /,
+    **data: 'Any'
+)
+
+

FieldsExtension.

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneset of fields to include.None
excludeNoneset of fields to exclude.None
+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/filter/client/index.html b/api/stac_fastapi/extensions/core/filter/client/index.html new file mode 100644 index 000000000..49cb425d0 --- /dev/null +++ b/api/stac_fastapi/extensions/core/filter/client/index.html @@ -0,0 +1,2138 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.filter.client - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.filter.client

+

Filter extensions clients.

+

Classes

+

AsyncBaseFiltersClient

+
class AsyncBaseFiltersClient(
+
+)
+
+

Defines a pattern for implementing the STAC filter extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

get_queryables

+
def get_queryables(
+    self,
+    collection_id: Optional[str] = None,
+    **kwargs
+) -> Dict[str, Any]
+
+

Get the queryables available for the given collection_id.

+

If collection_id is None, returns the intersection of all queryables over all +collections.

+

This base implementation returns a blank queryable schema. This is not allowed +under OGC CQL but it is allowed by the STAC API Filter Extension +github.com/radiantearth/stac-api-spec/tree/master/fragments/filter#queryables

+

BaseFiltersClient

+
class BaseFiltersClient(
+
+)
+
+

Defines a pattern for implementing the STAC filter extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

get_queryables

+
def get_queryables(
+    self,
+    collection_id: Optional[str] = None,
+    **kwargs
+) -> Dict[str, Any]
+
+

Get the queryables available for the given collection_id.

+

If collection_id is None, returns the intersection of all queryables over all +collections.

+

This base implementation returns a blank queryable schema. This is not allowed +under OGC CQL but it is allowed by the STAC API Filter Extension +stac-api-extensions/filter#queryables

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/filter/filter/index.html b/api/stac_fastapi/extensions/core/filter/filter/index.html new file mode 100644 index 000000000..f45d718b6 --- /dev/null +++ b/api/stac_fastapi/extensions/core/filter/filter/index.html @@ -0,0 +1,3791 @@ + + + + + + + + + + + + + + + + + + + + + + + + + filter - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.filter.filter

+

Filter Extension.

+

Classes

+

FilterConformanceClasses

+
class FilterConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the Filter extension.

+

See +stac-api-extensions/filter

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
ACCENT_CASE_INSENSITIVE_COMPARISON
+
+
ADVANCED_COMPARISON_OPERATORS
+
+
ARITHMETIC
+
+
ARRAYS
+
+
BASIC_CQL2
+
+
BASIC_SPATIAL_OPERATORS
+
+
CQL2_JSON
+
+
CQL2_TEXT
+
+
FEATURES_FILTER
+
+
FILTER
+
+
FUNCTIONS
+
+
ITEM_SEARCH_FILTER
+
+
PROPERTY_PROPERTY
+
+
SPATIAL_OPERATORS
+
+
TEMPORAL_OPERATORS
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+

FilterExtension

+
class FilterExtension(
+    schema_href: Optional[str] = None,
+    client: Union[stac_fastapi.extensions.core.filter.client.AsyncBaseFiltersClient, stac_fastapi.extensions.core.filter.client.BaseFiltersClient] = NOTHING,
+    conformance_classes: List[str] = [<FilterConformanceClasses.FILTER: 'http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter'>, <FilterConformanceClasses.FEATURES_FILTER: 'http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter'>, <FilterConformanceClasses.ITEM_SEARCH_FILTER: 'https://api.stacspec.org/v1.0.0-rc.2/item-search#filter'>, <FilterConformanceClasses.BASIC_CQL2: 'http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2'>, <FilterConformanceClasses.CQL2_JSON: 'http://www.opengis.net/spec/cql2/1.0/conf/cql2-json'>, <FilterConformanceClasses.CQL2_TEXT: 'http://www.opengis.net/spec/cql2/1.0/conf/cql2-text'>],
+    router: fastapi.routing.APIRouter = NOTHING,
+    response_class: Type[starlette.responses.Response] = <class 'stac_fastapi.api.models.JSONSchemaResponse'>
+)
+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
clientNoneQueryables endpoint logicNone
conformance_classesNoneConformance classes provided by the extensionNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/filter/index.html b/api/stac_fastapi/extensions/core/filter/index.html new file mode 100644 index 000000000..6720fbcbc --- /dev/null +++ b/api/stac_fastapi/extensions/core/filter/index.html @@ -0,0 +1,2332 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.filter

+

Filter extension module.

+

Sub-modules

+ +

Classes

+

FilterExtension

+
class FilterExtension(
+    schema_href: Optional[str] = None,
+    client: Union[stac_fastapi.extensions.core.filter.client.AsyncBaseFiltersClient, stac_fastapi.extensions.core.filter.client.BaseFiltersClient] = NOTHING,
+    conformance_classes: List[str] = [<FilterConformanceClasses.FILTER: 'http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter'>, <FilterConformanceClasses.FEATURES_FILTER: 'http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter'>, <FilterConformanceClasses.ITEM_SEARCH_FILTER: 'https://api.stacspec.org/v1.0.0-rc.2/item-search#filter'>, <FilterConformanceClasses.BASIC_CQL2: 'http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2'>, <FilterConformanceClasses.CQL2_JSON: 'http://www.opengis.net/spec/cql2/1.0/conf/cql2-json'>, <FilterConformanceClasses.CQL2_TEXT: 'http://www.opengis.net/spec/cql2/1.0/conf/cql2-text'>],
+    router: fastapi.routing.APIRouter = NOTHING,
+    response_class: Type[starlette.responses.Response] = <class 'stac_fastapi.api.models.JSONSchemaResponse'>
+)
+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
clientNoneQueryables endpoint logicNone
conformance_classesNoneConformance classes provided by the extensionNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/filter/request/index.html b/api/stac_fastapi/extensions/core/filter/request/index.html new file mode 100644 index 000000000..dd38cb142 --- /dev/null +++ b/api/stac_fastapi/extensions/core/filter/request/index.html @@ -0,0 +1,3643 @@ + + + + + + + + + + + + + + + + + + + + + + + + + request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.filter.request

+

Filter extension request models.

+

Variables

+
FilterLang
+
+

Classes

+

FilterExtensionGetRequest

+
class FilterExtensionGetRequest(
+    filter: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    filter_crs: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    filter_lang: Annotated[Optional[Literal['cql-json', 'cql2-json', 'cql2-text']], Query(PydanticUndefined)] = 'cql2-text'
+)
+
+

Filter extension GET request model.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

FilterExtensionPostRequest

+
class FilterExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Filter extension POST request model.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/free_text/free_text/index.html b/api/stac_fastapi/extensions/core/free_text/free_text/index.html new file mode 100644 index 000000000..9c2555287 --- /dev/null +++ b/api/stac_fastapi/extensions/core/free_text/free_text/index.html @@ -0,0 +1,3917 @@ + + + + + + + + + + + + + + + + + + + + + + + + + free_text - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.free_text.free_text

+

Free-text extension.

+

Classes

+

FreeTextAdvancedExtension

+
class FreeTextAdvancedExtension(
+    conformance_classes: List[str] = [<FreeTextConformanceClasses.SEARCH_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/item-search#advanced-free-text'>, <FreeTextConformanceClasses.COLLECTIONS_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search#advanced-free-text'>, <FreeTextConformanceClasses.ITEMS_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#advanced-free-text'>],
+    schema_href: Optional[str] = None
+)
+
+

Free-text Extension.

+

The Free-text extension adds an additional q parameter to /search requests which +allows the caller to perform free-text queries against STAC metadata.

+

stac-api-extensions/freetext-search?tab=readme-ov-file#advanced

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

FreeTextConformanceClasses

+
class FreeTextConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the Free-Text extension.

+

See stac-api-extensions/freetext-search

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
COLLECTIONS
+
+
COLLECTIONS_ADVANCED
+
+
ITEMS
+
+
ITEMS_ADVANCED
+
+
SEARCH
+
+
SEARCH_ADVANCED
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+

FreeTextExtension

+
class FreeTextExtension(
+    conformance_classes: List[str] = [<FreeTextConformanceClasses.SEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/item-search#free-text'>, <FreeTextConformanceClasses.COLLECTIONS: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text'>, <FreeTextConformanceClasses.ITEMS: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#free-text'>],
+    schema_href: Optional[str] = None
+)
+
+

Free-text Extension.

+

The Free-text extension adds an additional q parameter to /search requests which +allows the caller to perform free-text queries against STAC metadata.

+

stac-api-extensions/freetext-search?tab=readme-ov-file#basic

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/free_text/index.html b/api/stac_fastapi/extensions/core/free_text/index.html new file mode 100644 index 000000000..2d31ee0f1 --- /dev/null +++ b/api/stac_fastapi/extensions/core/free_text/index.html @@ -0,0 +1,3940 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.free_text

+

Query extension module.

+

Sub-modules

+ +

Classes

+

FreeTextAdvancedExtension

+
class FreeTextAdvancedExtension(
+    conformance_classes: List[str] = [<FreeTextConformanceClasses.SEARCH_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/item-search#advanced-free-text'>, <FreeTextConformanceClasses.COLLECTIONS_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search#advanced-free-text'>, <FreeTextConformanceClasses.ITEMS_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#advanced-free-text'>],
+    schema_href: Optional[str] = None
+)
+
+

Free-text Extension.

+

The Free-text extension adds an additional q parameter to /search requests which +allows the caller to perform free-text queries against STAC metadata.

+

stac-api-extensions/freetext-search?tab=readme-ov-file#advanced

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

FreeTextConformanceClasses

+
class FreeTextConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the Free-Text extension.

+

See stac-api-extensions/freetext-search

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
COLLECTIONS
+
+
COLLECTIONS_ADVANCED
+
+
ITEMS
+
+
ITEMS_ADVANCED
+
+
SEARCH
+
+
SEARCH_ADVANCED
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+

FreeTextExtension

+
class FreeTextExtension(
+    conformance_classes: List[str] = [<FreeTextConformanceClasses.SEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/item-search#free-text'>, <FreeTextConformanceClasses.COLLECTIONS: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text'>, <FreeTextConformanceClasses.ITEMS: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#free-text'>],
+    schema_href: Optional[str] = None
+)
+
+

Free-text Extension.

+

The Free-text extension adds an additional q parameter to /search requests which +allows the caller to perform free-text queries against STAC metadata.

+

stac-api-extensions/freetext-search?tab=readme-ov-file#basic

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/free_text/request/index.html b/api/stac_fastapi/extensions/core/free_text/request/index.html new file mode 100644 index 000000000..e195786bd --- /dev/null +++ b/api/stac_fastapi/extensions/core/free_text/request/index.html @@ -0,0 +1,5167 @@ + + + + + + + + + + + + + + + + + + + + + + + + + request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.free_text.request

+

Request model for the Free-text extension.

+

Classes

+

FreeTextAdvancedExtensionGetRequest

+
class FreeTextAdvancedExtensionGetRequest(
+    q: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Free-text Extension GET request model.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

FreeTextAdvancedExtensionPostRequest

+
class FreeTextAdvancedExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Free-text Extension POST request model.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+

FreeTextExtensionGetRequest

+
class FreeTextExtensionGetRequest(
+    q: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Free-text Extension GET request model.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

FreeTextExtensionPostRequest

+
class FreeTextExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Free-text Extension POST request model.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/index.html b/api/stac_fastapi/extensions/core/index.html new file mode 100644 index 000000000..d7c40205b --- /dev/null +++ b/api/stac_fastapi/extensions/core/index.html @@ -0,0 +1,5164 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core

+

stac_api.extensions.core module.

+

Sub-modules

+ +

Classes

+

AggregationExtension

+
class AggregationExtension(
+    schema_href: Optional[str] = None,
+    client: Union[stac_fastapi.extensions.core.aggregation.client.AsyncBaseAggregationClient, stac_fastapi.extensions.core.aggregation.client.BaseAggregationClient] = NOTHING,
+    conformance_classes: List[str] = [<AggregationConformanceClasses.AGGREGATION: 'https://api.stacspec.org/v0.3.0/aggregation'>],
+    router: fastapi.routing.APIRouter = NOTHING
+)
+
+

Aggregation Extension.

+

The purpose of the Aggregation Extension is to provide an endpoint similar to +the Search endpoint (/search), but which will provide aggregated information +on matching Items rather than the Items themselves. This is highly influenced +by the Elasticsearch and OpenSearch aggregation endpoint, but with a more +regular structure for responses.

+

The Aggregation extension adds several endpoints which allow the retrieval of +available aggregation fields and aggregation buckets based on a seearch query: + GET /aggregations + POST /aggregations + GET /collections/{collection_id}/aggregations + POST /collections/{collection_id}/aggregations + GET /aggregate + POST /aggregate + GET /collections/{collection_id}/aggregate + POST /collections/{collection_id}/aggregate

+

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

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classesNoneConformance classes provided by the extensionNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

CollectionSearchExtension

+
class CollectionSearchExtension(
+    GET: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest'>,
+    conformance_classes: List[str] = [<ConformanceClasses.COLLECTIONSEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search'>, <ConformanceClasses.BASIS: 'http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query'>],
+    schema_href: Optional[str] = None
+)
+
+

Collection-Search Extension.

+

The Collection-Search extension adds functionality to the GET - /collections +endpoint which allows the caller to include or exclude specific from the API +response. +Registering this extension with the application has the added effect of +removing the ItemCollection response model from the /search endpoint, as +the Fields extension allows the API to return potentially invalid responses +by excluding fields which are required by the STAC spec, such as geometry.

+

stac-api-extensions/collection-search

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.CollectionSearchPostExtension
    • +
+

Class variables

+
GET
+
+
POST
+
+

Static methods

+

from_extensions

+
def from_extensions(
+    extensions: List[stac_fastapi.types.extension.ApiExtension],
+    schema_href: Optional[str] = None
+) -> 'CollectionSearchExtension'
+
+

Create CollectionSearchExtension object from extensions.

+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appfastapi.FastAPItarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

CollectionSearchPostExtension

+
class CollectionSearchPostExtension(
+    client: Union[stac_fastapi.extensions.core.collection_search.client.AsyncBaseCollectionSearchClient, stac_fastapi.extensions.core.collection_search.client.BaseCollectionSearchClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    conformance_classes: List[str] = [<ConformanceClasses.COLLECTIONSEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search'>, <ConformanceClasses.BASIS: 'http://www.opengis.net/spec/ogcapi-common-2/1.0/conf/simple-query'>],
+    schema_href: Optional[str] = None,
+    router: fastapi.routing.APIRouter = NOTHING,
+    GET: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest'>,
+    POST: stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest = <class 'stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchPostRequest'>
+)
+
+

Collection-Search Extension.

+

Extents the collection-search extension with an additional +POST - /collections endpoint

+

NOTE: the POST - /collections endpoint can be conflicting with the +POST /collections endpoint registered for the Transaction extension.

+

stac-api-extensions/collection-search

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.extensions.core.CollectionSearchExtension
    • +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Static methods

+

from_extensions

+
def from_extensions(
+    extensions: List[stac_fastapi.types.extension.ApiExtension],
+    *,
+    client: Union[stac_fastapi.extensions.core.collection_search.client.AsyncBaseCollectionSearchClient, stac_fastapi.extensions.core.collection_search.client.BaseCollectionSearchClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    schema_href: Optional[str] = None,
+    router: Optional[fastapi.routing.APIRouter] = None
+) -> 'CollectionSearchPostExtension'
+
+

Create CollectionSearchPostExtension object from extensions.

+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

FieldsExtension

+
class FieldsExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Fields Extension.

+

The Fields extension adds functionality to the /search endpoint which +allows the caller to include or exclude specific from the API response. +Registering this extension with the application has the added effect of +removing the ItemCollection response model from the /search endpoint, as +the Fields extension allows the API to return potentially invalid responses +by excluding fields which are required by the STAC spec, such as geometry.

+

stac-api-extensions/fields

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
default_includessetdefines the default set of included fields.None
conformance_classeslistDefines the list of conformance classes for
the extension		None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appfastapi.FastAPItarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

FilterExtension

+
class FilterExtension(
+    schema_href: Optional[str] = None,
+    client: Union[stac_fastapi.extensions.core.filter.client.AsyncBaseFiltersClient, stac_fastapi.extensions.core.filter.client.BaseFiltersClient] = NOTHING,
+    conformance_classes: List[str] = [<FilterConformanceClasses.FILTER: 'http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter'>, <FilterConformanceClasses.FEATURES_FILTER: 'http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter'>, <FilterConformanceClasses.ITEM_SEARCH_FILTER: 'https://api.stacspec.org/v1.0.0-rc.2/item-search#filter'>, <FilterConformanceClasses.BASIC_CQL2: 'http://www.opengis.net/spec/cql2/1.0/conf/basic-cql2'>, <FilterConformanceClasses.CQL2_JSON: 'http://www.opengis.net/spec/cql2/1.0/conf/cql2-json'>, <FilterConformanceClasses.CQL2_TEXT: 'http://www.opengis.net/spec/cql2/1.0/conf/cql2-text'>],
+    router: fastapi.routing.APIRouter = NOTHING,
+    response_class: Type[starlette.responses.Response] = <class 'stac_fastapi.api.models.JSONSchemaResponse'>
+)
+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
clientNoneQueryables endpoint logicNone
conformance_classesNoneConformance classes provided by the extensionNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

FreeTextAdvancedExtension

+
class FreeTextAdvancedExtension(
+    conformance_classes: List[str] = [<FreeTextConformanceClasses.SEARCH_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/item-search#advanced-free-text'>, <FreeTextConformanceClasses.COLLECTIONS_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search#advanced-free-text'>, <FreeTextConformanceClasses.ITEMS_ADVANCED: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#advanced-free-text'>],
+    schema_href: Optional[str] = None
+)
+
+

Free-text Extension.

+

The Free-text extension adds an additional q parameter to /search requests which +allows the caller to perform free-text queries against STAC metadata.

+

stac-api-extensions/freetext-search?tab=readme-ov-file#advanced

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

FreeTextExtension

+
class FreeTextExtension(
+    conformance_classes: List[str] = [<FreeTextConformanceClasses.SEARCH: 'https://api.stacspec.org/v1.0.0-rc.1/item-search#free-text'>, <FreeTextConformanceClasses.COLLECTIONS: 'https://api.stacspec.org/v1.0.0-rc.1/collection-search#free-text'>, <FreeTextConformanceClasses.ITEMS: 'https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features#free-text'>],
+    schema_href: Optional[str] = None
+)
+
+

Free-text Extension.

+

The Free-text extension adds an additional q parameter to /search requests which +allows the caller to perform free-text queries against STAC metadata.

+

stac-api-extensions/freetext-search?tab=readme-ov-file#basic

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

OffsetPaginationExtension

+
class OffsetPaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Offset Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

PaginationExtension

+
class PaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Token Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

QueryExtension

+
class QueryExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Query Extension.

+

The Query extension adds an additional query parameter to /search requests which +allows the caller to perform queries against item metadata (ex. find all images with +cloud cover less than 15%). +stac-api-extensions/query

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

SortExtension

+
class SortExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Sort Extension.

+

The Sort extension adds the sortby parameter to the /search endpoint, allowing the +caller to specify the sort order of the returned items. +stac-api-extensions/sort

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

TokenPaginationExtension

+
class TokenPaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Token Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

TransactionExtension

+
class TransactionExtension(
+    client: Union[stac_fastapi.types.core.AsyncBaseTransactionsClient, stac_fastapi.types.core.BaseTransactionsClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None,
+    router: fastapi.routing.APIRouter = NOTHING,
+    response_class: Type[starlette.responses.Response] = <class 'starlette.responses.JSONResponse'>
+)
+
+

Transaction Extension.

+

The transaction extension adds several endpoints which allow the creation, +deletion, and updating of items and collections: + POST /collections + PUT /collections/{collection_id} + DELETE /collections/{collection_id} + POST /collections/{collection_id}/items + PUT /collections/{collection_id}/items + DELETE /collections/{collection_id}/items

+

stac-api-extensions/transaction +stac-api-extensions/collection-transaction

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
clientNoneCRUD application logicNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_create_collection

+
def register_create_collection(
+    self
+)
+
+

Register create collection endpoint (POST /collections).

+

register_create_item

+
def register_create_item(
+    self
+)
+
+

Register create item endpoint (POST /collections/{collection_id}/items).

+

register_delete_collection

+
def register_delete_collection(
+    self
+)
+
+

Register delete collection endpoint (DELETE /collections/{collection_id}).

+

register_delete_item

+
def register_delete_item(
+    self
+)
+
+

Register delete item endpoint (DELETE

+

/collections/{collection_id}/items/{item_id}).

+

register_patch_collection

+
def register_patch_collection(
+    self
+)
+
+

Register patch collection endpoint (PATCH /collections/{collection_id}).

+

register_patch_item

+
def register_patch_item(
+    self
+)
+
+

Register patch item endpoint (PATCH

+

/collections/{collection_id}/items/{item_id}).

+

register_update_collection

+
def register_update_collection(
+    self
+)
+
+

Register update collection endpoint (PUT /collections/{collection_id}).

+

register_update_item

+
def register_update_item(
+    self
+)
+
+

Register update item endpoint (PUT

+

/collections/{collection_id}/items/{item_id}).

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/pagination/index.html b/api/stac_fastapi/extensions/core/pagination/index.html new file mode 100644 index 000000000..2d379e37f --- /dev/null +++ b/api/stac_fastapi/extensions/core/pagination/index.html @@ -0,0 +1,2671 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.pagination

+

Pagination classes as extensions.

+

Sub-modules

+ +

Classes

+

OffsetPaginationExtension

+
class OffsetPaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Offset Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

PaginationExtension

+
class PaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Token Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

TokenPaginationExtension

+
class TokenPaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Token Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/pagination/offset_pagination/index.html b/api/stac_fastapi/extensions/core/pagination/offset_pagination/index.html new file mode 100644 index 000000000..623bc6d8e --- /dev/null +++ b/api/stac_fastapi/extensions/core/pagination/offset_pagination/index.html @@ -0,0 +1,2137 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.pagination.offset_pagination - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.pagination.offset_pagination

+

Pagination API extension.

+

Classes

+

OffsetPaginationExtension

+
class OffsetPaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Offset Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/pagination/pagination/index.html b/api/stac_fastapi/extensions/core/pagination/pagination/index.html new file mode 100644 index 000000000..085db8dec --- /dev/null +++ b/api/stac_fastapi/extensions/core/pagination/pagination/index.html @@ -0,0 +1,2264 @@ + + + + + + + + + + + + + + + + + + + + + + + + + pagination - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.pagination.pagination

+

Pagination API extension.

+

Classes

+

PaginationExtension

+
class PaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Token Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/pagination/request/index.html b/api/stac_fastapi/extensions/core/pagination/request/index.html new file mode 100644 index 000000000..9f507236a --- /dev/null +++ b/api/stac_fastapi/extensions/core/pagination/request/index.html @@ -0,0 +1,5720 @@ + + + + + + + + + + + + + + + + + + + + + Module stac_fastapi.extensions.core.pagination.request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.pagination.request

+

Pagination extension request models.

+

Classes

+

GETOffsetPagination

+
class GETOffsetPagination(
+    offset: Annotated[Optional[int], Query(PydanticUndefined)] = None
+)
+
+

Offset pagination for GET requests.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

GETPagination

+
class GETPagination(
+    page: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Page based pagination for GET requests.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

GETTokenPagination

+
class GETTokenPagination(
+    token: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Token pagination for GET requests.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

POSTOffsetPagination

+
class POSTOffsetPagination(
+    /,
+    **data: 'Any'
+)
+
+

Offset pagination model for POST requests.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+

POSTPagination

+
class POSTPagination(
+    /,
+    **data: 'Any'
+)
+
+

Page based pagination for POST requests.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+

POSTTokenPagination

+
class POSTTokenPagination(
+    /,
+    **data: 'Any'
+)
+
+

Token pagination model for POST requests.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/pagination/token_pagination/index.html b/api/stac_fastapi/extensions/core/pagination/token_pagination/index.html new file mode 100644 index 000000000..6b96e7a39 --- /dev/null +++ b/api/stac_fastapi/extensions/core/pagination/token_pagination/index.html @@ -0,0 +1,2264 @@ + + + + + + + + + + + + + + + + + + + + + + + + + token_pagination - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.pagination.token_pagination

+

Token pagination API extension.

+

Classes

+

TokenPaginationExtension

+
class TokenPaginationExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Token Pagination.

+

Though not strictly an extension, the chosen pagination will modify the form of the +request object. By making pagination an extension class, we can use +create_request_model to dynamically add the correct pagination parameter to the +request model for OpenAPI generation.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/query/index.html b/api/stac_fastapi/extensions/core/query/index.html new file mode 100644 index 000000000..43066e040 --- /dev/null +++ b/api/stac_fastapi/extensions/core/query/index.html @@ -0,0 +1,2287 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.query

+

Query extension module.

+

Sub-modules

+ +

Classes

+

QueryExtension

+
class QueryExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Query Extension.

+

The Query extension adds an additional query parameter to /search requests which +allows the caller to perform queries against item metadata (ex. find all images with +cloud cover less than 15%). +stac-api-extensions/query

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/query/query/index.html b/api/stac_fastapi/extensions/core/query/query/index.html new file mode 100644 index 000000000..161956182 --- /dev/null +++ b/api/stac_fastapi/extensions/core/query/query/index.html @@ -0,0 +1,2264 @@ + + + + + + + + + + + + + + + + + + + + + + + + + query - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.query.query

+

Query extension.

+

Classes

+

QueryExtension

+
class QueryExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Query Extension.

+

The Query extension adds an additional query parameter to /search requests which +allows the caller to perform queries against item metadata (ex. find all images with +cloud cover less than 15%). +stac-api-extensions/query

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/query/request/index.html b/api/stac_fastapi/extensions/core/query/request/index.html new file mode 100644 index 000000000..b9c6d4287 --- /dev/null +++ b/api/stac_fastapi/extensions/core/query/request/index.html @@ -0,0 +1,3620 @@ + + + + + + + + + + + + + + + + + + + + + + + + + request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.query.request

+

Request model for the Query extension.

+

Classes

+

QueryExtensionGetRequest

+
class QueryExtensionGetRequest(
+    query: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Query Extension GET request model.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

QueryExtensionPostRequest

+
class QueryExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Query Extension POST request model.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/sort/index.html b/api/stac_fastapi/extensions/core/sort/index.html new file mode 100644 index 000000000..f58865bc7 --- /dev/null +++ b/api/stac_fastapi/extensions/core/sort/index.html @@ -0,0 +1,2286 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.sort

+

Sort extension module.

+

Sub-modules

+ +

Classes

+

SortExtension

+
class SortExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Sort Extension.

+

The Sort extension adds the sortby parameter to the /search endpoint, allowing the +caller to specify the sort order of the returned items. +stac-api-extensions/sort

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/sort/request/index.html b/api/stac_fastapi/extensions/core/sort/request/index.html new file mode 100644 index 000000000..803f4abe1 --- /dev/null +++ b/api/stac_fastapi/extensions/core/sort/request/index.html @@ -0,0 +1,3620 @@ + + + + + + + + + + + + + + + + + + + + + + + + + request - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.sort.request

+

Request model for the Sort Extension.

+

Classes

+

SortExtensionGetRequest

+
class SortExtensionGetRequest(
+    sortby: Annotated[Optional[str], Query(PydanticUndefined)] = None
+)
+
+

Sortby Parameter for GET requests.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

SortExtensionPostRequest

+
class SortExtensionPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Sortby parameter for POST requests.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/sort/sort/index.html b/api/stac_fastapi/extensions/core/sort/sort/index.html new file mode 100644 index 000000000..99498a793 --- /dev/null +++ b/api/stac_fastapi/extensions/core/sort/sort/index.html @@ -0,0 +1,2263 @@ + + + + + + + + + + + + + + + + + + + + + + + + + sort - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.sort.sort

+

Sort extension.

+

Classes

+

SortExtension

+
class SortExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Sort Extension.

+

The Sort extension adds the sortby parameter to the /search endpoint, allowing the +caller to specify the sort order of the returned items. +stac-api-extensions/sort

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/core/transaction/index.html b/api/stac_fastapi/extensions/core/transaction/index.html new file mode 100644 index 000000000..03dd37950 --- /dev/null +++ b/api/stac_fastapi/extensions/core/transaction/index.html @@ -0,0 +1,2817 @@ + + + + + + + + + + + + + + + + + + + + + + + + + transaction - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.core.transaction

+

Transaction extension.

+

Classes

+

PostItem

+
class PostItem(
+    collection_id: typing.Annotated[str, Path(PydanticUndefined)],
+    item: Annotated[Union[stac_pydantic.item.Item, stac_pydantic.item_collection.ItemCollection], Body(PydanticUndefined)] = None
+)
+
+

Create Item.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.api.models.CollectionUri
    • +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

PutCollection

+
class PutCollection(
+    collection_id: typing.Annotated[str, Path(PydanticUndefined)],
+    collection: typing.Annotated[stac_pydantic.collection.Collection, Body(PydanticUndefined)] = None
+)
+
+

Update Collection.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.api.models.CollectionUri
    • +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

PutItem

+
class PutItem(
+    collection_id: typing.Annotated[str, Path(PydanticUndefined)],
+    item_id: typing.Annotated[str, Path(PydanticUndefined)],
+    item: typing.Annotated[stac_pydantic.item.Item, Body(PydanticUndefined)] = None
+)
+
+

Update Item.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.api.models.ItemUri
    • +
  • stac_fastapi.types.search.APIRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

TransactionExtension

+
class TransactionExtension(
+    client: Union[stac_fastapi.types.core.AsyncBaseTransactionsClient, stac_fastapi.types.core.BaseTransactionsClient],
+    settings: stac_fastapi.types.config.ApiSettings,
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None,
+    router: fastapi.routing.APIRouter = NOTHING,
+    response_class: Type[starlette.responses.Response] = <class 'starlette.responses.JSONResponse'>
+)
+
+

Transaction Extension.

+

The transaction extension adds several endpoints which allow the creation, +deletion, and updating of items and collections: + POST /collections + PUT /collections/{collection_id} + DELETE /collections/{collection_id} + POST /collections/{collection_id}/items + PUT /collections/{collection_id}/items + DELETE /collections/{collection_id}/items

+

stac-api-extensions/transaction +stac-api-extensions/collection-transaction

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
clientNoneCRUD application logicNone
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

register_create_collection

+
def register_create_collection(
+    self
+)
+
+

Register create collection endpoint (POST /collections).

+

register_create_item

+
def register_create_item(
+    self
+)
+
+

Register create item endpoint (POST /collections/{collection_id}/items).

+

register_delete_collection

+
def register_delete_collection(
+    self
+)
+
+

Register delete collection endpoint (DELETE /collections/{collection_id}).

+

register_delete_item

+
def register_delete_item(
+    self
+)
+
+

Register delete item endpoint (DELETE

+

/collections/{collection_id}/items/{item_id}).

+

register_patch_collection

+
def register_patch_collection(
+    self
+)
+
+

Register patch collection endpoint (PATCH /collections/{collection_id}).

+

register_patch_item

+
def register_patch_item(
+    self
+)
+
+

Register patch item endpoint (PATCH

+

/collections/{collection_id}/items/{item_id}).

+

register_update_collection

+
def register_update_collection(
+    self
+)
+
+

Register update collection endpoint (PUT /collections/{collection_id}).

+

register_update_item

+
def register_update_item(
+    self
+)
+
+

Register update item endpoint (PUT

+

/collections/{collection_id}/items/{item_id}).

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/index.html b/api/stac_fastapi/extensions/index.html new file mode 100644 index 000000000..074fc0f06 --- /dev/null +++ b/api/stac_fastapi/extensions/index.html @@ -0,0 +1,2062 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/third_party/bulk_transactions/index.html b/api/stac_fastapi/extensions/third_party/bulk_transactions/index.html new file mode 100644 index 000000000..48f93f93f --- /dev/null +++ b/api/stac_fastapi/extensions/third_party/bulk_transactions/index.html @@ -0,0 +1,5460 @@ + + + + + + + + + + + + + + + + + + + + + + + + + bulk_transactions - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.third_party.bulk_transactions

+

Bulk transactions extension.

+

Classes

+

AsyncBaseBulkTransactionsClient

+
class AsyncBaseBulkTransactionsClient(
+
+)
+
+

BulkTransactionsClient.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

bulk_item_insert

+
def bulk_item_insert(
+    self,
+    items: stac_fastapi.extensions.third_party.bulk_transactions.Items,
+    **kwargs
+) -> str
+
+

Bulk creation of items.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
itemsNonelist of items.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneMessage indicating the status of the insert.
+

BaseBulkTransactionsClient

+
class BaseBulkTransactionsClient(
+
+)
+
+

BulkTransactionsClient.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

bulk_item_insert

+
def bulk_item_insert(
+    self,
+    items: stac_fastapi.extensions.third_party.bulk_transactions.Items,
+    chunk_size: Optional[int] = None,
+    **kwargs
+) -> str
+
+

Bulk creation of items.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
itemsNonelist of items.None
chunk_sizeNonenumber of items processed at a time.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneMessage indicating the status of the insert.
+

BulkTransactionExtension

+
class BulkTransactionExtension(
+    client: Union[stac_fastapi.extensions.third_party.bulk_transactions.AsyncBaseBulkTransactionsClient, stac_fastapi.extensions.third_party.bulk_transactions.BaseBulkTransactionsClient],
+    conformance_classes: List[str] = [],
+    schema_href: Optional[str] = None
+)
+
+

Bulk Transaction Extension.

+

Bulk Transaction extension adds the POST +/collections/{collection_id}/bulk_items endpoint to the application for +efficient bulk insertion of items. The input to this is an object with an +attribute "items", that has a value that is an object with a group of +attributes that are the ids of each Item, and the value is the Item entity.

+

Optionally, clients can specify a "method" attribute that is either "insert" +or "upsert". If "insert", then the items will be inserted if they do not +exist, and an error will be returned if they do. If "upsert", then the items +will be inserted if they do not exist, and updated if they do. This defaults +to "insert".

+
{
+    "items": {
+        "id1": { "type": "Feature", ... },
+        "id2": { "type": "Feature", ... },
+        "id3": { "type": "Feature", ... }
+    },
+    "method": "insert"
+}
+
+ +

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+

BulkTransactionMethod

+
class BulkTransactionMethod(
+    *args,
+    **kwds
+)
+
+

Bulk Transaction Methods.

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
INSERT
+
+
UPSERT
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+

Items

+
class Items(
+    /,
+    **data: 'Any'
+)
+
+

A group of STAC Item objects, in the form of a dictionary from Item.id -> Item.

+

Ancestors (in MRO)

+
    +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/third_party/index.html b/api/stac_fastapi/extensions/third_party/index.html new file mode 100644 index 000000000..a674737e8 --- /dev/null +++ b/api/stac_fastapi/extensions/third_party/index.html @@ -0,0 +1,2301 @@ + + + + + + + + + + + + + + + + + + + + + + + + + index - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.third_party

+

stac_api.extensions.third_party module.

+

Sub-modules

+ +

Classes

+

BulkTransactionExtension

+
class BulkTransactionExtension(
+    client: Union[stac_fastapi.extensions.third_party.bulk_transactions.AsyncBaseBulkTransactionsClient, stac_fastapi.extensions.third_party.bulk_transactions.BaseBulkTransactionsClient],
+    conformance_classes: List[str] = [],
+    schema_href: Optional[str] = None
+)
+
+

Bulk Transaction Extension.

+

Bulk Transaction extension adds the POST +/collections/{collection_id}/bulk_items endpoint to the application for +efficient bulk insertion of items. The input to this is an object with an +attribute "items", that has a value that is an object with a group of +attributes that are the ids of each Item, and the value is the Item entity.

+

Optionally, clients can specify a "method" attribute that is either "insert" +or "upsert". If "insert", then the items will be inserted if they do not +exist, and an error will be returned if they do. If "upsert", then the items +will be inserted if they do not exist, and updated if they do. This defaults +to "insert".

+
{
+    "items": {
+        "id1": { "type": "Feature", ... },
+        "id2": { "type": "Feature", ... },
+        "id3": { "type": "Feature", ... }
+    },
+    "method": "insert"
+}
+
+ +

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.extension.ApiExtension
    • +
  • abc.ABC
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/extensions/version/index.html b/api/stac_fastapi/extensions/version/index.html new file mode 100644 index 000000000..62906e7a9 --- /dev/null +++ b/api/stac_fastapi/extensions/version/index.html @@ -0,0 +1,2002 @@ + + + + + + + + + + + + + + + + + + + + + + + + + version - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.extensions.version

+

Library version.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/index.html b/api/stac_fastapi/index.html new file mode 100644 index 000000000..d79389f03 --- /dev/null +++ b/api/stac_fastapi/index.html @@ -0,0 +1,2059 @@ + + + + + + + + + + + + + + + + + + + + + + + + + packages - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/config/index.html b/api/stac_fastapi/types/config/index.html new file mode 100644 index 000000000..158bbf3fb --- /dev/null +++ b/api/stac_fastapi/types/config/index.html @@ -0,0 +1,3785 @@ + + + + + + + + + + + + + + + + + + + + + + + + + config - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.config

+

stac_fastapi.types.config module.

+

Classes

+

ApiSettings

+
class ApiSettings(
+    __pydantic_self__,
+    _case_sensitive: 'bool | None' = None,
+    _nested_model_default_partial_update: 'bool | None' = None,
+    _env_prefix: 'str | None' = None,
+    _env_file: 'DotenvType | None' = PosixPath('.'),
+    _env_file_encoding: 'str | None' = None,
+    _env_ignore_empty: 'bool | None' = None,
+    _env_nested_delimiter: 'str | None' = None,
+    _env_parse_none_str: 'str | None' = None,
+    _env_parse_enums: 'bool | None' = None,
+    _cli_prog_name: 'str | None' = None,
+    _cli_parse_args: 'bool | list[str] | tuple[str, ...] | None' = None,
+    _cli_settings_source: 'CliSettingsSource[Any] | None' = None,
+    _cli_parse_none_str: 'str | None' = None,
+    _cli_hide_none_type: 'bool | None' = None,
+    _cli_avoid_json: 'bool | None' = None,
+    _cli_enforce_required: 'bool | None' = None,
+    _cli_use_class_docs_for_groups: 'bool | None' = None,
+    _cli_exit_on_error: 'bool | None' = None,
+    _cli_prefix: 'str | None' = None,
+    _cli_implicit_flags: 'bool | None' = None,
+    _secrets_dir: 'PathType | None' = None,
+    **values: 'Any'
+)
+
+

ApiSettings.

+

Defines api configuration, potentially through environment variables. +See pydantic-docs.helpmanual.io/usage/settings/.

+

Attributes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
environmentNonename of the environment (ex. dev/prod).None
debugNonetoggles debug mode.None
forbidden_fieldsNoneset of fields defined by STAC but not included in the database.None
indexed_fieldsNoneset of fields which are usually in item.properties but are indexed
as distinct columns in the database.		None
+

Ancestors (in MRO)

+
    +
  • pydantic_settings.main.BaseSettings
    • +
  • pydantic.main.BaseModel
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

settings_customise_sources

+
def settings_customise_sources(
+    settings_cls: 'type[BaseSettings]',
+    init_settings: 'PydanticBaseSettingsSource',
+    env_settings: 'PydanticBaseSettingsSource',
+    dotenv_settings: 'PydanticBaseSettingsSource',
+    file_secret_settings: 'PydanticBaseSettingsSource'
+) -> 'tuple[PydanticBaseSettingsSource, ...]'
+
+

Define the sources and their order for loading the settings values.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
settings_clsNoneThe Settings class.None
init_settingsNoneThe InitSettingsSource instance.None
env_settingsNoneThe EnvSettingsSource instance.None
dotenv_settingsNoneThe DotEnvSettingsSource instance.None
file_secret_settingsNoneThe SecretsSettingsSource instance.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA tuple containing the sources and their order for loading the settings values.
+

update_forward_refs

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

validate

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

Instance variables

+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

+
def model_post_init(
+    self,
+    _BaseModel__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.

+

Settings

+
class Settings(
+    /,
+    *args,
+    **kwargs
+)
+
+

Holds the global instance of settings.

+

Static methods

+

get

+
def get(
+
+) -> stac_fastapi.types.config.ApiSettings
+
+

Get the settings.

+

If they have not yet been set, throws an exception.

+

set

+
def set(
+    base_settings: stac_fastapi.types.config.ApiSettings
+)
+
+

Set the global settings.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/conformance/index.html b/api/stac_fastapi/types/conformance/index.html new file mode 100644 index 000000000..0818a6cf7 --- /dev/null +++ b/api/stac_fastapi/types/conformance/index.html @@ -0,0 +1,5006 @@ + + + + + + + + + + + + + + + + + + + + + + + + + conformance - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.conformance

+

Conformance Classes.

+

Variables

+
BASE_CONFORMANCE_CLASSES
+
+

Classes

+

OAFConformanceClasses

+
class OAFConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for OGC API - Features.

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
CORE
+
+
GEOJSON
+
+
OPEN_API
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+

STACConformanceClasses

+
class STACConformanceClasses(
+    *args,
+    **kwds
+)
+
+

Conformance classes for the STAC API spec.

+

Ancestors (in MRO)

+
    +
  • builtins.str
    • +
  • enum.Enum
    • +
+

Class variables

+
COLLECTIONS
+
+
CORE
+
+
ITEM_SEARCH
+
+
OGC_API_FEAT
+
+
name
+
+
value
+
+

Static methods

+

maketrans

+
def maketrans(
+    ...
+)
+
+

Return a translation table usable for str.translate().

+

If there is only one argument, it must be a dictionary mapping Unicode +ordinals (integers) or characters to Unicode ordinals, strings or None. +Character keys will be then converted to ordinals. +If there are two arguments, they must be strings of equal length, and +in the resulting dictionary, each character in x will be mapped to the +character at the same position in y. If there is a third argument, it +must be a string, whose characters will be mapped to None in the result.

+

Methods

+

capitalize

+
def capitalize(
+    self,
+    /
+)
+
+

Return a capitalized version of the string.

+

More specifically, make the first character have upper case and the rest lower +case.

+

casefold

+
def casefold(
+    self,
+    /
+)
+
+

Return a version of the string suitable for caseless comparisons.

+

center

+
def center(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a centered string of length width.

+

Padding is done using the specified fill character (default is a space).

+

count

+
def count(
+    ...
+)
+
+

S.count(sub[, start[, end]]) -> int

+

Return the number of non-overlapping occurrences of substring sub in +string S[start:end]. Optional arguments start and end are +interpreted as in slice notation.

+

encode

+
def encode(
+    self,
+    /,
+    encoding='utf-8',
+    errors='strict'
+)
+
+

Encode the string using the codec registered for encoding.

+

encoding + The encoding in which to encode the string. +errors + The error handling scheme to use for encoding errors. + The default is 'strict' meaning that encoding errors raise a + UnicodeEncodeError. Other possible values are 'ignore', 'replace' and + 'xmlcharrefreplace' as well as any other name registered with + codecs.register_error that can handle UnicodeEncodeErrors.

+

endswith

+
def endswith(
+    ...
+)
+
+

S.endswith(suffix[, start[, end]]) -> bool

+

Return True if S ends with the specified suffix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +suffix can also be a tuple of strings to try.

+

expandtabs

+
def expandtabs(
+    self,
+    /,
+    tabsize=8
+)
+
+

Return a copy where all tab characters are expanded using spaces.

+

If tabsize is not given, a tab size of 8 characters is assumed.

+

find

+
def find(
+    ...
+)
+
+

S.find(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

format

+
def format(
+    ...
+)
+
+

S.format(args, *kwargs) -> str

+

Return a formatted version of S, using substitutions from args and kwargs. +The substitutions are identified by braces ('{' and '}').

+

format_map

+
def format_map(
+    ...
+)
+
+

S.format_map(mapping) -> str

+

Return a formatted version of S, using substitutions from mapping. +The substitutions are identified by braces ('{' and '}').

+

index

+
def index(
+    ...
+)
+
+

S.index(sub[, start[, end]]) -> int

+

Return the lowest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

isalnum

+
def isalnum(
+    self,
+    /
+)
+
+

Return True if the string is an alpha-numeric string, False otherwise.

+

A string is alpha-numeric if all characters in the string are alpha-numeric and +there is at least one character in the string.

+

isalpha

+
def isalpha(
+    self,
+    /
+)
+
+

Return True if the string is an alphabetic string, False otherwise.

+

A string is alphabetic if all characters in the string are alphabetic and there +is at least one character in the string.

+

isascii

+
def isascii(
+    self,
+    /
+)
+
+

Return True if all characters in the string are ASCII, False otherwise.

+

ASCII characters have code points in the range U+0000-U+007F. +Empty string is ASCII too.

+

isdecimal

+
def isdecimal(
+    self,
+    /
+)
+
+

Return True if the string is a decimal string, False otherwise.

+

A string is a decimal string if all characters in the string are decimal and +there is at least one character in the string.

+

isdigit

+
def isdigit(
+    self,
+    /
+)
+
+

Return True if the string is a digit string, False otherwise.

+

A string is a digit string if all characters in the string are digits and there +is at least one character in the string.

+

isidentifier

+
def isidentifier(
+    self,
+    /
+)
+
+

Return True if the string is a valid Python identifier, False otherwise.

+

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, +such as "def" or "class".

+

islower

+
def islower(
+    self,
+    /
+)
+
+

Return True if the string is a lowercase string, False otherwise.

+

A string is lowercase if all cased characters in the string are lowercase and +there is at least one cased character in the string.

+

isnumeric

+
def isnumeric(
+    self,
+    /
+)
+
+

Return True if the string is a numeric string, False otherwise.

+

A string is numeric if all characters in the string are numeric and there is at +least one character in the string.

+

isprintable

+
def isprintable(
+    self,
+    /
+)
+
+

Return True if the string is printable, False otherwise.

+

A string is printable if all of its characters are considered printable in +repr() or if it is empty.

+

isspace

+
def isspace(
+    self,
+    /
+)
+
+

Return True if the string is a whitespace string, False otherwise.

+

A string is whitespace if all characters in the string are whitespace and there +is at least one character in the string.

+

istitle

+
def istitle(
+    self,
+    /
+)
+
+

Return True if the string is a title-cased string, False otherwise.

+

In a title-cased string, upper- and title-case characters may only +follow uncased characters and lowercase characters only cased ones.

+

isupper

+
def isupper(
+    self,
+    /
+)
+
+

Return True if the string is an uppercase string, False otherwise.

+

A string is uppercase if all cased characters in the string are uppercase and +there is at least one cased character in the string.

+

join

+
def join(
+    self,
+    iterable,
+    /
+)
+
+

Concatenate any number of strings.

+

The string whose method is called is inserted in between each given string. +The result is returned as a new string.

+

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

+

ljust

+
def ljust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a left-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

lower

+
def lower(
+    self,
+    /
+)
+
+

Return a copy of the string converted to lowercase.

+

lstrip

+
def lstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

partition

+
def partition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string. If the separator is found, +returns a 3-tuple containing the part before the separator, the separator +itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing the original string +and two empty strings.

+

removeprefix

+
def removeprefix(
+    self,
+    prefix,
+    /
+)
+
+

Return a str with the given prefix string removed if present.

+

If the string starts with the prefix string, return string[len(prefix):]. +Otherwise, return a copy of the original string.

+

removesuffix

+
def removesuffix(
+    self,
+    suffix,
+    /
+)
+
+

Return a str with the given suffix string removed if present.

+

If the string ends with the suffix string and that suffix is not empty, +return string[:-len(suffix)]. Otherwise, return a copy of the original +string.

+

replace

+
def replace(
+    self,
+    old,
+    new,
+    count=-1,
+    /
+)
+
+

Return a copy with all occurrences of substring old replaced by new.

+

count + Maximum number of occurrences to replace. + -1 (the default value) means replace all occurrences.

+

If the optional argument count is given, only the first count occurrences are +replaced.

+

rfind

+
def rfind(
+    ...
+)
+
+

S.rfind(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Return -1 on failure.

+

rindex

+
def rindex(
+    ...
+)
+
+

S.rindex(sub[, start[, end]]) -> int

+

Return the highest index in S where substring sub is found, +such that sub is contained within S[start:end]. Optional +arguments start and end are interpreted as in slice notation.

+

Raises ValueError when the substring is not found.

+

rjust

+
def rjust(
+    self,
+    width,
+    fillchar=' ',
+    /
+)
+
+

Return a right-justified string of length width.

+

Padding is done using the specified fill character (default is a space).

+

rpartition

+
def rpartition(
+    self,
+    sep,
+    /
+)
+
+

Partition the string into three parts using the given separator.

+

This will search for the separator in the string, starting at the end. If +the separator is found, returns a 3-tuple containing the part before the +separator, the separator itself, and the part after it.

+

If the separator is not found, returns a 3-tuple containing two empty strings +and the original string.

+

rsplit

+
def rsplit(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the end of the string and works to the front.

+

rstrip

+
def rstrip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

split

+
def split(
+    self,
+    /,
+    sep=None,
+    maxsplit=-1
+)
+
+

Return a list of the substrings in the string, using sep as the separator string.

+

sep + The separator used to split the string.

+
When set to None (the default value), will split on any whitespace
+character (including \n \r \t \f and spaces) and will discard
+empty strings from the result.
+
+ +

maxsplit + Maximum number of splits. + -1 (the default value) means no limit.

+

Splitting starts at the front of the string and works to the end.

+

Note, str.split() is mainly useful for data that has been intentionally +delimited. With natural text that includes punctuation, consider using +the regular expression module.

+

splitlines

+
def splitlines(
+    self,
+    /,
+    keepends=False
+)
+
+

Return a list of the lines in the string, breaking at line boundaries.

+

Line breaks are not included in the resulting list unless keepends is given and +true.

+

startswith

+
def startswith(
+    ...
+)
+
+

S.startswith(prefix[, start[, end]]) -> bool

+

Return True if S starts with the specified prefix, False otherwise. +With optional start, test S beginning at that position. +With optional end, stop comparing S at that position. +prefix can also be a tuple of strings to try.

+

strip

+
def strip(
+    self,
+    chars=None,
+    /
+)
+
+

Return a copy of the string with leading and trailing whitespace removed.

+

If chars is given and not None, remove characters in chars instead.

+

swapcase

+
def swapcase(
+    self,
+    /
+)
+
+

Convert uppercase characters to lowercase and lowercase characters to uppercase.

+

title

+
def title(
+    self,
+    /
+)
+
+

Return a version of the string where each word is titlecased.

+

More specifically, words start with uppercased characters and all remaining +cased characters have lower case.

+

translate

+
def translate(
+    self,
+    table,
+    /
+)
+
+

Replace each character in the string using the given translation table.

+

table + Translation table, which must be a mapping of Unicode ordinals to + Unicode ordinals, strings, or None.

+

The table must implement lookup/indexing via getitem, for instance a +dictionary or list. If this operation raises LookupError, the character is +left untouched. Characters mapped to None are deleted.

+

upper

+
def upper(
+    self,
+    /
+)
+
+

Return a copy of the string converted to uppercase.

+

zfill

+
def zfill(
+    self,
+    width,
+    /
+)
+
+

Pad a numeric string with zeros on the left, to fill a field of the given width.

+

The string is never truncated.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/core/index.html b/api/stac_fastapi/types/core/index.html new file mode 100644 index 000000000..4ebf347b9 --- /dev/null +++ b/api/stac_fastapi/types/core/index.html @@ -0,0 +1,4408 @@ + + + + + + + + + + + + + + + + + + + + + + + + + core - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.core

+

Base clients.

+

Variables

+
NumType
+
+
StacType
+
+

Classes

+

AsyncBaseCoreClient

+
class AsyncBaseCoreClient(
+    stac_version: str = '1.0.0',
+    landing_page_id: str = 'stac-fastapi',
+    title: str = 'stac-fastapi',
+    description: str = 'stac-fastapi',
+    base_conformance_classes: List[str] = NOTHING,
+    extensions: List[stac_fastapi.types.extension.ApiExtension] = NOTHING,
+    post_request_model=<class 'stac_fastapi.types.search.BaseSearchPostRequest'>
+)
+
+

Defines a pattern for implementing STAC api core endpoints.

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
extensionsNonelist of registered api extensions.None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.core.LandingPageMixin
    • +
  • abc.ABC
    • +
+

Class variables

+
post_request_model
+
+

Methods

+

all_collections

+
def all_collections(
+    self,
+    **kwargs
+) -> stac_fastapi.types.stac.Collections
+
+

Get all available collections.

+

Called with GET /collections.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA list of collections.
+

conformance

+
def conformance(
+    self,
+    **kwargs
+) -> stac_fastapi.types.stac.Conformance
+
+

Conformance classes.

+

Called with GET /conformance.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneConformance classes which the server conforms to.
+

conformance_classes

+
def conformance_classes(
+    self
+) -> List[str]
+
+

Generate conformance classes by adding extension conformance to base

+

conformance classes.

+

extension_is_enabled

+
def extension_is_enabled(
+    self,
+    extension: str
+) -> bool
+
+

Check if an api extension is enabled.

+

get_collection

+
def get_collection(
+    self,
+    collection_id: str,
+    **kwargs
+) -> stac_fastapi.types.stac.Collection
+
+

Get collection by id.

+

Called with GET /collections/{collection_id}.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneId of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneCollection.
+

get_item

+
def get_item(
+    self,
+    item_id: str,
+    collection_id: str,
+    **kwargs
+) -> stac_fastapi.types.stac.Item
+
+

Get item by id.

+

Called with GET /collections/{collection_id}/items/{item_id}.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
item_idNoneId of the item.None
collection_idNoneId of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneItem.
+ +
def get_search(
+    self,
+    collections: Optional[List[str]] = None,
+    ids: Optional[List[str]] = None,
+    bbox: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]], NoneType] = None,
+    intersects: Optional[Annotated[Union[geojson_pydantic.geometries.Point, geojson_pydantic.geometries.MultiPoint, geojson_pydantic.geometries.LineString, geojson_pydantic.geometries.MultiLineString, geojson_pydantic.geometries.Polygon, geojson_pydantic.geometries.MultiPolygon, geojson_pydantic.geometries.GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] = None,
+    datetime: Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType] = None,
+    limit: Optional[int] = 10,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Cross catalog search (GET).

+

Called with GET /search.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneItemCollection containing items which match the search criteria.
+

item_collection

+
def item_collection(
+    self,
+    collection_id: str,
+    bbox: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]], NoneType] = None,
+    datetime: Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType] = None,
+    limit: int = 10,
+    token: str = None,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Get all items from a specific collection.

+

Called with GET /collections/{collection_id}/items

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneid of the collection.None
limitNonenumber of items to return.None
tokenNonepagination token.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneAn ItemCollection.
+

landing_page

+
def landing_page(
+    self,
+    **kwargs
+) -> stac_fastapi.types.stac.LandingPage
+
+

Landing page.

+

Called with GET /.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneAPI landing page, serving as an entry point to the API.
+

post_search

+
def post_search(
+    self,
+    search_request: stac_fastapi.types.search.BaseSearchPostRequest,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Cross catalog search (POST).

+

Called with POST /search.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
search_requestNonesearch request parameters.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneItemCollection containing items which match the search criteria.
+

AsyncBaseTransactionsClient

+
class AsyncBaseTransactionsClient(
+
+)
+
+

Defines a pattern for implementing the STAC transaction extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

create_collection

+
def create_collection(
+    self,
+    collection: stac_pydantic.collection.Collection,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Collection, starlette.responses.Response, NoneType]
+
+

Create a new collection.

+

Called with POST /collections.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collectionNonethe collectionNone
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe collection that was created.
+

create_item

+
def create_item(
+    self,
+    collection_id: str,
+    item: Union[stac_pydantic.item.Item, stac_pydantic.item_collection.ItemCollection],
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Item, starlette.responses.Response, NoneType]
+
+

Create a new item.

+

Called with POST /collections/{collection_id}/items.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
itemNonethe item or item collectionNone
collection_idNonethe id of the collection from the resource pathNone
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe item that was created or None if item collection.
+

delete_collection

+
def delete_collection(
+    self,
+    collection_id: str,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Collection, starlette.responses.Response, NoneType]
+
+

Delete a collection.

+

Called with DELETE /collections/{collection_id}

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneid of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe deleted collection.
+

delete_item

+
def delete_item(
+    self,
+    item_id: str,
+    collection_id: str,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Item, starlette.responses.Response, NoneType]
+
+

Delete an item from a collection.

+

Called with DELETE /collections/{collection_id}/items/{item_id}

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
item_idNoneid of the item.None
collection_idNoneid of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe deleted item.
+

update_collection

+
def update_collection(
+    self,
+    collection_id: str,
+    collection: stac_pydantic.collection.Collection,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Collection, starlette.responses.Response, NoneType]
+
+

Perform a complete update on an existing collection.

+

Called with PUT /collections/{collection_id}. It is expected that this item +already exists. The update should do a diff against the saved collection and +perform any necessary updates. Partial updates are not supported by the +transactions extension.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneid of the existing collection to be updatedNone
collectionNonethe updated collection (must be complete)None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe updated collection.
+

update_item

+
def update_item(
+    self,
+    collection_id: str,
+    item_id: str,
+    item: stac_pydantic.item.Item,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Item, starlette.responses.Response, NoneType]
+
+

Perform a complete update on an existing item.

+

Called with PUT /collections/{collection_id}/items. It is expected +that this item already exists. The update should do a diff against the +saved item and perform any necessary updates. Partial updates are not +supported by the transactions extension.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
itemNonethe item (must be complete)None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe updated item.
+

BaseCoreClient

+
class BaseCoreClient(
+    stac_version: str = '1.0.0',
+    landing_page_id: str = 'stac-fastapi',
+    title: str = 'stac-fastapi',
+    description: str = 'stac-fastapi',
+    base_conformance_classes: List[str] = NOTHING,
+    extensions: List[stac_fastapi.types.extension.ApiExtension] = NOTHING,
+    post_request_model=<class 'stac_fastapi.types.search.BaseSearchPostRequest'>
+)
+
+

Defines a pattern for implementing STAC api core endpoints.

+

Attributes

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
extensionsNonelist of registered api extensions.None
+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.core.LandingPageMixin
    • +
  • abc.ABC
    • +
+

Class variables

+
post_request_model
+
+

Methods

+

all_collections

+
def all_collections(
+    self,
+    **kwargs
+) -> stac_fastapi.types.stac.Collections
+
+

Get all available collections.

+

Called with GET /collections.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA list of collections.
+

conformance

+
def conformance(
+    self,
+    **kwargs
+) -> stac_fastapi.types.stac.Conformance
+
+

Conformance classes.

+

Called with GET /conformance.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneConformance classes which the server conforms to.
+

conformance_classes

+
def conformance_classes(
+    self
+) -> List[str]
+
+

Generate conformance classes by adding extension conformance to base

+

conformance classes.

+

extension_is_enabled

+
def extension_is_enabled(
+    self,
+    extension: str
+) -> bool
+
+

Check if an api extension is enabled.

+

get_collection

+
def get_collection(
+    self,
+    collection_id: str,
+    **kwargs
+) -> stac_fastapi.types.stac.Collection
+
+

Get collection by id.

+

Called with GET /collections/{collection_id}.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneId of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneCollection.
+

get_item

+
def get_item(
+    self,
+    item_id: str,
+    collection_id: str,
+    **kwargs
+) -> stac_fastapi.types.stac.Item
+
+

Get item by id.

+

Called with GET /collections/{collection_id}/items/{item_id}.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
item_idNoneId of the item.None
collection_idNoneId of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneItem.
+

get_search

+
def get_search(
+    self,
+    collections: Optional[List[str]] = None,
+    ids: Optional[List[str]] = None,
+    bbox: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]], NoneType] = None,
+    intersects: Optional[Annotated[Union[geojson_pydantic.geometries.Point, geojson_pydantic.geometries.MultiPoint, geojson_pydantic.geometries.LineString, geojson_pydantic.geometries.MultiLineString, geojson_pydantic.geometries.Polygon, geojson_pydantic.geometries.MultiPolygon, geojson_pydantic.geometries.GeometryCollection], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] = None,
+    datetime: Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType] = None,
+    limit: Optional[int] = 10,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Cross catalog search (GET).

+

Called with GET /search.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneItemCollection containing items which match the search criteria.
+

item_collection

+
def item_collection(
+    self,
+    collection_id: str,
+    bbox: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]], NoneType] = None,
+    datetime: Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType] = None,
+    limit: int = 10,
+    token: str = None,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Get all items from a specific collection.

+

Called with GET /collections/{collection_id}/items

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneid of the collection.None
limitNonenumber of items to return.None
tokenNonepagination token.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneAn ItemCollection.
+

landing_page

+
def landing_page(
+    self,
+    **kwargs
+) -> stac_fastapi.types.stac.LandingPage
+
+

Landing page.

+

Called with GET /.

+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneAPI landing page, serving as an entry point to the API.
+

list_conformance_classes

+
def list_conformance_classes(
+    self
+)
+
+

Return a list of conformance classes, including implemented extensions.

+

post_search

+
def post_search(
+    self,
+    search_request: stac_fastapi.types.search.BaseSearchPostRequest,
+    **kwargs
+) -> stac_fastapi.types.stac.ItemCollection
+
+

Cross catalog search (POST).

+

Called with POST /search.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
search_requestNonesearch request parameters.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneItemCollection containing items which match the search criteria.
+

BaseTransactionsClient

+
class BaseTransactionsClient(
+
+)
+
+

Defines a pattern for implementing the STAC API Transaction Extension.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Methods

+

create_collection

+
def create_collection(
+    self,
+    collection: stac_pydantic.collection.Collection,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Collection, starlette.responses.Response, NoneType]
+
+

Create a new collection.

+

Called with POST /collections.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collectionNonethe collectionNone
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe collection that was created.
+

create_item

+
def create_item(
+    self,
+    collection_id: str,
+    item: Union[stac_pydantic.item.Item, stac_pydantic.item_collection.ItemCollection],
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Item, starlette.responses.Response, NoneType]
+
+

Create a new item.

+

Called with POST /collections/{collection_id}/items.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
itemNonethe item or item collectionNone
collection_idNonethe id of the collection from the resource pathNone
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe item that was created or None if item collection.
+

delete_collection

+
def delete_collection(
+    self,
+    collection_id: str,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Collection, starlette.responses.Response, NoneType]
+
+

Delete a collection.

+

Called with DELETE /collections/{collection_id}

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneid of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe deleted collection.
+

delete_item

+
def delete_item(
+    self,
+    item_id: str,
+    collection_id: str,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Item, starlette.responses.Response, NoneType]
+
+

Delete an item from a collection.

+

Called with DELETE /collections/{collection_id}/items/{item_id}

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
item_idNoneid of the item.None
collection_idNoneid of the collection.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe deleted item.
+

update_collection

+
def update_collection(
+    self,
+    collection_id: str,
+    collection: stac_pydantic.collection.Collection,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Collection, starlette.responses.Response, NoneType]
+
+

Perform a complete update on an existing collection.

+

Called with PUT /collections/{collection_id}. It is expected that this +collection already exists. The update should do a diff against the saved +collection and perform any necessary updates. Partial updates are not +supported by the transactions extension.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
collection_idNoneid of the existing collection to be updatedNone
collectionNonethe updated collection (must be complete)None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe updated collection.
+

update_item

+
def update_item(
+    self,
+    collection_id: str,
+    item_id: str,
+    item: stac_pydantic.item.Item,
+    **kwargs
+) -> Union[stac_fastapi.types.stac.Item, starlette.responses.Response, NoneType]
+
+

Perform a complete update on an existing item.

+

Called with PUT /collections/{collection_id}/items. It is expected +that this item already exists. The update should do a diff against the +saved item and perform any necessary updates. Partial updates are not +supported by the transactions extension.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
itemNonethe item (must be complete)None
collection_idNonethe id of the collection from the resource pathNone
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe updated item.
+

LandingPageMixin

+
class LandingPageMixin(
+    stac_version: str = '1.0.0',
+    landing_page_id: str = 'stac-fastapi',
+    title: str = 'stac-fastapi',
+    description: str = 'stac-fastapi'
+)
+
+

Create a STAC landing page (GET /).

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Descendants

+
    +
  • stac_fastapi.types.core.BaseCoreClient
    • +
  • stac_fastapi.types.core.AsyncBaseCoreClient
    • +
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/errors/index.html b/api/stac_fastapi/types/errors/index.html new file mode 100644 index 000000000..2b564b548 --- /dev/null +++ b/api/stac_fastapi/types/errors/index.html @@ -0,0 +1,3008 @@ + + + + + + + + + + + + + + + + + + + + + + + + + errors - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.errors

+

stac_fastapi.types.errors module.

+

Classes

+

ConflictError

+
class ConflictError(
+    /,
+    *args,
+    **kwargs
+)
+
+

Database conflict.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.errors.StacApiError
    • +
  • builtins.Exception
    • +
  • builtins.BaseException
    • +
+

Class variables

+
args
+
+

Methods

+

add_note

+
def add_note(
+    ...
+)
+
+

Exception.add_note(note) --

+

add a note to the exception

+

with_traceback

+
def with_traceback(
+    ...
+)
+
+

Exception.with_traceback(tb) --

+

set self.traceback to tb and return self.

+

DatabaseError

+
class DatabaseError(
+    /,
+    *args,
+    **kwargs
+)
+
+

Generic database errors.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.errors.StacApiError
    • +
  • builtins.Exception
    • +
  • builtins.BaseException
    • +
+

Class variables

+
args
+
+

Methods

+

add_note

+
def add_note(
+    ...
+)
+
+

Exception.add_note(note) --

+

add a note to the exception

+

with_traceback

+
def with_traceback(
+    ...
+)
+
+

Exception.with_traceback(tb) --

+

set self.traceback to tb and return self.

+

ForeignKeyError

+
class ForeignKeyError(
+    /,
+    *args,
+    **kwargs
+)
+
+

Foreign key error (collection does not exist).

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.errors.StacApiError
    • +
  • builtins.Exception
    • +
  • builtins.BaseException
    • +
+

Class variables

+
args
+
+

Methods

+

add_note

+
def add_note(
+    ...
+)
+
+

Exception.add_note(note) --

+

add a note to the exception

+

with_traceback

+
def with_traceback(
+    ...
+)
+
+

Exception.with_traceback(tb) --

+

set self.traceback to tb and return self.

+

InvalidQueryParameter

+
class InvalidQueryParameter(
+    /,
+    *args,
+    **kwargs
+)
+
+

Error for unknown or invalid query parameters.

+

Used to capture errors that should respond according to +docs.opengeospatial.org/is/17-069r3/17-069r3.html#query_parameters

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.errors.StacApiError
    • +
  • builtins.Exception
    • +
  • builtins.BaseException
    • +
+

Class variables

+
args
+
+

Methods

+

add_note

+
def add_note(
+    ...
+)
+
+

Exception.add_note(note) --

+

add a note to the exception

+

with_traceback

+
def with_traceback(
+    ...
+)
+
+

Exception.with_traceback(tb) --

+

set self.traceback to tb and return self.

+

NotFoundError

+
class NotFoundError(
+    /,
+    *args,
+    **kwargs
+)
+
+

Resource not found.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.errors.StacApiError
    • +
  • builtins.Exception
    • +
  • builtins.BaseException
    • +
+

Class variables

+
args
+
+

Methods

+

add_note

+
def add_note(
+    ...
+)
+
+

Exception.add_note(note) --

+

add a note to the exception

+

with_traceback

+
def with_traceback(
+    ...
+)
+
+

Exception.with_traceback(tb) --

+

set self.traceback to tb and return self.

+

StacApiError

+
class StacApiError(
+    /,
+    *args,
+    **kwargs
+)
+
+

Generic API error.

+

Ancestors (in MRO)

+
    +
  • builtins.Exception
    • +
  • builtins.BaseException
    • +
+

Descendants

+
    +
  • stac_fastapi.types.errors.ConflictError
    • +
  • stac_fastapi.types.errors.NotFoundError
    • +
  • stac_fastapi.types.errors.ForeignKeyError
    • +
  • stac_fastapi.types.errors.DatabaseError
    • +
  • stac_fastapi.types.errors.InvalidQueryParameter
    • +
+

Class variables

+
args
+
+

Methods

+

add_note

+
def add_note(
+    ...
+)
+
+

Exception.add_note(note) --

+

add a note to the exception

+

with_traceback

+
def with_traceback(
+    ...
+)
+
+

Exception.with_traceback(tb) --

+

set self.traceback to tb and return self.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/extension/index.html b/api/stac_fastapi/types/extension/index.html new file mode 100644 index 000000000..02b528368 --- /dev/null +++ b/api/stac_fastapi/types/extension/index.html @@ -0,0 +1,2289 @@ + + + + + + + + + + + + + + + + + + + + + + + + + extension - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.extension

+

Base api extension.

+

Classes

+

ApiExtension

+
class ApiExtension(
+    conformance_classes: List[str] = NOTHING,
+    schema_href: Optional[str] = None
+)
+
+

Abstract base class for defining API extensions.

+

Ancestors (in MRO)

+
    +
  • abc.ABC
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.aggregation.aggregation.AggregationExtension
    • +
  • stac_fastapi.extensions.core.collection_search.collection_search.CollectionSearchExtension
    • +
  • stac_fastapi.extensions.core.fields.fields.FieldsExtension
    • +
  • stac_fastapi.extensions.core.filter.filter.FilterExtension
    • +
  • stac_fastapi.extensions.core.free_text.free_text.FreeTextExtension
    • +
  • stac_fastapi.extensions.core.free_text.free_text.FreeTextAdvancedExtension
    • +
  • stac_fastapi.extensions.core.pagination.offset_pagination.OffsetPaginationExtension
    • +
  • stac_fastapi.extensions.core.pagination.pagination.PaginationExtension
    • +
  • stac_fastapi.extensions.core.pagination.token_pagination.TokenPaginationExtension
    • +
  • stac_fastapi.extensions.core.query.query.QueryExtension
    • +
  • stac_fastapi.extensions.core.sort.sort.SortExtension
    • +
  • stac_fastapi.extensions.core.transaction.TransactionExtension
    • +
  • stac_fastapi.extensions.third_party.bulk_transactions.BulkTransactionExtension
    • +
+

Class variables

+
GET
+
+
POST
+
+

Methods

+

get_request_model

+
def get_request_model(
+    self,
+    verb: Optional[str] = 'GET'
+) -> Optional[pydantic.main.BaseModel]
+
+

Return the request model for the extension.method.

+

The model can differ based on HTTP verb

+

register

+
def register(
+    self,
+    app: fastapi.applications.FastAPI
+) -> None
+
+

Register the extension with a FastAPI application.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
appNonetarget FastAPI application.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNone
+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/index.html b/api/stac_fastapi/types/index.html new file mode 100644 index 000000000..2369affae --- /dev/null +++ b/api/stac_fastapi/types/index.html @@ -0,0 +1,2070 @@ + + + + + + + + + + + + + + + + + + + + + + + + + module - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/links/index.html b/api/stac_fastapi/types/links/index.html new file mode 100644 index 000000000..e8b1ae3fc --- /dev/null +++ b/api/stac_fastapi/types/links/index.html @@ -0,0 +1,2670 @@ + + + + + + + + + + + + + + + + + + + + + + + + + links - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.links

+

Link helpers.

+

Variables

+
INFERRED_LINK_RELS
+
+

Functions

+ +
def filter_links(
+    links: List[Dict]
+) -> List[Dict]
+
+

Remove inferred links.

+ +
def resolve_links(
+    links: list,
+    base_url: str
+) -> List[Dict]
+
+

Convert relative links to absolute links.

+

Classes

+ +
class BaseLinks(
+    collection_id: str,
+    base_url: str
+)
+
+

Create inferred links common to collections and items.

+

Descendants

+
    +
  • stac_fastapi.types.links.CollectionLinks
    • +
  • stac_fastapi.types.links.ItemLinks
    • +
+

Methods

+

root

+
def root(
+    self
+) -> Dict[str, Any]
+
+

Return the catalog root.

+ +
class CollectionLinks(
+    collection_id: str,
+    base_url: str
+)
+
+

Create inferred links specific to collections.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.links.BaseLinks
    • +
+

Methods

+ +
def create_links(
+    self
+) -> List[Dict[str, Any]]
+
+

Return all inferred links.

+

items

+
def items(
+    self
+) -> Dict[str, Any]
+
+

Create the items link.

+

parent

+
def parent(
+    self
+) -> Dict[str, Any]
+
+

Create the parent link.

+

root

+
def root(
+    self
+) -> Dict[str, Any]
+
+

Return the catalog root.

+

self

+
def self(
+    self
+) -> Dict[str, Any]
+
+

Create the self link.

+ +
class ItemLinks(
+    collection_id: str,
+    base_url: str,
+    item_id: str
+)
+
+

Create inferred links specific to items.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.links.BaseLinks
    • +
+

Methods

+

collection

+
def collection(
+    self
+) -> Dict[str, Any]
+
+

Create the collection link.

+ +
def create_links(
+    self
+) -> List[Dict[str, Any]]
+
+

Return all inferred links.

+

parent

+
def parent(
+    self
+) -> Dict[str, Any]
+
+

Create the parent link.

+

root

+
def root(
+    self
+) -> Dict[str, Any]
+
+

Return the catalog root.

+

self

+
def self(
+    self
+) -> Dict[str, Any]
+
+

Create the self link.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/requests/index.html b/api/stac_fastapi/types/requests/index.html new file mode 100644 index 000000000..ff3eccc7e --- /dev/null +++ b/api/stac_fastapi/types/requests/index.html @@ -0,0 +1,2093 @@ + + + + + + + + + + + + + + + + + + + + + + + + + requests - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.requests

+

Requests helpers.

+

Functions

+

get_base_url

+
def get_base_url(
+    request: starlette.requests.Request
+) -> str
+
+

Get base URL with respect of APIRouter prefix.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/rfc3339/index.html b/api/stac_fastapi/types/rfc3339/index.html new file mode 100644 index 000000000..0c970aac2 --- /dev/null +++ b/api/stac_fastapi/types/rfc3339/index.html @@ -0,0 +1,2390 @@ + + + + + + + + + + + + + + + + + + + + + + + + + rfc3339 - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.rfc3339

+

rfc3339.

+

Variables

+
DateTimeType
+
+
RFC33339_PATTERN
+
+

Functions

+

datetime_to_str

+
def datetime_to_str(
+    dt: datetime.datetime,
+    timespec: str = 'auto'
+) -> str
+
+

Converts a :class:datetime.datetime instance to an ISO8601 string in the

+

RFC 3339, section 5.6 +<https://datatracker.ietf.org/doc/html/rfc3339#section-5.6>__ format required by +the :stac-spec:STAC Spec <master/item-spec/common-metadata.md#date-and-time>.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
dtNoneThe datetime to convert.None
timespecNoneAn optional argument that specifies the number of additional
terms of the time to include. Valid options are 'auto', 'hours',
'minutes', 'seconds', 'milliseconds' and 'microseconds'. The default value
is 'auto'.		None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
strThe ISO8601 (RFC 3339) formatted string representing the datetime.
+

now_in_utc

+
def now_in_utc(
+
+) -> datetime.datetime
+
+

Return a datetime value of now with the UTC timezone applied.

+

now_to_rfc3339_str

+
def now_to_rfc3339_str(
+
+) -> str
+
+

Return an RFC 3339 string representing now.

+

parse_single_date

+
def parse_single_date(
+    date_str: str
+) -> datetime.datetime
+
+

Parse a single RFC3339 date string into a datetime object.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
date_strstrA string representing the date in RFC3339 format.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
datetimeA datetime object parsed from the date_str.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValueErrorIf the date_str is empty or contains the placeholder '..'.
+

rfc3339_str_to_datetime

+
def rfc3339_str_to_datetime(
+    s: str
+) -> datetime.datetime
+
+

Convert a string conforming to RFC 3339 to a :class:datetime.datetime.

+

Uses :meth:iso8601.parse_date under the hood.

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
sstrThe string to convert to :class:datetime.datetime.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
strThe datetime represented by the ISO8601 (RFC 3339) formatted string.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValueErrorIf the string is not a valid RFC 3339 string.
+

str_to_interval

+
def str_to_interval(
+    interval: Optional[str]
+) -> Union[datetime.datetime, Tuple[datetime.datetime, datetime.datetime], Tuple[datetime.datetime, NoneType], Tuple[NoneType, datetime.datetime], NoneType]
+
+

Extract a single datetime object or a tuple of datetime objects from an

+

interval string defined by the OGC API. The interval can either be a +single datetime or a range with start and end datetime.

+

Args: + interval (Optional[str]): The interval string to convert to datetime objects, + or None if no datetime is specified.

+

Returns: + Optional[DateTimeType]: A single datetime.datetime object, a tuple of + datetime.datetime objects, or None if input is None.

+

Raises: + HTTPException: If the string is not valid for various reasons such as being empty, + having more than one slash, or if date formats are invalid.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/search/index.html b/api/stac_fastapi/types/search/index.html new file mode 100644 index 000000000..1a5e235fb --- /dev/null +++ b/api/stac_fastapi/types/search/index.html @@ -0,0 +1,3986 @@ + + + + + + + + + + + + + + + + + + + + + + + + + search - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.search

+

stac_fastapi.types.search module.

+

Variables

+
Limit
+
+
NumType
+
+

Functions

+

crop

+
def crop(
+    v: typing.Annotated[int, Gt(gt=0)]
+) -> typing.Annotated[int, Gt(gt=0)]
+
+

Crop value to 10,000.

+

str2bbox

+
def str2bbox(
+    x: str
+) -> Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]], NoneType]
+
+

Convert string to BBox based on , delimiter.

+

str2list

+
def str2list(
+    x: str
+) -> Optional[List[str]]
+
+

Convert string to list base on , delimiter.

+

Classes

+

APIRequest

+
class APIRequest(
+
+)
+
+

Generic API Request base class.

+

Descendants

+
    +
  • stac_fastapi.types.search.BaseSearchGetRequest
    • +
  • stac_fastapi.api.models.CollectionUri
    • +
  • stac_fastapi.api.models.ItemUri
    • +
  • stac_fastapi.api.models.EmptyRequest
    • +
  • stac_fastapi.api.models.ItemCollectionUri
    • +
  • stac_fastapi.extensions.core.collection_search.request.BaseCollectionSearchGetRequest
    • +
  • stac_fastapi.extensions.core.fields.request.FieldsExtensionGetRequest
    • +
  • stac_fastapi.extensions.core.filter.request.FilterExtensionGetRequest
    • +
  • stac_fastapi.extensions.core.free_text.request.FreeTextExtensionGetRequest
    • +
  • stac_fastapi.extensions.core.free_text.request.FreeTextAdvancedExtensionGetRequest
    • +
  • stac_fastapi.extensions.core.pagination.request.GETTokenPagination
    • +
  • stac_fastapi.extensions.core.pagination.request.GETPagination
    • +
  • stac_fastapi.extensions.core.pagination.request.GETOffsetPagination
    • +
  • stac_fastapi.extensions.core.query.request.QueryExtensionGetRequest
    • +
  • stac_fastapi.extensions.core.sort.request.SortExtensionGetRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

BaseSearchGetRequest

+
class BaseSearchGetRequest(
+    collections: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    ids: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    bbox: Annotated[Optional[str], Query(PydanticUndefined)] = None,
+    intersects: 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 0x7f85cf1b1ee0>)]], Query(PydanticUndefined)] = 10
+)
+
+

Base arguments for GET Request.

+

Ancestors (in MRO)

+
    +
  • stac_fastapi.types.search.APIRequest
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.aggregation.request.AggregationExtensionGetRequest
    • +
+

Methods

+

kwargs

+
def kwargs(
+    self
+) -> Dict
+
+

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

+

endpoint.

+

BaseSearchPostRequest

+
class BaseSearchPostRequest(
+    /,
+    **data: 'Any'
+)
+
+

Base arguments for POST Request.

+

Ancestors (in MRO)

+
    +
  • stac_pydantic.api.search.Search
    • +
  • pydantic.main.BaseModel
    • +
+

Descendants

+
    +
  • stac_fastapi.extensions.core.aggregation.request.AggregationExtensionPostRequest
    • +
+

Class variables

+
model_computed_fields
+
+
model_config
+
+
model_fields
+
+

Static methods

+

construct

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

from_orm

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

model_construct

+
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:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
_fields_setNoneA 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
valuesNoneTrusted or pre-validated data dictionary.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA new instance of the Model class with validated data.
+

model_json_schema

+
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'
+) -> 'dict[str, Any]'
+
+

Generates a JSON schema for a model class.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
by_aliasNoneWhether to use attribute aliases or not.None
ref_templateNoneThe reference template.None
schema_generatorNoneTo override the logic used to generate the JSON schema, as a subclass of
GenerateJsonSchema with your desired modifications		None
modeNoneThe mode in which to generate the schema.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe JSON schema for the given model class.
+

model_parametrized_name

+
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:

+ + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
paramsNoneTuple 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:

+ + + + + + + + + + + + + +
TypeDescription
NoneString representing the new class where params are passed to cls as type variables.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
TypeErrorRaised when trying to generate concrete names for non-generic models.
+

model_rebuild

+
def model_rebuild(
+    *,
+    force: 'bool' = False,
+    raise_errors: 'bool' = True,
+    _parent_namespace_depth: 'int' = 2,
+    _types_namespace: 'dict[str, Any] | 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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
forceNoneWhether to force the rebuilding of the model schema, defaults to False.None
raise_errorsNoneWhether to raise errors, defaults to True.None
_parent_namespace_depthNoneThe depth level of the parent namespace, defaults to 2.None
_types_namespaceNoneThe types namespace, defaults to None.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneReturns 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

+
def model_validate(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    from_attributes: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Validate a pydantic model instance.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object to validate.None
strictNoneWhether to enforce types strictly.None
from_attributesNoneWhether to extract data from object attributes.None
contextNoneAdditional context to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated model instance.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf the object could not be validated.
+

model_validate_json

+
def model_validate_json(
+    json_data: 'str | bytes | bytearray',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/json/#json-parsing

+

Validate the given JSON data against the Pydantic model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
json_dataNoneThe JSON data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

Raises:

+ + + + + + + + + + + + + +
TypeDescription
ValidationErrorIf json_data is not a JSON string or the object could not be validated.
+

model_validate_strings

+
def model_validate_strings(
+    obj: 'Any',
+    *,
+    strict: 'bool | None' = None,
+    context: 'Any | None' = None
+) -> 'Self'
+
+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
objNoneThe object containing string data to validate.None
strictNoneWhether to enforce types strictly.None
contextNoneExtra variables to pass to the validator.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneThe validated Pydantic model.
+

parse_file

+
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

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

parse_raw

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

schema

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

schema_json

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

update_forward_refs

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

validate

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

validate_bbox

+
def validate_bbox(
+    v: Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]]
+) -> Union[Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int]], Tuple[Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int], Union[float, int]]]
+
+

validate_datetime

+
def validate_datetime(
+    value: str
+) -> str
+
+

validate_spatial

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

Instance variables

+
end_date
+
+
model_extra
+
+

Get extra fields set during validation.

+
model_fields_set
+
+

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

+
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.

+
start_date
+
+

Methods

+

copy

+
def copy(
+    self,
+    *,
+    include: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    exclude: 'AbstractSetIntStr | MappingIntStrAny | None' = None,
+    update: 'Dict[str, Any] | None' = None,
+    deep: 'bool' = False
+) -> 'Self'
+
+

Returns a copy of the model.

+
+

Deprecated

+

This method is now deprecated; use model_copy instead.

+
+

If you need include or exclude, use:

+
data = self.model_dump(include=include, exclude=exclude, round_trip=True)
+data = {**data, **(update or {})}
+copied = self.model_validate(data)
+
+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
includeNoneOptional set or mapping specifying which fields to include in the copied model.None
excludeNoneOptional set or mapping specifying which fields to exclude in the copied model.None
updateNoneOptional dictionary of field-value pairs to override field values in the copied model.None
deepNoneIf True, the values of fields that are Pydantic models will be deep-copied.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA copy of the model with included, excluded and updated fields as specified.
+

dict

+
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

+
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

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#model_copy

+

Returns a copy of the model.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
updateNoneValues to change/add in the new model. Note: the data is not validated
before creating the new model. You should trust this data.		None
deepNoneSet to True to make a deep copy of the model.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneNew model instance.
+

model_dump

+
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' = False,
+    exclude_unset: 'bool' = False,
+    exclude_defaults: 'bool' = False,
+    exclude_none: 'bool' = False,
+    round_trip: 'bool' = False,
+    warnings: "bool | Literal['none', 'warn', 'error']" = True,
+    serialize_as_any: 'bool' = False
+) -> 'dict[str, Any]'
+
+

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
modeNoneThe 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
includeNoneA set of fields to include in the output.None
excludeNoneA set of fields to exclude from the output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to use the field's alias in the dictionary key if defined.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA dictionary representation of the model.
+

model_dump_json

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

Usage docs: docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault
indentNoneIndentation to use in the JSON output. If None is passed, the output will be compact.None
includeNoneField(s) to include in the JSON output.None
excludeNoneField(s) to exclude from the JSON output.None
contextNoneAdditional context to pass to the serializer.None
by_aliasNoneWhether to serialize using field aliases.None
exclude_unsetNoneWhether to exclude fields that have not been explicitly set.None
exclude_defaultsNoneWhether to exclude fields that are set to their default value.None
exclude_noneNoneWhether to exclude fields that have a value of None.None
round_tripNoneIf True, dumped values should be valid as input for non-idempotent types such as Json[T].None
warningsNoneHow to handle serialization errors. False/"none" ignores them, True/"warn" logs errors,
"error" raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].		None
serialize_as_anyNoneWhether to serialize fields with duck-typing serialization behavior.None
+

Returns:

+ + + + + + + + + + + + + +
TypeDescription
NoneA JSON string representation of the model.
+

model_post_init

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

We need to both initialize private attributes and call the user-defined model_post_init

+

method.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/stac/index.html b/api/stac_fastapi/types/stac/index.html new file mode 100644 index 000000000..60baac4d6 --- /dev/null +++ b/api/stac_fastapi/types/stac/index.html @@ -0,0 +1,4611 @@ + + + + + + + + + + + + + + + + + + + + + + + + + stac - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.stac

+

STAC types.

+

Variables

+
NumType
+
+

Classes

+

Catalog

+
class Catalog(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Catalog.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

Collection

+
class Collection(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Collection.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

Collections

+
class Collections(
+    /,
+    *args,
+    **kwargs
+)
+
+

All collections endpoint.

+

github.com/radiantearth/stac-api-spec/tree/master/collections

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

Conformance

+
class Conformance(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Conformance Classes.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

Item

+
class Item(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Item.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

ItemCollection

+
class ItemCollection(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Item Collection.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+

LandingPage

+
class LandingPage(
+    /,
+    *args,
+    **kwargs
+)
+
+

STAC Landing Page.

+

Ancestors (in MRO)

+
    +
  • builtins.dict
    • +
+

Methods

+

clear

+
def clear(
+    ...
+)
+
+

D.clear() -> None. Remove all items from D.

+

copy

+
def copy(
+    ...
+)
+
+

D.copy() -> a shallow copy of D

+

fromkeys

+
def fromkeys(
+    iterable,
+    value=None,
+    /
+)
+
+

Create a new dictionary with keys from iterable and values set to value.

+

get

+
def get(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Return the value for key if key is in the dictionary, else default.

+

items

+
def items(
+    ...
+)
+
+

D.items() -> a set-like object providing a view on D's items

+

keys

+
def keys(
+    ...
+)
+
+

D.keys() -> a set-like object providing a view on D's keys

+

pop

+
def pop(
+    ...
+)
+
+

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

+

If the key is not found, return the default if given; otherwise, +raise a KeyError.

+

popitem

+
def popitem(
+    self,
+    /
+)
+
+

Remove and return a (key, value) pair as a 2-tuple.

+

Pairs are returned in LIFO (last-in, first-out) order. +Raises KeyError if the dict is empty.

+

setdefault

+
def setdefault(
+    self,
+    key,
+    default=None,
+    /
+)
+
+

Insert key with a value of default if key is not in the dictionary.

+

Return the value for key if key is in the dictionary, else default.

+

update

+
def update(
+    ...
+)
+
+

D.update([E, ]**F) -> None. Update D from dict/iterable E and F.

+

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] +If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v +In either case, this is followed by: for k in F: D[k] = F[k]

+

values

+
def values(
+    ...
+)
+
+

D.values() -> an object providing a view on D's values

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/api/stac_fastapi/types/version/index.html b/api/stac_fastapi/types/version/index.html new file mode 100644 index 000000000..1718dd39e --- /dev/null +++ b/api/stac_fastapi/types/version/index.html @@ -0,0 +1,2000 @@ + + + + + + + + + + + + + + + + + + + + + + + + + version - stac-fastapi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Module stac_fastapi.types.version

+

Library version.

+ + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 000000000..1cf13b9f9 Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.525ec568.min.js b/assets/javascripts/bundle.525ec568.min.js new file mode 100644 index 000000000..4b08eae40 --- /dev/null +++ b/assets/javascripts/bundle.525ec568.min.js @@ -0,0 +1,16 @@ +"use strict";(()=>{var Wi=Object.create;var gr=Object.defineProperty;var Di=Object.getOwnPropertyDescriptor;var Vi=Object.getOwnPropertyNames,Vt=Object.getOwnPropertySymbols,Ni=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,ao=Object.prototype.propertyIsEnumerable;var io=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,$=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&io(e,r,t[r]);if(Vt)for(var r of Vt(t))ao.call(t,r)&&io(e,r,t[r]);return e};var so=(e,t)=>{var r={};for(var o in e)yr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Vt)for(var o of Vt(e))t.indexOf(o)<0&&ao.call(e,o)&&(r[o]=e[o]);return r};var xr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var zi=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Vi(t))!yr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=Di(t,n))||o.enumerable});return e};var Mt=(e,t,r)=>(r=e!=null?Wi(Ni(e)):{},zi(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var co=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var lo=xr((Er,po)=>{(function(e,t){typeof Er=="object"&&typeof po!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function p(k){var ft=k.type,qe=k.tagName;return!!(qe==="INPUT"&&a[ft]&&!k.readOnly||qe==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function c(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(k){o=!1}function d(k){s(k.target)&&(o||p(k.target))&&c(k.target)}function y(k){s(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function L(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function te(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,te())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",L,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",y,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var qr=xr((hy,On)=>{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var $a=/["'&<>]/;On.exports=Pa;function Pa(e){var t=""+e,r=$a.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof It=="object"&&typeof Yr=="object"?Yr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof It=="object"?It.ClipboardJS=r():t.ClipboardJS=r()})(It,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ui}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(A){return!1}}var d=function(A){var M=f()(A);return u("cut"),M},y=d;function L(V){var A=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[A?"right":"left"]="-9999px";var F=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(F,"px"),M.setAttribute("readonly",""),M.value=V,M}var X=function(A,M){var F=L(A);M.container.appendChild(F);var D=f()(F);return u("copy"),F.remove(),D},te=function(A){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},F="";return typeof A=="string"?F=X(A,M):A instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(A==null?void 0:A.type)?F=X(A.value,M):(F=f()(A),u("copy")),F},J=te;function k(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(M){return typeof M}:k=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},k(V)}var ft=function(){var A=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=A.action,F=M===void 0?"copy":M,D=A.container,Y=A.target,$e=A.text;if(F!=="copy"&&F!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&k(Y)==="object"&&Y.nodeType===1){if(F==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(F==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if($e)return J($e,{container:D});if(Y)return F==="cut"?y(Y):J(Y,{container:D})},qe=ft;function Fe(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Fe=function(M){return typeof M}:Fe=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Fe(V)}function ki(V,A){if(!(V instanceof A))throw new TypeError("Cannot call a class as a function")}function no(V,A){for(var M=0;M0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Fe(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function($e){return Y.onClick($e)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,$e=this.action(Y)||"copy",Dt=qe({action:$e,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Dt?"success":"error",{action:$e,text:Dt,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return y(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,$e=!!document.queryCommandSupported;return Y.forEach(function(Dt){$e=$e&&!!document.queryCommandSupported(Dt)}),$e}}]),M}(s()),Ui=Fi},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,d,y){var L=c.apply(this,arguments);return l.addEventListener(u,L,y),{destroy:function(){l.removeEventListener(u,L,y)}}}function p(l,f,u,d,y){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(L){return s(L,f,u,d,y)}))}function c(l,f,u,d){return function(y){y.delegateTarget=a(y.target,f),y.delegateTarget&&d.call(l,y)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,d,y){if(!u&&!d&&!y)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(y))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,d,y);if(a.nodeList(u))return l(u,d,y);if(a.string(u))return f(u,d,y);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,d,y){return u.addEventListener(d,y),{destroy:function(){u.removeEventListener(d,y)}}}function l(u,d,y){return Array.prototype.forEach.call(u,function(L){L.addEventListener(d,y)}),{destroy:function(){Array.prototype.forEach.call(u,function(L){L.removeEventListener(d,y)})}}}function f(u,d,y){return s(document.body,u,d,y)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||p(d,L)})},y&&(n[d]=y(n[d])))}function p(d,y){try{c(o[d](y))}catch(L){u(i[0][3],L)}}function c(d){d.value instanceof nt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){p("next",d)}function f(d){p("throw",d)}function u(d,y){d(y),i.shift(),i.length&&p(i[0][0],i[0][1])}}function uo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof he=="function"?he(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function H(e){return typeof e=="function"}function ut(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ut(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function Qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ue=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=he(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(L){t={error:L}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(H(l))try{l()}catch(L){i=L instanceof zt?L.errors:[L]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=he(f),d=u.next();!d.done;d=u.next()){var y=d.value;try{ho(y)}catch(L){i=i!=null?i:[],L instanceof zt?i=q(q([],N(i)),N(L.errors)):i.push(L)}}}catch(L){o={error:L}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ho(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Ue.EMPTY;function qt(e){return e instanceof Ue||e&&"closed"in e&&H(e.remove)&&H(e.add)&&H(e.unsubscribe)}function ho(e){H(e)?e():e.unsubscribe()}var Pe={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var dt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Ue(function(){o.currentObservers=null,Qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new To(r,o)},t}(j);var To=function(e){oe(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){oe(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var At={now:function(){return(At.delegate||Date).now()},delegate:void 0};var Ct=function(e){oe(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=At);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(gt);var Lo=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(yt);var kr=new Lo(Oo);var Mo=function(e){oe(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=vt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(vt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(gt);var _o=function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(yt);var me=new _o(Mo);var S=new j(function(e){return e.complete()});function Yt(e){return e&&H(e.schedule)}function Hr(e){return e[e.length-1]}function Xe(e){return H(Hr(e))?e.pop():void 0}function ke(e){return Yt(Hr(e))?e.pop():void 0}function Bt(e,t){return typeof Hr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return H(e==null?void 0:e.then)}function Jt(e){return H(e[bt])}function Xt(e){return Symbol.asyncIterator&&H(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Zi();function tr(e){return H(e==null?void 0:e[er])}function rr(e){return fo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return H(e==null?void 0:e.getReader)}function U(e){if(e instanceof j)return e;if(e!=null){if(Jt(e))return ea(e);if(xt(e))return ta(e);if(Gt(e))return ra(e);if(Xt(e))return Ao(e);if(tr(e))return oa(e);if(or(e))return na(e)}throw Zt(e)}function ea(e){return new j(function(t){var r=e[bt]();if(H(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function ta(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?De(t):Qo(function(){return new ir}))}}function jr(e){return e<=0?function(){return S}:E(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,d=0,y=!1,L=!1,X=function(){f==null||f.unsubscribe(),f=void 0},te=function(){X(),l=u=void 0,y=L=!1},J=function(){var k=l;te(),k==null||k.unsubscribe()};return E(function(k,ft){d++,!L&&!y&&X();var qe=u=u!=null?u:r();ft.add(function(){d--,d===0&&!L&&!y&&(f=Ur(J,p))}),qe.subscribe(ft),!l&&d>0&&(l=new at({next:function(Fe){return qe.next(Fe)},error:function(Fe){L=!0,X(),f=Ur(te,n,Fe),qe.error(Fe)},complete:function(){y=!0,X(),f=Ur(te,a),qe.complete()}}),U(k).subscribe(l))})(c)}}function Ur(e,t){for(var r=[],o=2;oe.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function R(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Ie(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var wa=O(h(document.body,"focusin"),h(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Ie()||document.body),G(1));function et(e){return wa.pipe(m(t=>e.contains(t)),K())}function $t(e,t){return C(()=>O(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Le(+!r*t)):le,Q(e.matches(":hover"))))}function Jo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Jo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Jo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function Tt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),O(h(t,"load"),h(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),Te(1))))}var Xo=new g,Ta=C(()=>typeof ResizeObserver=="undefined"?Tt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Xo.next(t)))),v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ta.pipe(w(r=>r.observe(t)),v(r=>Xo.pipe(b(o=>o.target===t),_(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function St(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Zo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ve(e){return{x:e.offsetLeft,y:e.offsetTop}}function en(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function tn(e){return O(h(window,"load"),h(window,"resize")).pipe(Me(0,me),m(()=>Ve(e)),Q(Ve(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ne(e){return O(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe(Me(0,me),m(()=>pr(e)),Q(pr(e)))}var rn=new g,Sa=C(()=>I(new IntersectionObserver(e=>{for(let t of e)rn.next(t)},{threshold:0}))).pipe(v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function tt(e){return Sa.pipe(w(t=>t.observe(e)),v(t=>rn.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function on(e,t=16){return Ne(e).pipe(m(({y:r})=>{let o=ce(e),n=St(e);return r>=n.height-o.height-t}),K())}var lr={drawer:R("[data-md-toggle=drawer]"),search:R("[data-md-toggle=search]")};function nn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function ze(e){let t=lr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function Oa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function La(){return O(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function an(){let e=h(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:nn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Ie();if(typeof o!="undefined")return!Oa(o,r)}return!0}),pe());return La().pipe(v(t=>t?S:e))}function ye(){return new URL(location.href)}function lt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function sn(){return new g}function cn(){return location.hash.slice(1)}function pn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Ma(e){return O(h(window,"hashchange"),e).pipe(m(cn),Q(cn()),b(t=>t.length>0),G(1))}function ln(e){return Ma(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function Pt(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function mn(){let e=matchMedia("print");return O(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():S))}function zr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function je(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function fn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function un(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function dn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function hn(){return O(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(dn),Q(dn()))}function bn(){return{width:innerWidth,height:innerHeight}}function vn(){return h(window,"resize",{passive:!0}).pipe(m(bn),Q(bn()))}function gn(){return z([hn(),vn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(ee("size")),n=z([o,r]).pipe(m(()=>Ve(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function _a(e){return h(e,"message",t=>t.data)}function Aa(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function yn(e,t=new Worker(e)){let r=_a(t),o=Aa(t),n=new g;n.subscribe(o);let i=o.pipe(Z(),ie(!0));return n.pipe(Z(),Re(r.pipe(W(i))),pe())}var Ca=R("#__config"),Ot=JSON.parse(Ca.textContent);Ot.base=`${new URL(Ot.base,ye())}`;function xe(){return Ot}function B(e){return Ot.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?Ot.translations[e].replace("#",t.toString()):Ot.translations[e]}function Se(e,t=document){return R(`[data-md-component=${e}]`,t)}function ae(e,t=document){return P(`[data-md-component=${e}]`,t)}function ka(e){let t=R(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>R(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function xn(e){if(!B("announce.dismiss")||!e.childElementCount)return S;if(!e.hidden){let t=R(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),ka(e).pipe(w(r=>t.next(r)),_(()=>t.complete()),m(r=>$({ref:e},r)))})}function Ha(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function En(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Ha(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))}function Rt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Tn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Rt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Rt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Sn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}var Ln=Mt(qr());function Qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,(0,Ln.default)(c))," "],[]).slice(0,-1),i=xe(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=xe();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Mn(e){let t=e[0].score,r=[...e],o=xe(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreQr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>Qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function _n(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Kr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function An(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ra(e){var o;let t=xe(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Cn(e,t){var o;let r=xe();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ra)))}var Ia=0;function ja(e){let t=z([et(e),$t(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Zo(e)).pipe(ne(Ne),pt(1),He(t),m(()=>en(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function Fa(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ia++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(Z(),ie(!1)).subscribe(a);let s=a.pipe(Ht(c=>Le(+!c*250,kr)),K(),v(c=>c?r:S),w(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>$t(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),re(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),d=u.width/2;if(l.role==="tooltip")return{x:d,y:8+u.height};if(u.y>=f.height/2){let{height:y}=ce(l);return{x:d,y:-16-y}}else return{x:d,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),re(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(R(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),ve(me),re(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ja(e).pipe(w(c=>i.next(c)),_(()=>i.complete()),m(c=>$({ref:e},c)))})}function mt(e,{viewport$:t},r=document.body){return Fa(e,{content$:new j(o=>{let n=e.title,i=wn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Ua(e,t){let r=C(()=>z([tn(e),Ne(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function kn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(W(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),O(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),h(n,"mousedown").pipe(W(a),re(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Ie())==null||c.blur()}}),r.pipe(W(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Ua(e,t).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function Wa(e){return e.tagName==="CODE"?P(".c, .c1, .cm",e):[e]}function Da(e){let t=[];for(let r of Wa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function Hn(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Da(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,Tn(p,i)),s.replaceWith(a.get(p)))}return a.size===0?S:C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=[];for(let[l,f]of a)c.push([R(".md-typeset",f),R(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?Hn(f,u):Hn(u,f)}),O(...[...a].map(([,l])=>kn(l,t,{target$:r}))).pipe(_(()=>s.complete()),pe())})}function $n(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return $n(t)}}function Pn(e,t){return C(()=>{let r=$n(e);return typeof r!="undefined"?fr(r,e,t):S})}var Rn=Mt(Br());var Va=0;function In(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return In(t)}}function Na(e){return ge(e).pipe(m(({width:t})=>({scrollable:St(e).width>t})),ee("scrollable"))}function jn(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(jr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Rn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Va++}`;let l=Sn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(mt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=In(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(W(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:S)))}}return P(":scope > span[id]",e).length&&e.classList.add("md-code__content"),Na(e).pipe(w(c=>n.next(c)),_(()=>n.complete()),m(c=>$({ref:e},c)),Re(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function za(e,{target$:t,print$:r}){let o=!0;return O(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),w(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Fn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),za(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}var Un=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Gr,Qa=0;function Ka(){return typeof mermaid=="undefined"||mermaid instanceof Element?Tt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):I(void 0)}function Wn(e){return e.classList.remove("mermaid"),Gr||(Gr=Ka().pipe(w(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Un,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Gr.subscribe(()=>co(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Qa++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Gr.pipe(m(()=>({ref:e})))}var Dn=x("table");function Vn(e){return e.replaceWith(Dn),Dn.replaceWith(An(e)),I({ref:e})}function Ya(e){let t=e.find(r=>r.checked)||e[0];return O(...e.map(r=>h(r,"change").pipe(m(()=>R(`label[for="${r.id}"]`))))).pipe(Q(R(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Nn(e,{viewport$:t,target$:r}){let o=R(".tabbed-labels",e),n=P(":scope > input",e),i=Kr("prev");e.append(i);let a=Kr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(Z(),ie(!0));z([s,ge(e),tt(e)]).pipe(W(p),Me(1,me)).subscribe({next([{active:c},l]){let f=Ve(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=pr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([Ne(o),ge(o)]).pipe(W(p)).subscribe(([c,l])=>{let f=St(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),O(h(i,"click").pipe(m(()=>-1)),h(a,"click").pipe(m(()=>1))).pipe(W(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(W(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=R(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(p),b(f=>!(f.metaKey||f.ctrlKey)),w(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),re(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let y of P("[data-tabs]"))for(let L of P(":scope > input",y)){let X=R(`label[for="${L.id}"]`);if(X!==c&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),L.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),s.pipe(W(p)).subscribe(()=>{for(let c of P("audio, video",e))c.pause()}),Ya(n).pipe(w(c=>s.next(c)),_(()=>s.complete()),m(c=>$({ref:e},c)))}).pipe(Ke(se))}function zn(e,{viewport$:t,target$:r,print$:o}){return O(...P(".annotate:not(.highlight)",e).map(n=>Pn(n,{target$:r,print$:o})),...P("pre:not(.mermaid) > code",e).map(n=>jn(n,{target$:r,print$:o})),...P("pre.mermaid",e).map(n=>Wn(n)),...P("table:not([class])",e).map(n=>Vn(n)),...P("details",e).map(n=>Fn(n,{target$:r,print$:o})),...P("[data-tabs]",e).map(n=>Nn(n,{viewport$:t,target$:r})),...P("[title]",e).filter(()=>B("content.tooltips")).map(n=>mt(n,{viewport$:t})))}function Ba(e,{alert$:t}){return t.pipe(v(r=>O(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function qn(e,t){let r=R(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ba(e,t).pipe(w(n=>o.next(n)),_(()=>o.complete()),m(n=>$({ref:e},n)))})}var Ga=0;function Ja(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?Ne(o):I({x:0,y:0}),i=O(et(t),$t(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ve(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Qn(e){let t=e.title;if(!t.length)return S;let r=`__tooltip_${Ga++}`,o=Rt(r,"inline"),n=R(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),O(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ja(o,e).pipe(w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))}).pipe(Ke(se))}function Xa({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Be(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=ze("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Kn(e,t){return C(()=>z([ge(e),Xa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function Yn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(Z(),ie(!0));o.pipe(ee("active"),He(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue(P("[title]",e)).pipe(b(()=>B("content.tooltips")),ne(a=>Qn(a)));return r.subscribe(o),t.pipe(W(n),m(a=>$({ref:e},a)),Re(i.pipe(W(n))))})}function Za(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),ee("active"))}function Bn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?S:Za(o,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))})}function Gn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),ee("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function es(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(ne(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Jn(e){let t=P("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=Pt("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),re(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(ve(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),es(t).pipe(W(n.pipe(Ce(1))),ct(),w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))})}function Xn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(w(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Jr=Mt(Br());function ts(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Zn({alert$:e}){Jr.default.isSupported()&&new j(t=>{new Jr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ts(R(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(w(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function ei(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function rs(e,t){let r=new Map;for(let o of P("url",e)){let n=R("loc",o),i=[ei(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(ei(new URL(s),t))}}return r}function ur(e){return un(new URL("sitemap.xml",e)).pipe(m(t=>rs(t,new URL(e))),de(()=>I(new Map)))}function os(e,t){if(!(e.target instanceof Element))return S;let r=e.target.closest("a");if(r===null)return S;if(r.target||e.metaKey||e.ctrlKey)return S;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):S}function ti(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function ri(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function ns(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=ti(document);for(let[o,n]of ti(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return We(P("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),S}),Z(),ie(document))}function oi({location$:e,viewport$:t,progress$:r}){let o=xe();if(location.protocol==="file:")return S;let n=ur(o.base);I(document).subscribe(ri);let i=h(document.body,"click").pipe(He(n),v(([p,c])=>os(p,c)),pe()),a=h(window,"popstate").pipe(m(ye),pe());i.pipe(re(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),O(i,a).subscribe(e);let s=e.pipe(ee("pathname"),v(p=>fn(p,{progress$:r}).pipe(de(()=>(lt(p,!0),S)))),v(ri),v(ns),pe());return O(s.pipe(re(e,(p,c)=>c)),s.pipe(v(()=>e),ee("pathname"),v(()=>e),ee("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),w(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",pn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(ee("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ni=Mt(qr());function ii(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ni.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function jt(e){return e.type===1}function dr(e){return e.type===3}function ai(e,t){let r=yn(e);return O(I(location.protocol!=="file:"),ze("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function si(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=Xr(n))==null?void 0:l.pathname;if(i===void 0)return;let a=ss(o.pathname,i);if(a===void 0)return;let s=ps(t.keys());if(!t.has(s))return;let p=Xr(a,s);if(!p||!t.has(p.href))return;let c=Xr(a,r);if(c)return c.hash=o.hash,c.search=o.search,c}function Xr(e,t){try{return new URL(e,t)}catch(r){return}}function ss(e,t){if(e.startsWith(t))return e.slice(t.length)}function cs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oS)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>h(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),re(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?S:(i.preventDefault(),I(new URL(p)))}}return S}),v(i=>ur(i).pipe(m(a=>{var s;return(s=si({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:ye(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(n=>lt(n,!0)),z([r,o]).subscribe(([n,i])=>{R(".md-header__topic").appendChild(Cn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ls(e,{worker$:t}){let{searchParams:r}=ye();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),ze("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=ye();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=O(t.pipe(Ae(jt)),h(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function pi(e,{worker$:t}){let r=new g,o=r.pipe(Z(),ie(!0));z([t.pipe(Ae(jt)),r],(i,a)=>a).pipe(ee("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(ee("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=R("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ls(e,{worker$:t}).pipe(w(i=>r.next(i)),_(()=>r.complete()),m(i=>$({ref:e},i)),G(1))}function li(e,{worker$:t,query$:r}){let o=new g,n=on(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=R(":scope > :first-child",e),s=R(":scope > :last-child",e);ze("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(re(r),Wr(t.pipe(Ae(jt)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(w(()=>s.innerHTML=""),v(({items:l})=>O(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Be(4),Vr(n),v(([f])=>f)))),m(Mn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(ne(l=>{let f=fe("details",l);return typeof f=="undefined"?S:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(w(l=>o.next(l)),_(()=>o.complete()),m(l=>$({ref:e},l)))}function ms(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ye();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function mi(e,t){let r=new g,o=r.pipe(Z(),ie(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),ms(e,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))}function fi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=O(h(n,"keydown"),h(n,"focus")).pipe(ve(se),m(()=>n.value),K());return o.pipe(He(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(w(s=>o.next(s)),_(()=>o.complete()),m(()=>({ref:e})))}function ui(e,{index$:t,keyboard$:r}){let o=xe();try{let n=ai(o.search,t),i=Se("search-query",e),a=Se("search-result",e);h(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Ie();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of P(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...P(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Ie()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=pi(i,{worker$:n});return O(s,li(a,{worker$:n,query$:s})).pipe(Re(...ae("search-share",e).map(p=>mi(p,{query$:s})),...ae("search-suggest",e).map(p=>fi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ye}}function di(e,{index$:t,location$:r}){return z([t,r.pipe(Q(ye()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>ii(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function fs(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Zr(e,o){var n=o,{header$:t}=n,r=so(n,["header$"]);let i=R(".md-sidebar__scrollwrap",e),{y:a}=Ve(i);return C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=s.pipe(Me(0,me));return c.pipe(re(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of P(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2})}}}),ue(P("label[tabindex]",e)).pipe(ne(l=>h(l,"click").pipe(ve(se),m(()=>l),W(p)))).subscribe(l=>{let f=R(`[id="${l.htmlFor}"]`);R(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),fs(e,r).pipe(w(l=>s.next(l)),_(()=>s.complete()),m(l=>$({ref:e},l)))})}function hi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return st(je(`${r}/releases/latest`).pipe(de(()=>S),m(o=>({version:o.tag_name})),De({})),je(r).pipe(de(()=>S),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),De({}))).pipe(m(([o,n])=>$($({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return je(r).pipe(m(o=>({repositories:o.public_repos})),De({}))}}function bi(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return st(je(`${r}/releases/permalink/latest`).pipe(de(()=>S),m(({tag_name:o})=>({version:o})),De({})),je(r).pipe(de(()=>S),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),De({}))).pipe(m(([o,n])=>$($({},o),n)))}function vi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return hi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return bi(r,o)}return S}var us;function ds(e){return us||(us=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return S}return vi(e.href).pipe(w(o=>__md_set("__source",o,sessionStorage)))}).pipe(de(()=>S),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function gi(e){let t=R(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(_n(o)),t.classList.add("md-source__repository--active")}),ds(e).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function hs(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),ee("hidden"))}function yi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):hs(e,t)).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function bs(e,{viewport$:t,header$:r}){let o=new Map,n=P(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(ee("height"),m(({height:s})=>{let p=Se("main"),c=R(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(ee("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),He(i),v(([p,c])=>t.pipe(Fr(([l,f],{offset:{y:u},size:d})=>{let y=u+d.height>=Math.floor(s.height);for(;f.length;){let[,L]=f[0];if(L-c=u&&!y)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Be(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(Z(),ie(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=O(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),He(o.pipe(ve(se))),re(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(W(a),ee("offset"),_e(250),Ce(1),W(n.pipe(Ce(1))),ct({delay:250}),re(i)).subscribe(([,{prev:s}])=>{let p=ye(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),bs(e,{viewport$:t,header$:r}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function vs(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Be(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),W(o.pipe(Ce(1))),ie(!0),ct({delay:250}),m(a=>({hidden:a})))}function Ei(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(a),ee("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),h(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),vs(e,{viewport$:t,main$:o,target$:n}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))}function wi({document$:e,viewport$:t}){e.pipe(v(()=>P(".md-ellipsis")),ne(r=>tt(r).pipe(W(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?mt(n,{viewport$:t}).pipe(W(e.pipe(Ce(1))),_(()=>n.removeAttribute("title"))):S})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>P(".md-status")),ne(r=>mt(r,{viewport$:t}))).subscribe()}function Ti({document$:e,tablet$:t}){e.pipe(v(()=>P(".md-toggle--indeterminate")),w(r=>{r.indeterminate=!0,r.checked=!1}),ne(r=>h(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),re(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function gs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Si({document$:e}){e.pipe(v(()=>P("[data-md-scrollfix]")),w(t=>t.removeAttribute("data-md-scrollfix")),b(gs),ne(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Oi({viewport$:e,tablet$:t}){z([ze("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),re(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ys(){return location.protocol==="file:"?Tt(`${new URL("search/search_index.js",eo.base)}`).pipe(m(()=>__index),G(1)):je(new URL("search/search_index.json",eo.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Go(),Ut=sn(),Lt=ln(Ut),to=an(),Oe=gn(),hr=Pt("(min-width: 960px)"),Mi=Pt("(min-width: 1220px)"),_i=mn(),eo=xe(),Ai=document.forms.namedItem("search")?ys():Ye,ro=new g;Zn({alert$:ro});var oo=new g;B("navigation.instant")&&oi({location$:Ut,viewport$:Oe,progress$:oo}).subscribe(ot);var Li;((Li=eo.version)==null?void 0:Li.provider)==="mike"&&ci({document$:ot});O(Ut,Lt).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});to.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&<(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&<(r);break;case"Enter":let o=Ie();o instanceof HTMLLabelElement&&o.click()}});wi({viewport$:Oe,document$:ot});Ti({document$:ot,tablet$:hr});Si({document$:ot});Oi({viewport$:Oe,tablet$:hr});var rt=Kn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Gn(e,{viewport$:Oe,header$:rt})),G(1)),xs=O(...ae("consent").map(e=>En(e,{target$:Lt})),...ae("dialog").map(e=>qn(e,{alert$:ro})),...ae("header").map(e=>Yn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("palette").map(e=>Jn(e)),...ae("progress").map(e=>Xn(e,{progress$:oo})),...ae("search").map(e=>ui(e,{index$:Ai,keyboard$:to})),...ae("source").map(e=>gi(e))),Es=C(()=>O(...ae("announce").map(e=>xn(e)),...ae("content").map(e=>zn(e,{viewport$:Oe,target$:Lt,print$:_i})),...ae("content").map(e=>B("search.highlight")?di(e,{index$:Ai,location$:Ut}):S),...ae("header-title").map(e=>Bn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Mi,()=>Zr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Zr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>yi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>xi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Lt})),...ae("top").map(e=>Ei(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Lt})))),Ci=ot.pipe(v(()=>Es),Re(xs),G(1));Ci.subscribe();window.document$=ot;window.location$=Ut;window.target$=Lt;window.keyboard$=to;window.viewport$=Oe;window.tablet$=hr;window.screen$=Mi;window.print$=_i;window.alert$=ro;window.progress$=oo;window.component$=Ci;})(); +//# sourceMappingURL=bundle.525ec568.min.js.map + diff --git a/assets/javascripts/bundle.525ec568.min.js.map b/assets/javascripts/bundle.525ec568.min.js.map new file mode 100644 index 000000000..ef5d8d34a --- /dev/null +++ b/assets/javascripts/bundle.525ec568.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an