tilearray.ServiceConfig#

class tilearray.ServiceConfig(*, base_url, service_type, crs=None, output_format=None, headers=<factory>, params=<factory>, chunk_size=None, grid_shape=None, cache_dir=None, resolution=None, max_concurrent_requests=3, initial_concurrent_requests=2, min_concurrent_requests=1, multiplicative_decrease=0.5, adaptive_concurrency=False, max_connections=None, fetch_retries=3, fetch_timeout=30.0, rate_limit_per_second=2.0, rate_limiter=None, forbidden_circuit_breaker=False, forbidden_window_seconds=5.0, forbidden_threshold=6, forbidden_cooldown_seconds=15.0)[source]#

Serializable configuration describing how to build a service instance.

Parameters:

  • base_url (str)

  • service_type (ServiceTypeEnum)

  • crs (CRS | None)

  • output_format (Format | None)

  • headers (dict[str, str])

  • params (dict[str, Any])

  • chunk_size (tuple[int, int] | None)

  • grid_shape (tuple[int, int] | None)

  • cache_dir (str | Path | None)

  • resolution (tuple[float, float] | None)

  • max_concurrent_requests (int)

  • initial_concurrent_requests (int)

  • min_concurrent_requests (int)

  • multiplicative_decrease (float)

  • adaptive_concurrency (bool)

  • max_connections (int | None)

  • fetch_retries (int)

  • fetch_timeout (float)

  • rate_limit_per_second (float | None)

  • rate_limiter (HostRateLimiter | None)

  • forbidden_circuit_breaker (bool)

  • forbidden_window_seconds (float)

  • forbidden_threshold (int)

  • forbidden_cooldown_seconds (float)

__init__(**data)#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

Return type:

None

Methods

__init__(**data)

Create a new model by parsing and validating input data from keyword arguments.

array_defaults()

Default array-level configuration supplied by the service.

build_service()

Create the appropriate service implementation for this configuration.

construct([_fields_set])

copy(*[, include, exclude, update, deep])

Returns a copy of the model.

dict(*[, include, exclude, by_alias, ...])

fetch_policy()

Build a FetchPolicy from this configuration.

from_orm(obj)

json(*[, include, exclude, by_alias, ...])

model_construct([_fields_set])

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

model_copy(*[, update, deep])

!!! abstract "Usage Documentation"

model_dump(*[, mode, include, exclude, ...])

!!! abstract "Usage Documentation"

model_dump_json(*[, indent, ensure_ascii, ...])

!!! abstract "Usage Documentation"

model_json_schema([by_alias, ref_template, ...])

Generates a JSON schema for a model class.

model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

model_post_init(context, /)

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

model_rebuild(*[, force, raise_errors, ...])

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

model_validate(obj, *[, strict, extra, ...])

Validate a pydantic model instance.

model_validate_json(json_data, *[, strict, ...])

!!! abstract "Usage Documentation"

model_validate_strings(obj, *[, strict, ...])

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

parse_file(path, *[, content_type, ...])

parse_obj(obj)

parse_raw(b, *[, content_type, encoding, ...])

schema([by_alias, ref_template])

schema_json(*[, by_alias, ref_template])

service_kwargs()

Keyword arguments used when instantiating the service.

tile_kwargs()

Keyword arguments provided to the tile request planner.

update_forward_refs(**localns)

validate(value)

Attributes

model_computed_fields

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra

Get extra fields set during validation.

model_fields

model_fields_set

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

base_url

service_type

crs

output_format

headers

params

chunk_size

grid_shape

cache_dir

resolution

max_concurrent_requests

initial_concurrent_requests

min_concurrent_requests

multiplicative_decrease

adaptive_concurrency

max_connections

fetch_retries

fetch_timeout

rate_limit_per_second

rate_limiter

forbidden_circuit_breaker

forbidden_window_seconds

forbidden_threshold

forbidden_cooldown_seconds