API Reference¶

Complete reference for all public exports of remote-store.

Symbols below are grouped by role. The import path is remote_store unless a group says otherwise: storage backends live in remote_store.backends, extensions in remote_store.ext, and the entire async surface in remote_store.aio (see the Async section, whose layout mirrors this page).

Feeding this to a coding agent?

llms-api.txt carries this entire surface as one code-shaped skeleton — every signature, type annotation, and docstring (backends, async, and extensions included), with bodies elided — in a single file for an agent's context.

Core¶

Class	Description
Store	Main entry point for all file operations
ProxyStore	Base class for building Store middleware
Registry	Creates and manages backend instances and stores
Backend	Abstract base class for storage backends

Backends¶

Synchronous storage backends (remote_store.backends). Native async backends — including the async-only Microsoft Graph backend — live under Async › Backends.

Class	Description
LocalBackend	Local filesystem storage
MemoryBackend	In-process storage for testing
S3Backend	Amazon S3 and S3-compatible services
S3PyArrowBackend	S3 via PyArrow C++ for higher throughput
AzureBackend	Azure Blob Storage and ADLS Gen2
SFTPBackend	SSH/SFTP server storage via paramiko
ReadOnlyHttpBackend	Read-only access to HTTP/HTTPS URLs
SQLBlobBackend	SQL database blob storage via SQLAlchemy
SQLQueryBackend	Read-only SQL query materialization via SQLAlchemy + PyArrow

Async¶

The remote_store.aio namespace — the async counterpart of the core API, laid out to mirror this page. See the async overview for the full sync ↔ async map.

Class	Description
AsyncStore	Async counterpart to `Store` with coroutine methods for all operations
AsyncBackend	Abstract base class for native async backends
SyncBackendAdapter	Wraps any synchronous backend for async use via thread-pool executor
AsyncBackendSyncAdapter	Wraps any `AsyncBackend` as a synchronous `Backend` via a private event loop
AsyncMemoryBackend	In-memory async backend for testing
AsyncAzureBackend	Native async Azure Blob Storage and ADLS Gen2
GraphBackend	Microsoft Graph backend (OneDrive, SharePoint, Teams files)
AsyncWritableContent	Type alias: `bytes` or `AsyncIterator[bytes]`

Utilities¶

Class	Description
SFTPUtils	Key loading and host-key verification helpers for SFTP
AzureUtils	One-shot HNS detection helper for Azure accounts
GraphAuth	MSAL token provider (client-credentials / device-code) for Graph
GraphUtils	Resolve a Graph `drive_id` from OneDrive / SharePoint / Teams targets

Configuration¶

Class	Description
RegistryConfig	Top-level configuration holding backends and stores
BackendConfig	Configuration for a single backend
StoreProfile	Configuration for a single store
RetryPolicy	Retry policy for backend operations
Secret	Sensitive string wrapper with masked repr
SecretRedactionFilter	Logging filter that redacts secrets
resolve_env	Resolve `${VAR}` placeholders in config dicts

Path & Models¶

Class	Description
RemotePath	Validated, immutable path value object
ResolutionPlan	Frozen introspection result from `resolve()`
ContentDigest	Verified content digest with known algorithm
FileInfo	Metadata for a file (name, size, modified time)
WriteResult	Immutable snapshot of a completed write operation
FolderEntry	Folder identity returned by listing operations
FolderInfo	Aggregated folder metadata (file count, total size); satisfies `PathEntry`
PathEntry	Protocol for uniform listing (name + path)

Capabilities¶

Class	Description
Capability	Enum of backend capabilities
CapabilitySet	Set of capabilities a backend supports

Errors¶

Class	Description
RemoteStoreError	Base exception
NotFound	File or folder not found
AlreadyExists	File already exists (no overwrite)
PermissionDenied	Insufficient permissions
InvalidPath	Path validation failed
CapabilityNotSupported	Backend lacks required capability
BackendUnavailable	Backend could not be reached
DirectoryNotEmpty	Non-recursive delete on non-empty folder
ResourceLocked	Resource locked by another session

Introspection¶

Symbol	Description
info	Runtime introspection of available backends and extensions
InfoResult	TypedDict for the `info()` return value
BackendInfo	TypedDict for a single backend entry in `InfoResult`
ExtensionInfo	TypedDict for a single extension entry in `InfoResult`

Functions¶

Function	Description
register_backend	Register a custom backend type

Extensions¶

Module	Description
ext.arrow	PyArrow `FileSystemHandler` adapter for Store
ext.batch	Batch delete, copy, and exists operations
ext.cache	Store-level caching middleware with TTL
ext.dagster	Dagster IO Manager adapter for Store
ext.glob	Portable glob pattern matching fallback
ext.integrity	Checksum computation and verification helpers
ext.observe	Callback hooks for store operations
ext.otel	OpenTelemetry bridge for ext.observe
ext.partition	Hive-style partition path helpers
ext.pydantic	Pydantic model to RegistryConfig adapter
ext.streams	Composable BinaryIO wrappers for progress and checksums
ext.transfer	Upload, download, and cross-store transfer
ext.write	Write helpers with guaranteed client-side content hashing
aio.ext.write	Async write helpers with guaranteed client-side content hashing
ext.yaml	YAML config loader (PyYAML / ruamel.yaml)