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¶

Name	Type	Description	Default
conformance_classes	list	Defines 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:

Name	Type	Description	Default
app	fastapi.FastAPI	target FastAPI application.	None

Returns:

Type	Description
None	None

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¶

Name	Type	Description	Default
conformance_classes	list	Defines 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:

Name	Type	Description	Default
app	None	target FastAPI application.	None

Returns:

Type	Description
None	None

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.