client

Client(*, storage: StorageConfig | None = None)

A connection to LucidLink for one service account.

Creating a client does no network I/O; login() authenticates it, and workspace is then the service account's workspace. Clients are independent of each other: several can run in one process, each logged in with its own service account. Use it as a context manager, or call close() when done.

Clients see each other's changes only eventually. For example, after one client closes a file, another can find it missing, empty or truncated for a few seconds; two clients creating the same new directory conflict, and one of the directories ends up as <name>_conflicted. Filespace.sync() does not by itself make changes visible to another client at once.

Use StorageMode.EPHEMERAL whenever more than one client is involved: it gives each client its own temporary directory. Clients must not share local files, so each StorageMode.PERSISTENT client needs a root_path of its own.

After close() the client is closed for good: login(), workspace and the operations of the objects obtained through it (Workspace, Filespace, FileSystem, FsUtils and the Connect objects) raise ClientClosedError; Filespace.unlink() and leaving a filespace's with block do nothing. The files opened through it were closed by close() and raise the ValueError of a closed file. Create a new Client for further work.

Raises

from lucidlink import Client, ServiceAccountCredentials
with Client() as client:    client.login(ServiceAccountCredentials("sa_live:..."))    with client.workspace.link_filespace("fs-uuid-12345") as filespace:        print(filespace.file_system.read_dir("/"))# Leaving the blocks unlinked the filespace and closed the client

ServiceAccountCredentials(token: str)

The token of a service account, for Client.login().

A service account gives a program access to one workspace and to the filespaces the account has permissions for.

Raises

from lucidlink import Client, ServiceAccountCredentials
client = Client()client.login(ServiceAccountCredentials("sa_live:..."))

Where a Client keeps its local files: the caches and metadata of the filespaces it links.

Pass it as Client(storage=...). Clients must not share local files, so each StorageMode.PERSISTENT client needs its own root_path. With StorageMode.PERSISTENT, the maximum cache sizes given to Workspace.link_filespace() are also kept when the filespace is linked again (see CacheConfig). See "Choose where the client stores data" in the Getting started guide.

Parameters

Raises

from pathlib import Path
from lucidlink import Client, StorageConfig, StorageMode
# Keep the local files in ~/myapp/.lucidstorage = StorageConfig(mode=StorageMode.PERSISTENT, root_path=Path.home() / "myapp")client = Client(storage=storage)

Whether a client's local files are kept after it closes.