py_alpaca_api.cache.cache_config

Cache configuration for py-alpaca-api.

Classes

CacheType	Types of cache backends supported.
CacheConfig	Configuration for cache system.

Module Contents

class py_alpaca_api.cache.cache_config.CacheType(*args, **kwds)

Bases: enum.Enum

Types of cache backends supported.

MEMORY = 'memory'

REDIS = 'redis'

DISABLED = 'disabled'

class py_alpaca_api.cache.cache_config.CacheConfig

Configuration for cache system.

cache_type

Type of cache backend to use

max_size

Maximum number of items in memory cache

default_ttl

Default time-to-live in seconds

data_ttls

TTL overrides per data type

redis_host

Redis host (if using Redis)

redis_port

Redis port (if using Redis)

redis_db

Redis database number (if using Redis)

redis_password

Redis password (if using Redis)

enabled

Whether caching is enabled

cache_type: CacheType

max_size: int = 1000

default_ttl: int = 300

data_ttls: dict[str, int]

redis_host: str = 'localhost'

redis_port: int = 6379

redis_db: int = 0

redis_password: str | None = None

enabled: bool = True

get_ttl(data_type: str) → int

Get TTL for a specific data type.

Parameters:

data_type – Type of data to get TTL for

Returns:

TTL in seconds