sift_client.transport.grpc_transport

Transport layer for gRPC communication.

This module provides a simple wrapper around sift_py/grpc/transport.py for making gRPC API calls. It just stores the channel and the stubs, without any additional functionality.

CLASS	DESCRIPTION
CacheConfig	Configuration for gRPC response caching.
CacheMode	Cache behavior modes.
GrpcClient	A simple wrapper around sift_py/grpc/transport.py for making gRPC API calls.
GrpcConfig	Configuration for gRPC API clients.

ATTRIBUTE	DESCRIPTION
DEFAULT_CACHE_CONFIG
DEFAULT_CACHE_FOLDER
DEFAULT_CACHE_SIZE_LIMIT_BYTES
DEFAULT_CACHE_TTL_SECONDS
logger

DEFAULT_CACHE_CONFIG module-attribute

DEFAULT_CACHE_CONFIG = CacheConfig()

DEFAULT_CACHE_FOLDER module-attribute

DEFAULT_CACHE_FOLDER = Path(user_cache_dir('sift_client'))

DEFAULT_CACHE_SIZE_LIMIT_BYTES module-attribute

DEFAULT_CACHE_SIZE_LIMIT_BYTES = 5 * 1024 ** 3

DEFAULT_CACHE_TTL_SECONDS module-attribute

DEFAULT_CACHE_TTL_SECONDS = 7 * 24 * 60 * 60

logger module-attribute

logger = getLogger(__name__)

CacheConfig

CacheConfig(
    mode: CacheMode = ENABLED,
    ttl: int = DEFAULT_CACHE_TTL_SECONDS,
    cache_folder: Path | str = DEFAULT_CACHE_FOLDER,
    size_limit: int = DEFAULT_CACHE_SIZE_LIMIT_BYTES,
)

Configuration for gRPC response caching.

ATTRIBUTE	DESCRIPTION
mode	Cache behavior mode (enabled, disabled, clear_on_init).
ttl	Time-to-live for cached entries in seconds. Default is 1 week.
cache_folder	Path to the cache directory. Default is system temp directory.
size_limit	Maximum size of the cache in bytes. Default is 5GB.

Initialize the cache configuration.

PARAMETER	DESCRIPTION
mode	Cache behavior mode (use CacheMode constants). TYPE: CacheMode DEFAULT: ENABLED
ttl	Time-to-live for cached entries in seconds. TYPE: int DEFAULT: DEFAULT_CACHE_TTL_SECONDS
cache_folder	Path to the cache directory. TYPE: Path | str DEFAULT: DEFAULT_CACHE_FOLDER
size_limit	Maximum size of the cache in bytes. TYPE: int DEFAULT: DEFAULT_CACHE_SIZE_LIMIT_BYTES

METHOD	DESCRIPTION
to_sift_cache_config	Convert to a SiftCacheConfig for use with sift_py.grpc.transport.

cache_path instance-attribute

cache_path = str(Path(cache_folder) / 'grpc_cache')

is_enabled property

is_enabled: bool

Check if caching is enabled.

mode instance-attribute

mode = mode

should_clear_on_init property

should_clear_on_init: bool

Check if cache should be cleared on initialization.

size_limit instance-attribute

size_limit = size_limit

ttl instance-attribute

ttl = ttl

to_sift_cache_config

to_sift_cache_config() -> SiftCacheConfig

Convert to a SiftCacheConfig for use with sift_py.grpc.transport.

RETURNS	DESCRIPTION
SiftCacheConfig	A SiftCacheConfig dictionary.

CacheMode

Bases: str, Enum

Cache behavior modes.

• ENABLED: Cache is enabled and persists across sessions
• DISABLED: Cache is completely disabled
• CLEAR_ON_INIT: Cache is cleared when client is initialized (useful for notebooks)

ATTRIBUTE	DESCRIPTION
CLEAR_ON_INIT
DISABLED
ENABLED

CLEAR_ON_INIT class-attribute instance-attribute

CLEAR_ON_INIT = 'clear_on_init'

DISABLED class-attribute instance-attribute

DISABLED = 'disabled'

ENABLED class-attribute instance-attribute

ENABLED = 'enabled'

GrpcClient

GrpcClient(config: GrpcConfig)

A simple wrapper around sift_py/grpc/transport.py for making gRPC API calls.

This class just stores the channel and the stubs, without any additional functionality.

Initialize the gRPC client.

PARAMETER	DESCRIPTION
config	The gRPC client configuration. TYPE: GrpcConfig

METHOD	DESCRIPTION
__aenter__
__aexit__
__enter__
__exit__
close	Close sync and async channels and stop the default loop.
close_sync	Close the sync channel and all async channels.
get_stub	Get an async stub bound to the current event loop.

ATTRIBUTE	DESCRIPTION
cache
default_loop	Return the default event loop used for synchronous API operations. TYPE: AbstractEventLoop

cache instance-attribute

cache = _init_cache()

default_loop property

default_loop: AbstractEventLoop

Return the default event loop used for synchronous API operations.

RETURNS	DESCRIPTION
AbstractEventLoop	The default asyncio event loop.

__aenter__ async

__aenter__()

__aexit__ async

__aexit__(exc_type, exc_val, exc_tb)

__enter__

__enter__()

__exit__

__exit__(exc_type, exc_val, exc_tb)

close async

close()

Close sync and async channels and stop the default loop.

close_sync

close_sync()

Close the sync channel and all async channels.

get_stub

get_stub(stub_class: type[Any]) -> Any

Get an async stub bound to the current event loop. Creates a channel and stub for this loop if needed.

GrpcConfig

GrpcConfig(
    url: str,
    api_key: str,
    use_ssl: bool = True,
    cert_via_openssl: bool = False,
    metadata: dict[str, str] | None = None,
    cache_config: CacheConfig | None = None,
)

Configuration for gRPC API clients.

Initialize the gRPC configuration.

PARAMETER	DESCRIPTION
url	The URI of the gRPC server. TYPE: str
api_key	The API key for authentication. TYPE: str
use_ssl	Whether to use SSL/TLS. TYPE: bool DEFAULT: True
cert_via_openssl	Whether to use OpenSSL for SSL/TLS. TYPE: bool DEFAULT: False
metadata	Additional metadata to include in all requests. TYPE: dict[str, str] | None DEFAULT: None
cache_config	Optional cache configuration. If None, caching is disabled. TYPE: CacheConfig | None DEFAULT: None

ATTRIBUTE	DESCRIPTION
api_key
cache_config
cert_via_openssl
metadata
uri
use_ssl

api_key instance-attribute

api_key = api_key

cache_config instance-attribute

cache_config = cache_config

cert_via_openssl instance-attribute

cert_via_openssl = cert_via_openssl

metadata instance-attribute

metadata = metadata or {}

uri instance-attribute

uri = url

use_ssl instance-attribute

use_ssl = use_ssl