<!-- # hard line break macro for HTML -->

# fiftyone.operators.store

* [fiftyone.operators.store.clone](fiftyone.operators.store.clone.md)
  * [`register_cloneable_store()`](fiftyone.operators.store.clone.md#fiftyone.operators.store.clone.register_cloneable_store)
  * [`clone_execution_stores()`](fiftyone.operators.store.clone.md#fiftyone.operators.store.clone.clone_execution_stores)
* [fiftyone.operators.store.models](fiftyone.operators.store.models.md)
  * [`KeyPolicy`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy)
    * [`KeyPolicy.PERSIST`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.PERSIST)
    * [`KeyPolicy.EVICT`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.EVICT)
    * [`KeyPolicy.encode()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.encode)
    * [`KeyPolicy.replace()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.replace)
    * [`KeyPolicy.split()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.split)
    * [`KeyPolicy.rsplit()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.rsplit)
    * [`KeyPolicy.join()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.join)
    * [`KeyPolicy.capitalize()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.capitalize)
    * [`KeyPolicy.casefold()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.casefold)
    * [`KeyPolicy.title()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.title)
    * [`KeyPolicy.center()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.center)
    * [`KeyPolicy.count()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.count)
    * [`KeyPolicy.expandtabs()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.expandtabs)
    * [`KeyPolicy.find()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.find)
    * [`KeyPolicy.partition()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.partition)
    * [`KeyPolicy.index()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.index)
    * [`KeyPolicy.ljust()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.ljust)
    * [`KeyPolicy.lower()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.lower)
    * [`KeyPolicy.lstrip()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.lstrip)
    * [`KeyPolicy.rfind()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.rfind)
    * [`KeyPolicy.rindex()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.rindex)
    * [`KeyPolicy.rjust()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.rjust)
    * [`KeyPolicy.rstrip()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.rstrip)
    * [`KeyPolicy.rpartition()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.rpartition)
    * [`KeyPolicy.splitlines()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.splitlines)
    * [`KeyPolicy.strip()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.strip)
    * [`KeyPolicy.swapcase()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.swapcase)
    * [`KeyPolicy.translate()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.translate)
    * [`KeyPolicy.upper()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.upper)
    * [`KeyPolicy.startswith()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.startswith)
    * [`KeyPolicy.endswith()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.endswith)
    * [`KeyPolicy.removeprefix()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.removeprefix)
    * [`KeyPolicy.removesuffix()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.removesuffix)
    * [`KeyPolicy.isascii()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isascii)
    * [`KeyPolicy.islower()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.islower)
    * [`KeyPolicy.isupper()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isupper)
    * [`KeyPolicy.istitle()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.istitle)
    * [`KeyPolicy.isspace()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isspace)
    * [`KeyPolicy.isdecimal()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isdecimal)
    * [`KeyPolicy.isdigit()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isdigit)
    * [`KeyPolicy.isnumeric()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isnumeric)
    * [`KeyPolicy.isalpha()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isalpha)
    * [`KeyPolicy.isalnum()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isalnum)
    * [`KeyPolicy.isidentifier()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isidentifier)
    * [`KeyPolicy.isprintable()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.isprintable)
    * [`KeyPolicy.zfill()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.zfill)
    * [`KeyPolicy.format()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.format)
    * [`KeyPolicy.format_map()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.format_map)
    * [`KeyPolicy.maketrans()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy.maketrans)
  * [`KeyDocument`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)
    * [`KeyDocument.store_name`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.store_name)
    * [`KeyDocument.key`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.key)
    * [`KeyDocument.value`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.value)
    * [`KeyDocument.dataset_id`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.dataset_id)
    * [`KeyDocument.created_at`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.created_at)
    * [`KeyDocument.updated_at`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.updated_at)
    * [`KeyDocument.expires_at`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.expires_at)
    * [`KeyDocument.policy`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.policy)
    * [`KeyDocument.get_expiration()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.get_expiration)
    * [`KeyDocument.from_dict()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.from_dict)
    * [`KeyDocument.to_mongo_dict()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument.to_mongo_dict)
  * [`StoreDocument`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument)
    * [`StoreDocument.key`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.key)
    * [`StoreDocument.value`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.value)
    * [`StoreDocument.metadata`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.metadata)
    * [`StoreDocument.dataset_id`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.dataset_id)
    * [`StoreDocument.expires_at`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.expires_at)
    * [`StoreDocument.from_dict()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.from_dict)
    * [`StoreDocument.get_expiration()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.get_expiration)
    * [`StoreDocument.policy`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.policy)
    * [`StoreDocument.to_mongo_dict()`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.to_mongo_dict)
    * [`StoreDocument.updated_at`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.updated_at)
    * [`StoreDocument.store_name`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.store_name)
    * [`StoreDocument.created_at`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument.created_at)
* [fiftyone.operators.store.notification_service](fiftyone.operators.store.notification_service.md)
  * [`ChangeStreamNotificationService`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService)
    * [`ChangeStreamNotificationService.subscribe()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService.subscribe)
    * [`ChangeStreamNotificationService.unsubscribe()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService.unsubscribe)
    * [`ChangeStreamNotificationService.unsubscribe_all()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService.unsubscribe_all)
    * [`ChangeStreamNotificationService.notify()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService.notify)
    * [`ChangeStreamNotificationService.start()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService.start)
    * [`ChangeStreamNotificationService.stop()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService.stop)
  * [`MongoChangeStreamNotificationService`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService)
    * [`MongoChangeStreamNotificationService.subscribe()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService.subscribe)
    * [`MongoChangeStreamNotificationService.unsubscribe()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService.unsubscribe)
    * [`MongoChangeStreamNotificationService.unsubscribe_all()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService.unsubscribe_all)
    * [`MongoChangeStreamNotificationService.start()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService.start)
    * [`MongoChangeStreamNotificationService.notify()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService.notify)
    * [`MongoChangeStreamNotificationService.stop()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationService.stop)
  * [`MongoChangeStreamNotificationServiceLifecycleManager`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationServiceLifecycleManager)
    * [`MongoChangeStreamNotificationServiceLifecycleManager.start_in_dedicated_thread()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationServiceLifecycleManager.start_in_dedicated_thread)
    * [`MongoChangeStreamNotificationServiceLifecycleManager.stop()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.MongoChangeStreamNotificationServiceLifecycleManager.stop)
  * [`is_notification_service_disabled()`](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.is_notification_service_disabled)
* [fiftyone.operators.store.service](fiftyone.operators.store.service.md)
  * [`ExecutionStoreService`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService)
    * [`ExecutionStoreService.create_store()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.create_store)
    * [`ExecutionStoreService.clear_cache()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.clear_cache)
    * [`ExecutionStoreService.get_store()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.get_store)
    * [`ExecutionStoreService.list_stores()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.list_stores)
    * [`ExecutionStoreService.count_stores()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.count_stores)
    * [`ExecutionStoreService.has_store()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.has_store)
    * [`ExecutionStoreService.delete_store()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.delete_store)
    * [`ExecutionStoreService.set_key()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.set_key)
    * [`ExecutionStoreService.set_cache_key()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.set_cache_key)
    * [`ExecutionStoreService.set_key_if_absent()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.set_key_if_absent)
    * [`ExecutionStoreService.compare_and_set_key()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.compare_and_set_key)
    * [`ExecutionStoreService.has_key()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.has_key)
    * [`ExecutionStoreService.get_key()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.get_key)
    * [`ExecutionStoreService.delete_key()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.delete_key)
    * [`ExecutionStoreService.update_ttl()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.update_ttl)
    * [`ExecutionStoreService.list_keys()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.list_keys)
    * [`ExecutionStoreService.count_keys()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.count_keys)
    * [`ExecutionStoreService.cleanup()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.cleanup)
    * [`ExecutionStoreService.has_store_global()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.has_store_global)
    * [`ExecutionStoreService.list_stores_global()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.list_stores_global)
    * [`ExecutionStoreService.count_stores_global()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.count_stores_global)
    * [`ExecutionStoreService.delete_store_global()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.delete_store_global)
    * [`ExecutionStoreService.subscribe()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.subscribe)
    * [`ExecutionStoreService.unsubscribe()`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService.unsubscribe)
* [fiftyone.operators.store.store](fiftyone.operators.store.store.md)
  * [`ExecutionStore`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore)
    * [`ExecutionStore.create()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.create)
    * [`ExecutionStore.list_stores()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.list_stores)
    * [`ExecutionStore.get()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.get)
    * [`ExecutionStore.set()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.set)
    * [`ExecutionStore.set_cache()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.set_cache)
    * [`ExecutionStore.set_if_absent()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.set_if_absent)
    * [`ExecutionStore.compare_and_set()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.compare_and_set)
    * [`ExecutionStore.delete()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.delete)
    * [`ExecutionStore.has()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.has)
    * [`ExecutionStore.clear()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.clear)
    * [`ExecutionStore.clear_cache()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.clear_cache)
    * [`ExecutionStore.update_ttl()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.update_ttl)
    * [`ExecutionStore.update_policy()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.update_policy)
    * [`ExecutionStore.get_metadata()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.get_metadata)
    * [`ExecutionStore.list_keys()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.list_keys)
    * [`ExecutionStore.subscribe()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.subscribe)
    * [`ExecutionStore.unsubscribe()`](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore.unsubscribe)
* [fiftyone.operators.store.subscription_registry](fiftyone.operators.store.subscription_registry.md)
  * [`LocalSubscriptionRegistry`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.LocalSubscriptionRegistry)
    * [`LocalSubscriptionRegistry.subscribe()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.LocalSubscriptionRegistry.subscribe)
    * [`LocalSubscriptionRegistry.unsubscribe()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.LocalSubscriptionRegistry.unsubscribe)
    * [`LocalSubscriptionRegistry.unsubscribe_all()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.LocalSubscriptionRegistry.unsubscribe_all)
    * [`LocalSubscriptionRegistry.empty_subscribers()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.LocalSubscriptionRegistry.empty_subscribers)
    * [`LocalSubscriptionRegistry.get_subscribers()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.LocalSubscriptionRegistry.get_subscribers)
  * [`InLocalMemorySubscriptionRegistry`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.InLocalMemorySubscriptionRegistry)
    * [`InLocalMemorySubscriptionRegistry.subscribe()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.InLocalMemorySubscriptionRegistry.subscribe)
    * [`InLocalMemorySubscriptionRegistry.unsubscribe()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.InLocalMemorySubscriptionRegistry.unsubscribe)
    * [`InLocalMemorySubscriptionRegistry.unsubscribe_all()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.InLocalMemorySubscriptionRegistry.unsubscribe_all)
    * [`InLocalMemorySubscriptionRegistry.get_subscribers()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.InLocalMemorySubscriptionRegistry.get_subscribers)
    * [`InLocalMemorySubscriptionRegistry.empty_subscribers()`](fiftyone.operators.store.subscription_registry.md#fiftyone.operators.store.subscription_registry.InLocalMemorySubscriptionRegistry.empty_subscribers)
* [fiftyone.operators.store.transient_jobs](fiftyone.operators.store.transient_jobs.md)
  * [`TransientJobCoordinator`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator)
    * [`TransientJobCoordinator.create()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.create)
    * [`TransientJobCoordinator.get()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.get)
    * [`TransientJobCoordinator.claim()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.claim)
    * [`TransientJobCoordinator.heartbeat()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.heartbeat)
    * [`TransientJobCoordinator.set_progress()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.set_progress)
    * [`TransientJobCoordinator.request_cancel()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.request_cancel)
    * [`TransientJobCoordinator.cancel()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.cancel)
    * [`TransientJobCoordinator.complete()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.complete)
    * [`TransientJobCoordinator.fail()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.fail)
    * [`TransientJobCoordinator.fail_expired()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobCoordinator.fail_expired)
  * [`TransientJobAlreadyExists`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobAlreadyExists)
    * [`TransientJobAlreadyExists.add_note()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobAlreadyExists.add_note)
    * [`TransientJobAlreadyExists.args`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobAlreadyExists.args)
    * [`TransientJobAlreadyExists.with_traceback()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobAlreadyExists.with_traceback)
  * [`TransientJobConflict`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobConflict)
    * [`TransientJobConflict.add_note()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobConflict.add_note)
    * [`TransientJobConflict.args`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobConflict.args)
    * [`TransientJobConflict.with_traceback()`](fiftyone.operators.store.transient_jobs.md#fiftyone.operators.store.transient_jobs.TransientJobConflict.with_traceback)

## Module contents

Execution store.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Classes:**

| [`ExecutionStoreService`](#fiftyone.operators.store.ExecutionStoreService)([repo, dataset_id, ...])   | Service for managing execution store operations.              |
|-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|
| [`ExecutionStore`](#fiftyone.operators.store.ExecutionStore)(store_name, store_service[, ...])        | Execution store.                                              |
| [`TransientJobCoordinator`](#fiftyone.operators.store.TransientJobCoordinator)(store[, ...])          | Coordinates short-lived work through one Execution Store.     |
| [`StoreDocument`](#fiftyone.operators.store.StoreDocument)(store_name, key, value, ...)               | Model representing a Store.                                   |
| [`KeyDocument`](#fiftyone.operators.store.KeyDocument)(store_name, key, value, \_id, ...)             | Model representing a key in the store.                        |
| [`KeyPolicy`](#fiftyone.operators.store.KeyPolicy)(\*values)                                          | Defines the eviction policy for a key in the execution store. |

**Exceptions:**

| [`TransientJobAlreadyExists`](#fiftyone.operators.store.TransientJobAlreadyExists)(job_id)   | Raised when a transient job ID already exists.                    |
|----------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
| [`TransientJobConflict`](#fiftyone.operators.store.TransientJobConflict)(job_id)             | Raised when concurrent writers repeatedly prevent a job mutation. |

### *class* fiftyone.operators.store.ExecutionStoreService(repo: [ExecutionStoreRepo](fiftyone.factory.repos.execution_store.md#fiftyone.factory.repos.execution_store.ExecutionStoreRepo) | None = None, dataset_id: [ObjectId](https://pymongo.readthedocs.io/en/stable/api/bson/objectid.html#bson.objectid.ObjectId) | None = None, collection_name: str = None, notification_service: [ChangeStreamNotificationService](fiftyone.operators.store.notification_service.md#fiftyone.operators.store.notification_service.ChangeStreamNotificationService) | None = None)

Bases: `object`

Service for managing execution store operations.

Note that each instance of this service has a context:

- If a `dataset_id` is provided (or a `repo` associated with one),
  this instance operates on stores associated with that dataset
- If no `dataset_id` is provided (or a `repo` is provided that is not
  associated with one), this instance operates on stores that are not
  associated with a dataset

To operate on all stores across all contexts, use the `XXX_global()`
methods that this class provides.

* **Parameters:**
  * **repo** (*None*) – a
    [`fiftyone.factory.repos.execution_store.ExecutionStoreRepo`](fiftyone.factory.repos.execution_store.md#fiftyone.factory.repos.execution_store.ExecutionStoreRepo)
    If not provided, a new
    [`fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo`](fiftyone.factory.repos.execution_store.md#fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo)
    will be created
  * **dataset_id** (*None*) – a dataset ID (ObjectId) to scope operations to
  * **collection_name** (*None*) – a collection name to use for the execution
    store. If `repo` is provided, this argument is ignored
  * **notification_service** (*None*) – an optional notification service for the repository

**Methods:**

| [`create_store`](#fiftyone.operators.store.ExecutionStoreService.create_store)(store_name[, metadata, policy])            | Creates a new store with the specified name.                                                      |
|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| [`clear_cache`](#fiftyone.operators.store.ExecutionStoreService.clear_cache)([store_name])                                | Clears all cache entries in the execution stores.                                                 |
| [`get_store`](#fiftyone.operators.store.ExecutionStoreService.get_store)(store_name)                                      | Gets the specified store for the current context.                                                 |
| [`list_stores`](#fiftyone.operators.store.ExecutionStoreService.list_stores)()                                            | Lists all stores for the current context.                                                         |
| [`count_stores`](#fiftyone.operators.store.ExecutionStoreService.count_stores)()                                          | Counts the stores for the current context.                                                        |
| [`has_store`](#fiftyone.operators.store.ExecutionStoreService.has_store)(store_name)                                      | Determines whether the specified store exists in the current context.                             |
| [`delete_store`](#fiftyone.operators.store.ExecutionStoreService.delete_store)(store_name)                                | Deletes the specified store.                                                                      |
| [`set_key`](#fiftyone.operators.store.ExecutionStoreService.set_key)(store_name, key, value[, ttl, policy])               | Sets the value of a key in the specified store.                                                   |
| [`set_cache_key`](#fiftyone.operators.store.ExecutionStoreService.set_cache_key)(store_name, key, value[, ttl])           | Sets the value of a cache key in the specified store.                                             |
| [`set_key_if_absent`](#fiftyone.operators.store.ExecutionStoreService.set_key_if_absent)(store_name, key, value[, ...])   | Sets a key only when no value is already stored for it.                                           |
| [`compare_and_set_key`](#fiftyone.operators.store.ExecutionStoreService.compare_and_set_key)(store_name, key, ...[, ...]) | Atomically replaces a key whose value matches `expected`.                                         |
| [`has_key`](#fiftyone.operators.store.ExecutionStoreService.has_key)(store_name, key)                                     | Determines whether the specified key exists in the specified store.                               |
| [`get_key`](#fiftyone.operators.store.ExecutionStoreService.get_key)(store_name, key)                                     | Retrieves the value of a key from the specified store.                                            |
| [`delete_key`](#fiftyone.operators.store.ExecutionStoreService.delete_key)(store_name, key)                               | Deletes the specified key from the store.                                                         |
| [`update_ttl`](#fiftyone.operators.store.ExecutionStoreService.update_ttl)(store_name, key, new_ttl)                      | Updates the TTL of the specified key in the store.                                                |
| [`list_keys`](#fiftyone.operators.store.ExecutionStoreService.list_keys)(store_name)                                      | Lists all keys in the specified store.                                                            |
| [`count_keys`](#fiftyone.operators.store.ExecutionStoreService.count_keys)(store_name)                                    | Counts the keys in the specified store.                                                           |
| [`cleanup`](#fiftyone.operators.store.ExecutionStoreService.cleanup)()                                                    | Deletes all stores associated with the current context.                                           |
| [`has_store_global`](#fiftyone.operators.store.ExecutionStoreService.has_store_global)(store_name)                        | Determines whether a store with the given name exists across all datasets and the global context. |
| [`list_stores_global`](#fiftyone.operators.store.ExecutionStoreService.list_stores_global)()                              | Lists the stores across all datasets and the global context.                                      |
| [`count_stores_global`](#fiftyone.operators.store.ExecutionStoreService.count_stores_global)()                            | Counts the stores across all datasets and the global context.                                     |
| [`delete_store_global`](#fiftyone.operators.store.ExecutionStoreService.delete_store_global)(store_name)                  | Deletes the specified store across all datasets and the global context.                           |
| [`subscribe`](#fiftyone.operators.store.ExecutionStoreService.subscribe)(store_name, callback)                            | Subscribe to changes in a store.                                                                  |
| [`unsubscribe`](#fiftyone.operators.store.ExecutionStoreService.unsubscribe)(subscription_id)                             | Unsubscribe from changes in a store.                                                              |

#### create_store(store_name: str, metadata: dict[str, Any] | None = None, policy: str = 'persist') → [StoreDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument)

Creates a new store with the specified name.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  a `fiftyone.store.models.StoreDocument`

#### clear_cache(store_name=None) → None

Clears all cache entries in the execution stores.

#### get_store(store_name: str) → [StoreDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument)

Gets the specified store for the current context.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  a `fiftyone.store.models.StoreDocument`

#### list_stores() → [list](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)[str]

Lists all stores for the current context.

* **Returns:**
  a list of store names

#### count_stores() → int

Counts the stores for the current context.

* **Returns:**
  the number of stores

#### has_store(store_name) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Determines whether the specified store exists in the current
context.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  True/False

#### delete_store(store_name: str) → [StoreDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument)

Deletes the specified store.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  a `fiftyone.store.models.StoreDocument`

#### set_key(store_name: str, key: str, value: Any, ttl: int | None = None, policy: str = 'persist') → [KeyDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Sets the value of a key in the specified store.

Keys can be either **persistent** or **cacheable**, depending on the provided
`policy` or whether a TTL (time-to-live) is set.

- If `policy="persist"` (default), the key will remain in the store until
  explicitly deleted.
- If `policy="evict"`, the key may be evicted by the system or manually
  removed using [`clear_cache()`](#fiftyone.operators.store.ExecutionStoreService.clear_cache).
- If a TTL is provided, the key is **always** treated as `policy="evict"`.

* **Parameters:**
  * **store_name** – the name of the store
  * **key** – the key to set
  * **value** – the value to set
  * **ttl** (*None*) – an optional TTL in seconds
  * **policy** (*persist*) – the eviction policy for the key. Can be “persist” or “evict”.
    If “persist”, the key will never be automatically removed.
    If “evict”, the key may be removed automatically if a TTL is set,
    or manually via [`clear_cache()`](#fiftyone.operators.store.ExecutionStoreService.clear_cache).
* **Returns:**
  The created or updated key document.
* **Return type:**
  [KeyDocument](#fiftyone.operators.store.KeyDocument)

#### set_cache_key(store_name: str, key: str, value: Any, ttl: int | None = None) → [KeyDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Sets the value of a cache key in the specified store.

* **Parameters:**
  * **store_name** – the name of the store
  * **key** – the key to set
  * **value** – the value to set
  * **ttl** (*None*) – an optional TTL in seconds

#### set_key_if_absent(store_name: str, key: str, value: Any, ttl: int | None = None, policy: str = 'persist') → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Sets a key only when no value is already stored for it.

#### compare_and_set_key(store_name: str, key: str, expected: Any, value: Any, ttl: int | None = None, policy: str | None = None) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Atomically replaces a key whose value matches `expected`.

#### has_key(store_name: str, key: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Determines whether the specified key exists in the specified store.

* **Parameters:**
  * **store_name** – the name of the store
  * **key** – the key to check

#### get_key(store_name: str, key: str) → [KeyDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Retrieves the value of a key from the specified store.

* **Parameters:**
  * **store_name** – the name of the store
  * **key** – the key to retrieve
* **Returns:**
  a `fiftyone.store.models.KeyDocument`

#### delete_key(store_name: str, key: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Deletes the specified key from the store.

* **Parameters:**
  * **store_name** – the name of the store
  * **key** – the key to delete
* **Returns:**
  `True` if the key was deleted, `False` otherwise

#### update_ttl(store_name: str, key: str, new_ttl: int) → [KeyDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Updates the TTL of the specified key in the store.

* **Parameters:**
  * **store_name** – the name of the store
  * **key** – the key to update the TTL for
  * **new_ttl** – the new TTL in seconds
* **Returns:**
  a `fiftyone.store.models.KeyDocument`

#### list_keys(store_name: str) → [list](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)[str]

Lists all keys in the specified store.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  a list of keys in the store

#### count_keys(store_name: str) → int

Counts the keys in the specified store.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  the number of keys in the store

#### cleanup() → None

Deletes all stores associated with the current context.

#### has_store_global(store_name: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Determines whether a store with the given name exists across all
datasets and the global context.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  True/False

#### list_stores_global() → [list](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)[[StoreDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.StoreDocument)]

Lists the stores across all datasets and the global context.

* **Returns:**
  a list of `fiftyone.store.models.StoreDocument`

#### count_stores_global() → int

Counts the stores across all datasets and the global context.

* **Returns:**
  the number of stores

#### delete_store_global(store_name: str) → int

Deletes the specified store across all datasets and the global
context.

* **Parameters:**
  **store_name** – the name of the store
* **Returns:**
  the number of stores deleted

#### subscribe(store_name: str, callback: Callable[[str], None]) → str

Subscribe to changes in a store.

* **Parameters:**
  * **store_name** (*str*) – the name of the store to subscribe to
  * **callback** (*Callable* *[* *[**str* *]* *,* *None* *]*) – the callback to call when a change occurs
* **Returns:**
  the subscription ID
* **Return type:**
  str

#### unsubscribe(subscription_id: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Unsubscribe from changes in a store.

* **Parameters:**
  **subscription_id** (*str*) – the subscription ID to unsubscribe
* **Returns:**
  True if the subscription was removed, False otherwise
* **Return type:**
  [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

### *class* fiftyone.operators.store.ExecutionStore(store_name: str, store_service: [ExecutionStoreService](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService), default_policy: str = 'persist')

Bases: `object`

Execution store.

* **Parameters:**
  * **store_name** – the name of the store
  * **store_service** – an
    [`fiftyone.operators.store.service.ExecutionStoreService`](fiftyone.operators.store.service.md#fiftyone.operators.store.service.ExecutionStoreService)
  * **default_policy** ( *"persist"*) – the default eviction policy for the store.

**Methods:**

| [`create`](#fiftyone.operators.store.ExecutionStore.create)(store_name[, dataset_id, ...])                      | Creates a new execution store.                                     |
|-----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
| [`list_stores`](#fiftyone.operators.store.ExecutionStore.list_stores)()                                         | Lists all stores in the execution store.                           |
| [`get`](#fiftyone.operators.store.ExecutionStore.get)(key)                                                      | Retrieves a value from the store by its key.                       |
| [`set`](#fiftyone.operators.store.ExecutionStore.set)(key, value[, ttl, policy])                                | Sets the value of a key in the specified store.                    |
| [`set_cache`](#fiftyone.operators.store.ExecutionStore.set_cache)(key, value[, ttl])                            | Sets a value in the store with the eviction policy set to "evict". |
| [`set_if_absent`](#fiftyone.operators.store.ExecutionStore.set_if_absent)(key, value[, ttl, policy])            | Sets a key only when it does not already exist.                    |
| [`compare_and_set`](#fiftyone.operators.store.ExecutionStore.compare_and_set)(key, expected, value[, ttl, ...]) | Atomically replaces a key whose value matches `expected`.          |
| [`delete`](#fiftyone.operators.store.ExecutionStore.delete)(key)                                                | Deletes a key from the store.                                      |
| [`has`](#fiftyone.operators.store.ExecutionStore.has)(key)                                                      | Checks if the store has a specific key.                            |
| [`clear`](#fiftyone.operators.store.ExecutionStore.clear)()                                                     | Clears all the data in the store.                                  |
| [`clear_cache`](#fiftyone.operators.store.ExecutionStore.clear_cache)()                                         | Clears the cache for the store.                                    |
| [`update_ttl`](#fiftyone.operators.store.ExecutionStore.update_ttl)(key, new_ttl)                               | Updates the TTL for a specific key.                                |
| [`update_policy`](#fiftyone.operators.store.ExecutionStore.update_policy)(key, policy)                          | Updates the eviction policy for a specific key.                    |
| [`get_metadata`](#fiftyone.operators.store.ExecutionStore.get_metadata)(key)                                    | Retrieves the metadata for the given key.                          |
| [`list_keys`](#fiftyone.operators.store.ExecutionStore.list_keys)()                                             | Lists all keys in the store.                                       |
| [`subscribe`](#fiftyone.operators.store.ExecutionStore.subscribe)(callback)                                     | Subscribes to changes in the store.                                |
| [`unsubscribe`](#fiftyone.operators.store.ExecutionStore.unsubscribe)(subscription_id)                          | Unsubscribes from changes in the store.                            |

#### *static* create(store_name: str, dataset_id: [ObjectId](https://pymongo.readthedocs.io/en/stable/api/bson/objectid.html#bson.objectid.ObjectId) | None = None, default_policy: str = 'persist', collection_name: str | None = None) → [ExecutionStore](fiftyone.operators.store.store.md#fiftyone.operators.store.store.ExecutionStore)

Creates a new execution store.

* **Parameters:**
  * **store_name** – the name of the store
  * **dataset_id** – an optional dataset ID to scope the store to
* **Returns:**
  an ExecutionStore instance

#### list_stores() → [list](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)[str]

Lists all stores in the execution store.

* **Returns:**
  a list of store names
* **Return type:**
  [list](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)

#### get(key: str) → Any | None

Retrieves a value from the store by its key.

* **Parameters:**
  **key** – the key to retrieve the value for
* **Returns:**
  the value stored under the given key, or None if not found

#### set(key: str, value: Any, ttl: int | None = None, policy=None) → None

Sets the value of a key in the specified store.

* **Parameters:**
  * **key** – the key to set
  * **value** – the value to set
  * **ttl** (*None*) – an optional TTL in seconds
  * **policy** (*persist*) – the eviction policy for the key. Can be “persist” or “evict”.
    If “persist”, the key will never be automatically removed.
    If “evict”, the key may be removed automatically if a TTL is set,
    or manually via [`clear_cache()`](#fiftyone.operators.store.ExecutionStore.clear_cache).
* **Returns:**
  a `fiftyone.store.models.KeyDocument`

#### set_cache(key: str, value: Any, ttl: int | None = None) → None

Sets a value in the store with the eviction policy set to “evict”.

* **Parameters:**
  * **key** – the key to store the value under
  * **value** – the value to store
  * **ttl** (*None*) – the time-to-live in seconds

#### set_if_absent(key: str, value: Any, ttl: int | None = None, policy=None) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Sets a key only when it does not already exist.

#### compare_and_set(key: str, expected: Any, value: Any, ttl: int | None = None, policy=None) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Atomically replaces a key whose value matches `expected`.

Existing expiration and policy metadata is preserved when `ttl` and
`policy` are omitted.

#### delete(key: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Deletes a key from the store.

* **Parameters:**
  **key** – the key to delete.
* **Returns:**
  True/False whether the key was deleted

#### has(key: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Checks if the store has a specific key.

* **Parameters:**
  **key** – the key to check
* **Returns:**
  True/False whether the key exists

#### clear() → None

Clears all the data in the store.

#### clear_cache() → None

Clears the cache for the store.

This will remove all keys that are eligible for eviction.

#### update_ttl(key: str, new_ttl: int) → None

Updates the TTL for a specific key.

* **Parameters:**
  * **key** – the key to update the TTL for
  * **new_ttl** – the new TTL in seconds

#### update_policy(key: str, policy: str) → None

Updates the eviction policy for a specific key.

* **Parameters:**
  * **key** – the key to update the policy for
  * **policy** – the new policy, either “persist” or “evict”

#### get_metadata(key: str) → dict | None

Retrieves the metadata for the given key.

* **Parameters:**
  **key** – the key to check
* **Returns:**
  a dict of metadata about the key

#### list_keys() → [list](fiftyone.core.session.events.md#fiftyone.core.session.events.Colorscale.list)[str]

Lists all keys in the store.

* **Returns:**
  a list of keys in the store

#### subscribe(callback: Callable[[[MessageData](fiftyone.operators.message.md#fiftyone.operators.message.MessageData)], None]) → str

Subscribes to changes in the store.

* **Parameters:**
  **callback** – a function that will be called when a change occurs in the store
* **Returns:**
  a subscription ID

#### unsubscribe(subscription_id: str) → [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool)

Unsubscribes from changes in the store.

* **Parameters:**
  **subscription_id** – the subscription ID to unsubscribe from
* **Returns:**
  True if the subscription was removed, False otherwise

### *exception* fiftyone.operators.store.TransientJobAlreadyExists(job_id)

Bases: `RuntimeError`

Raised when a transient job ID already exists.

**Methods:**

| [`add_note`](#fiftyone.operators.store.TransientJobAlreadyExists.add_note)(object, /)             | Exception.add_note(note) -- add a note to the exception                         |
|---------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| [`with_traceback`](#fiftyone.operators.store.TransientJobAlreadyExists.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. |

**Attributes:**

| [`args`](#fiftyone.operators.store.TransientJobAlreadyExists.args)   |    |
|----------------------------------------------------------------------|----|

#### add_note(object,)

Exception.add_note(note) –
add a note to the exception

#### args

#### with_traceback(object,)

Exception.with_traceback(tb) –
set self._\_traceback_\_ to tb and return self.

### *exception* fiftyone.operators.store.TransientJobConflict(job_id)

Bases: `RuntimeError`

Raised when concurrent writers repeatedly prevent a job mutation.

**Methods:**

| [`add_note`](#fiftyone.operators.store.TransientJobConflict.add_note)(object, /)             | Exception.add_note(note) -- add a note to the exception                         |
|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| [`with_traceback`](#fiftyone.operators.store.TransientJobConflict.with_traceback)(object, /) | Exception.with_traceback(tb) -- set self._\_traceback_\_ to tb and return self. |

**Attributes:**

| [`args`](#fiftyone.operators.store.TransientJobConflict.args)   |    |
|-----------------------------------------------------------------|----|

#### add_note(object,)

Exception.add_note(note) –
add a note to the exception

#### args

#### with_traceback(object,)

Exception.with_traceback(tb) –
set self._\_traceback_\_ to tb and return self.

### *class* fiftyone.operators.store.TransientJobCoordinator(store, ttl_seconds=86400, lease_seconds=900)

Bases: `object`

Coordinates short-lived work through one Execution Store.

This class owns coordination state only. Callers remain responsible for
starting workers and transporting their results.

* **Parameters:**
  * **store** – an [`fiftyone.operators.store.ExecutionStore`](#fiftyone.operators.store.ExecutionStore)
  * **ttl_seconds** (*86400*) – retention for job records
  * **lease_seconds** (*900*) – duration of a worker claim

**Methods:**

| [`create`](#fiftyone.operators.store.TransientJobCoordinator.create)(\*, owner, scope, payload[, job_id])         | Creates one requested job with immutable caller data.            |
|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
| [`get`](#fiftyone.operators.store.TransientJobCoordinator.get)(job_id)                                            | Returns a detached job value, or `None` when it is absent.       |
| [`claim`](#fiftyone.operators.store.TransientJobCoordinator.claim)(job_id, \*[, allow_reclaim])                   | Atomically claims one requested or lease-expired job.            |
| [`heartbeat`](#fiftyone.operators.store.TransientJobCoordinator.heartbeat)(job_id, fencing_token)                 | Renews a running worker's lease.                                 |
| [`set_progress`](#fiftyone.operators.store.TransientJobCoordinator.set_progress)(job_id, fencing_token, progress) | Persists progress from the current fenced worker.                |
| [`request_cancel`](#fiftyone.operators.store.TransientJobCoordinator.request_cancel)(job_id)                      | Requests cancellation or cancels work that has not been claimed. |
| [`cancel`](#fiftyone.operators.store.TransientJobCoordinator.cancel)(job_id, fencing_token)                       | Marks the current worker's job canceled.                         |
| [`complete`](#fiftyone.operators.store.TransientJobCoordinator.complete)(job_id, fencing_token[, result])         | Completes the current worker's job.                              |
| [`fail`](#fiftyone.operators.store.TransientJobCoordinator.fail)(job_id, fencing_token, error)                    | Fails the current worker's job with a caller-sanitized error.    |
| [`fail_expired`](#fiftyone.operators.store.TransientJobCoordinator.fail_expired)(job_id, error)                   | Fails a running job whose worker lease has expired.              |

#### create(, owner, scope, payload, job_id=None)

Creates one requested job with immutable caller data.

#### get(job_id)

Returns a detached job value, or `None` when it is absent.

#### claim(job_id, , allow_reclaim=True)

Atomically claims one requested or lease-expired job.

* **Returns:**
  the claimed job, including its new fencing token, or `None`

#### heartbeat(job_id, fencing_token)

Renews a running worker’s lease.

#### set_progress(job_id, fencing_token, progress)

Persists progress from the current fenced worker.

#### request_cancel(job_id)

Requests cancellation or cancels work that has not been claimed.

#### cancel(job_id, fencing_token)

Marks the current worker’s job canceled.

#### complete(job_id, fencing_token, result=None)

Completes the current worker’s job.

#### fail(job_id, fencing_token, error)

Fails the current worker’s job with a caller-sanitized error.

#### fail_expired(job_id, error)

Fails a running job whose worker lease has expired.

This is a coordinator recovery transition rather than a worker
mutation, so it is guarded by the expired lease instead of a fencing
token. A current worker still owns every mutation while its lease is
valid.

### *class* fiftyone.operators.store.StoreDocument(store_name: str, key: str = '_\_store_\_', value: dict[str, ~typing.Any] | None=None, \_id: Any | None = None, dataset_id: [ObjectId](https://pymongo.readthedocs.io/en/stable/api/bson/objectid.html#bson.objectid.ObjectId) | None = None, created_at: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) = <factory>, updated_at: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None = None, expires_at: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None = None, policy: [KeyPolicy](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy) = KeyPolicy.PERSIST)

Bases: [`KeyDocument`](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Model representing a Store.

**Attributes:**

| [`key`](#fiftyone.operators.store.StoreDocument.key)               |                                         |
|--------------------------------------------------------------------|-----------------------------------------|
| [`value`](#fiftyone.operators.store.StoreDocument.value)           |                                         |
| [`metadata`](#fiftyone.operators.store.StoreDocument.metadata)     | The metadata associated with the store. |
| [`dataset_id`](#fiftyone.operators.store.StoreDocument.dataset_id) |                                         |
| [`expires_at`](#fiftyone.operators.store.StoreDocument.expires_at) |                                         |
| [`policy`](#fiftyone.operators.store.StoreDocument.policy)         |                                         |
| [`updated_at`](#fiftyone.operators.store.StoreDocument.updated_at) |                                         |
| [`store_name`](#fiftyone.operators.store.StoreDocument.store_name) |                                         |
| [`created_at`](#fiftyone.operators.store.StoreDocument.created_at) |                                         |

**Methods:**

| [`from_dict`](#fiftyone.operators.store.StoreDocument.from_dict)(doc)                  | Creates a KeyDocument from a dictionary.               |
|----------------------------------------------------------------------------------------|--------------------------------------------------------|
| [`get_expiration`](#fiftyone.operators.store.StoreDocument.get_expiration)(ttl)        | Gets the expiration date for a key with the given TTL. |
| [`to_mongo_dict`](#fiftyone.operators.store.StoreDocument.to_mongo_dict)([exclude_id]) | Serializes the document to a MongoDB dictionary.       |

#### key *: str* *= '_\_store_\_'*

#### value *: dict[str, Any] | None* *= None*

#### *property* metadata *: dict[str, Any]*

The metadata associated with the store.

#### dataset_id *: [ObjectId](https://pymongo.readthedocs.io/en/stable/api/bson/objectid.html#bson.objectid.ObjectId) | None* *= None*

#### expires_at *: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None* *= None*

#### *classmethod* from_dict(doc: dict[str, Any]) → [KeyDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Creates a KeyDocument from a dictionary.

#### *static* get_expiration(ttl: int | None) → [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None

Gets the expiration date for a key with the given TTL.

#### policy *: [KeyPolicy](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy)* *= 'persist'*

#### to_mongo_dict(exclude_id: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = True) → dict[str, Any]

Serializes the document to a MongoDB dictionary.

#### updated_at *: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None* *= None*

#### store_name *: str*

#### created_at *: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime)*

### *class* fiftyone.operators.store.KeyDocument(store_name: str, key: str, value: Any, \_id: Any | None = None, dataset_id: [ObjectId](https://pymongo.readthedocs.io/en/stable/api/bson/objectid.html#bson.objectid.ObjectId) | None = None, created_at: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) = <factory>, updated_at: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None = None, expires_at: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None = None, policy: [KeyPolicy](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy) = KeyPolicy.PERSIST)

Bases: `object`

Model representing a key in the store.

**Attributes:**

| [`store_name`](#fiftyone.operators.store.KeyDocument.store_name)   |    |
|--------------------------------------------------------------------|----|
| [`key`](#fiftyone.operators.store.KeyDocument.key)                 |    |
| [`value`](#fiftyone.operators.store.KeyDocument.value)             |    |
| [`dataset_id`](#fiftyone.operators.store.KeyDocument.dataset_id)   |    |
| [`created_at`](#fiftyone.operators.store.KeyDocument.created_at)   |    |
| [`updated_at`](#fiftyone.operators.store.KeyDocument.updated_at)   |    |
| [`expires_at`](#fiftyone.operators.store.KeyDocument.expires_at)   |    |
| [`policy`](#fiftyone.operators.store.KeyDocument.policy)           |    |

**Methods:**

| [`get_expiration`](#fiftyone.operators.store.KeyDocument.get_expiration)(ttl)        | Gets the expiration date for a key with the given TTL.   |
|--------------------------------------------------------------------------------------|----------------------------------------------------------|
| [`from_dict`](#fiftyone.operators.store.KeyDocument.from_dict)(doc)                  | Creates a KeyDocument from a dictionary.                 |
| [`to_mongo_dict`](#fiftyone.operators.store.KeyDocument.to_mongo_dict)([exclude_id]) | Serializes the document to a MongoDB dictionary.         |

#### store_name *: str*

#### key *: str*

#### value *: Any*

#### dataset_id *: [ObjectId](https://pymongo.readthedocs.io/en/stable/api/bson/objectid.html#bson.objectid.ObjectId) | None* *= None*

#### created_at *: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime)*

#### updated_at *: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None* *= None*

#### expires_at *: [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None* *= None*

#### policy *: [KeyPolicy](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyPolicy)* *= 'persist'*

#### *static* get_expiration(ttl: int | None) → [datetime](fiftyone.utils.data.md#fiftyone.utils.data.datetime) | None

Gets the expiration date for a key with the given TTL.

#### *classmethod* from_dict(doc: dict[str, Any]) → [KeyDocument](fiftyone.operators.store.models.md#fiftyone.operators.store.models.KeyDocument)

Creates a KeyDocument from a dictionary.

#### to_mongo_dict(exclude_id: [bool](fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) = True) → dict[str, Any]

Serializes the document to a MongoDB dictionary.

### *class* fiftyone.operators.store.KeyPolicy(\*values)

Bases: `str`, `Enum`

Defines the eviction policy for a key in the execution store.

- `PERSIST`: The key is stored persistently and will never be automatically
  removed. It must be explicitly deleted.
- `EVICT`: The key is considered cacheable and may be removed automatically
  if a TTL is set, or manually via `clear_cache()`.

**Attributes:**

| [`PERSIST`](#fiftyone.operators.store.KeyPolicy.PERSIST)   |    |
|------------------------------------------------------------|----|
| [`EVICT`](#fiftyone.operators.store.KeyPolicy.EVICT)       |    |

**Methods:**

| [`encode`](#fiftyone.operators.store.KeyPolicy.encode)([encoding, errors])     | Encode the string using the codec registered for encoding.                                                  |
|--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| [`replace`](#fiftyone.operators.store.KeyPolicy.replace)(old, new, /[, count]) | Return a copy with all occurrences of substring old replaced by new.                                        |
| [`split`](#fiftyone.operators.store.KeyPolicy.split)([sep, maxsplit])          | Return a list of the substrings in the string, using sep as the separator string.                           |
| [`rsplit`](#fiftyone.operators.store.KeyPolicy.rsplit)([sep, maxsplit])        | Return a list of the substrings in the string, using sep as the separator string.                           |
| [`join`](#fiftyone.operators.store.KeyPolicy.join)(iterable, /)                | Concatenate any number of strings.                                                                          |
| [`capitalize`](#fiftyone.operators.store.KeyPolicy.capitalize)()               | Return a capitalized version of the string.                                                                 |
| [`casefold`](#fiftyone.operators.store.KeyPolicy.casefold)()                   | Return a version of the string suitable for caseless comparisons.                                           |
| [`title`](#fiftyone.operators.store.KeyPolicy.title)()                         | Return a version of the string where each word is titlecased.                                               |
| [`center`](#fiftyone.operators.store.KeyPolicy.center)(width[, fillchar])      | Return a centered string of length width.                                                                   |
| [`count`](#fiftyone.operators.store.KeyPolicy.count)                           | Return the number of non-overlapping occurrences of substring sub in string S[start:end].                   |
| [`expandtabs`](#fiftyone.operators.store.KeyPolicy.expandtabs)([tabsize])      | Return a copy where all tab characters are expanded using spaces.                                           |
| [`find`](#fiftyone.operators.store.KeyPolicy.find)                             | Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].  |
| [`partition`](#fiftyone.operators.store.KeyPolicy.partition)(sep, /)           | Partition the string into three parts using the given separator.                                            |
| [`index`](#fiftyone.operators.store.KeyPolicy.index)                           | Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].  |
| [`ljust`](#fiftyone.operators.store.KeyPolicy.ljust)(width[, fillchar])        | Return a left-justified string of length width.                                                             |
| [`lower`](#fiftyone.operators.store.KeyPolicy.lower)()                         | Return a copy of the string converted to lowercase.                                                         |
| [`lstrip`](#fiftyone.operators.store.KeyPolicy.lstrip)([chars])                | Return a copy of the string with leading whitespace removed.                                                |
| [`rfind`](#fiftyone.operators.store.KeyPolicy.rfind)                           | Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. |
| [`rindex`](#fiftyone.operators.store.KeyPolicy.rindex)                         | Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. |
| [`rjust`](#fiftyone.operators.store.KeyPolicy.rjust)(width[, fillchar])        | Return a right-justified string of length width.                                                            |
| [`rstrip`](#fiftyone.operators.store.KeyPolicy.rstrip)([chars])                | Return a copy of the string with trailing whitespace removed.                                               |
| [`rpartition`](#fiftyone.operators.store.KeyPolicy.rpartition)(sep, /)         | Partition the string into three parts using the given separator.                                            |
| [`splitlines`](#fiftyone.operators.store.KeyPolicy.splitlines)([keepends])     | Return a list of the lines in the string, breaking at line boundaries.                                      |
| [`strip`](#fiftyone.operators.store.KeyPolicy.strip)([chars])                  | Return a copy of the string with leading and trailing whitespace removed.                                   |
| [`swapcase`](#fiftyone.operators.store.KeyPolicy.swapcase)()                   | Convert uppercase characters to lowercase and lowercase characters to uppercase.                            |
| [`translate`](#fiftyone.operators.store.KeyPolicy.translate)(table, /)         | Replace each character in the string using the given translation table.                                     |
| [`upper`](#fiftyone.operators.store.KeyPolicy.upper)()                         | Return a copy of the string converted to uppercase.                                                         |
| [`startswith`](#fiftyone.operators.store.KeyPolicy.startswith)                 | Return True if the string starts with the specified prefix, False otherwise.                                |
| [`endswith`](#fiftyone.operators.store.KeyPolicy.endswith)                     | Return True if the string ends with the specified suffix, False otherwise.                                  |
| [`removeprefix`](#fiftyone.operators.store.KeyPolicy.removeprefix)(prefix, /)  | Return a str with the given prefix string removed if present.                                               |
| [`removesuffix`](#fiftyone.operators.store.KeyPolicy.removesuffix)(suffix, /)  | Return a str with the given suffix string removed if present.                                               |
| [`isascii`](#fiftyone.operators.store.KeyPolicy.isascii)()                     | Return True if all characters in the string are ASCII, False otherwise.                                     |
| [`islower`](#fiftyone.operators.store.KeyPolicy.islower)()                     | Return True if the string is a lowercase string, False otherwise.                                           |
| [`isupper`](#fiftyone.operators.store.KeyPolicy.isupper)()                     | Return True if the string is an uppercase string, False otherwise.                                          |
| [`istitle`](#fiftyone.operators.store.KeyPolicy.istitle)()                     | Return True if the string is a title-cased string, False otherwise.                                         |
| [`isspace`](#fiftyone.operators.store.KeyPolicy.isspace)()                     | Return True if the string is a whitespace string, False otherwise.                                          |
| [`isdecimal`](#fiftyone.operators.store.KeyPolicy.isdecimal)()                 | Return True if the string is a decimal string, False otherwise.                                             |
| [`isdigit`](#fiftyone.operators.store.KeyPolicy.isdigit)()                     | Return True if the string is a digit string, False otherwise.                                               |
| [`isnumeric`](#fiftyone.operators.store.KeyPolicy.isnumeric)()                 | Return True if the string is a numeric string, False otherwise.                                             |
| [`isalpha`](#fiftyone.operators.store.KeyPolicy.isalpha)()                     | Return True if the string is an alphabetic string, False otherwise.                                         |
| [`isalnum`](#fiftyone.operators.store.KeyPolicy.isalnum)()                     | Return True if the string is an alpha-numeric string, False otherwise.                                      |
| [`isidentifier`](#fiftyone.operators.store.KeyPolicy.isidentifier)()           | Return True if the string is a valid Python identifier, False otherwise.                                    |
| [`isprintable`](#fiftyone.operators.store.KeyPolicy.isprintable)()             | Return True if all characters in the string are printable, False otherwise.                                 |
| [`zfill`](#fiftyone.operators.store.KeyPolicy.zfill)(width, /)                 | Pad a numeric string with zeros on the left, to fill a field of the given width.                            |
| [`format`](#fiftyone.operators.store.KeyPolicy.format)(\*args, \*\*kwargs)     | Return a formatted version of the string, using substitutions from args and kwargs.                         |
| [`format_map`](#fiftyone.operators.store.KeyPolicy.format_map)(mapping, /)     | Return a formatted version of the string, using substitutions from mapping.                                 |
| [`maketrans`](#fiftyone.operators.store.KeyPolicy.maketrans)                   | Return a translation table usable for str.translate().                                                      |

#### PERSIST *= 'persist'*

#### EVICT *= 'evict'*

#### encode(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.

#### replace(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.

#### split(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.
>   <br/>
>   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.

#### rsplit(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.
>   <br/>
>   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.

#### join(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’

#### capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the
rest lower case.

#### casefold()

Return a version of the string suitable for caseless comparisons.

#### title()

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.

#### center(width, fillchar=' ',)

Return a centered string of length width.

Padding is done using the specified fill character (default is
a space).

#### count()

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.

#### expandtabs(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()

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.

#### partition(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.

#### index()

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.

#### ljust(width, fillchar=' ',)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is
a space).

#### lower()

Return a copy of the string converted to lowercase.

#### lstrip(chars=None,)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

#### rfind()

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()

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(width, fillchar=' ',)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is
a space).

#### rstrip(chars=None,)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

#### rpartition(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.

#### splitlines(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.

#### strip(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()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

#### translate(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()

Return a copy of the string converted to uppercase.

#### startswith()

Return True if the string starts with the specified prefix, False otherwise.

prefix
: A string or a tuple of strings to try.

start
: Optional start position. Default: start of the string.

end
: Optional stop position. Default: end of the string.

#### endswith()

Return True if the string ends with the specified suffix, False otherwise.

suffix
: A string or a tuple of strings to try.

start
: Optional start position. Default: start of the string.

end
: Optional stop position. Default: end of the string.

#### removeprefix(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(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.

#### isascii()

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.

#### islower()

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.

#### isupper()

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.

#### istitle()

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.

#### isspace()

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.

#### isdecimal()

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()

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.

#### isnumeric()

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.

#### isalpha()

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.

#### isalnum()

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.

#### isidentifier()

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”.

#### isprintable()

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

#### zfill(width,)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

#### format(\*args, \*\*kwargs)

Return a formatted version of the string, using substitutions from args and kwargs.
The substitutions are identified by braces (‘{’ and ‘}’).

#### format_map(mapping,)

Return a formatted version of the string, using substitutions from mapping.
The substitutions are identified by braces (‘{’ and ‘}’).

#### *static* 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.
