client

LucidLink Python Library - Client.

Top-level entry point for the LucidLink SDK. Each Client is fully independent, so multiple clients can coexist in one process and operate on different workspaces concurrently.

class lucidlink.client.Client(*, storage: StorageConfig | None = None, config: ClientConfig | None = None)

Bases: object

LucidLink SDK client.

Manages the connection to LucidLink for one service-account credential. Each Client instance is fully independent; multiple clients can run side-by-side in the same process and operate on different workspaces concurrently.

Lifecycle:

client = Client()
client.login(credentials)
workspace = client.get_workspace(workspace_id)
# ... use workspace ...
client.close()

Or as a context manager:

with Client() as client:
    client.login(credentials)
    workspace = client.get_workspace(workspace_id)
    # ... use workspace ...

Multi-client (concurrent multi-account):

client_a = Client(storage=StorageConfig(mode=StorageMode.SANDBOXED))
client_b = Client(storage=StorageConfig(mode=StorageMode.SANDBOXED))
client_a.login(creds_a)
client_b.login(creds_b)
# both fully independent, with separate storage

Note

When running multiple concurrent clients, give each one a distinct Storage so their per-filespace state lives under separate roots.

close() → None

Tear down the client: unlink all filespaces and release resources.

Safe to call multiple times. After close(), the client must not be reused — create a new Client for further work.

get_workspace(id: str) → Workspace

Return the workspace with the given id.

Parameters:

id – The workspace id (from list_workspaces()).

Returns:

The live Workspace for filespace operations.

Raises:

• AuthenticationError – If the client is not logged in.

• ValueError – If id does not match any accessible workspace.

property is_logged_in: bool

Whether login() has been called successfully and not yet close()-d.

list_workspaces() → List[WorkspaceInfo]

List workspaces this client’s credentials grant access to.

Returns:

A list of WorkspaceInfo descriptors, one per accessible workspace. Pass an id to get_workspace() to obtain an operable Workspace handle.

Raises:

AuthenticationError – If the client is not logged in.

login(credentials: ServiceAccountCredentials) → None

Authenticate to LucidLink with a service account token.

The token determines which workspace this client operates on.

Parameters:

credentials – Service account credentials.

Raises:

• AuthenticationError – If already logged in with different credentials, or if authentication fails.

• ClientError – If the client cannot be started.

class lucidlink.client.ClientConfig(fs_cache_size_mb: int | None = None)

Bases: object

Typed configuration for Client.

All fields are optional; None means “use the built-in default”.

Example:

client = Client(config=ClientConfig(
    fs_cache_size_mb=2048,
))

fs_cache_size_mb: int | None = None

1024 MB.

Type:

Per-filespace disk cache size in megabytes. Default