Module stac_fastapi.types.config¶

stac_fastapi.types.config module.

Classes¶

ApiSettings¶

class ApiSettings(
    __pydantic_self__,
    _env_file: Union[str, os.PathLike, List[Union[str, os.PathLike]], Tuple[Union[str, os.PathLike], ...], NoneType] = '<object object at 0x7f93f9c24c80>',
    _env_file_encoding: Union[str, NoneType] = None,
    _env_nested_delimiter: Union[str, NoneType] = None,
    _secrets_dir: Union[str, os.PathLike, NoneType] = None,
    **values: Any
)

ApiSettings.

Defines api configuration, potentially through environment variables. See pydantic-docs.helpmanual.io/usage/settings/.

Attributes¶

Name	Type	Description	Default
environment	None	name of the environment (ex. dev/prod).	None
debug	None	toggles debug mode.	None
forbidden_fields	None	set of fields defined by STAC but not included in the database.	None
indexed_fields	None	set of fields which are usually in `item.properties` but are indexed as distinct columns in the database.	None

Ancestors (in MRO)¶

pydantic.env_settings.BaseSettings
pydantic.main.BaseModel
pydantic.utils.Representation

Class variables¶

Config

Static methods¶

construct¶

def construct(
    _fields_set: Union[ForwardRef('SetStr'), NoneType] = None,
    **values: Any
) -> 'Model'

Creates a new model setting dict and fields_set from trusted or pre-validated data.

Default values are respected, but no other validation is performed. Behaves as if Config.extra = 'allow' was set since it adds all passed values

from_orm¶

def from_orm(
    obj: Any
) -> 'Model'

parse_file¶

def parse_file(
    path: Union[str, pathlib.Path],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

parse_obj¶

def parse_obj(
    obj: Any
) -> 'Model'

parse_raw¶

def parse_raw(
    b: Union[str, bytes],
    *,
    content_type: 'unicode' = None,
    encoding: 'unicode' = 'utf8',
    proto: pydantic.parse.Protocol = None,
    allow_pickle: bool = False
) -> 'Model'

schema¶

def schema(
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}'
) -> 'DictStrAny'

schema_json¶

def schema_json(
    *,
    by_alias: bool = True,
    ref_template: 'unicode' = '#/definitions/{model}',
    **dumps_kwargs: Any
) -> 'unicode'

update_forward_refs¶

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

Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate¶

def validate(
    value: Any
) -> 'Model'

Methods¶

copy¶

def copy(
    self: 'Model',
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    update: Union[ForwardRef('DictStrAny'), NoneType] = None,
    deep: bool = False
) -> 'Model'

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters:

Name	Type	Description	Default
include	None	fields to include in new model	None
exclude	None	fields to exclude from new model, as with values this takes precedence over include	None
update	None	values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data	None
deep	None	set to `True` to make a deep copy of the model	None

Returns:

Type	Description
None	new model instance

dict¶

def dict(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False
) -> 'DictStrAny'

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

json¶

def json(
    self,
    *,
    include: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    exclude: Union[ForwardRef('AbstractSetIntStr'), ForwardRef('MappingIntStrAny'), NoneType] = None,
    by_alias: bool = False,
    skip_defaults: Union[bool, NoneType] = None,
    exclude_unset: bool = False,
    exclude_defaults: bool = False,
    exclude_none: bool = False,
    encoder: Union[Callable[[Any], Any], NoneType] = None,
    models_as_dict: bool = True,
    **dumps_kwargs: Any
) -> 'unicode'

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

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.