Files

Paths are guest paths unless a parameter names a local one. Transfers are chunked, so size is not capped.

Python programs usually use the high-level API instead: sb.files.

File methods#

Methods of SpacesdClient.

SpacesdClient.upload#

Uploads bytes to path (chunked, resumable, SHA-256 verified).

async def upload(self, path: str, data: bytes, options: Optional[UploadOptions]) -> TransferResult

Returns TransferResult · Async · Raises CuaError

Example

import asyncio
 
import cua
 
async def main():
    guest = await cua.embedded().spacesd(URL, TOKEN)
    sent = await guest.upload("/tmp/note.txt", b"hi from the host", None)
    back = await guest.download("/tmp/note.txt")
    print([sent.size, back])
    # [16, b'hi from the host']
 
asyncio.run(main())

SpacesdClient.upload_file#

Uploads a local file to path.

async def upload_file(self, local_path: str, path: str, options: Optional[UploadOptions]) -> TransferResult

Returns TransferResult · Async · Raises CuaError

SpacesdClient.download#

Downloads path into memory.

async def download(self, path: str) -> bytes

Returns Vec<u8> · Async · Raises CuaError

SpacesdClient.download_file#

Downloads path to a local file.

async def download_file(self, path: str, local_path: str) -> TransferResult

Returns TransferResult · Async · Raises CuaError

SpacesdClient.stat#

Stat.

async def stat(self, path: str) -> FileEntry

Returns FileEntry · Async · Raises CuaError

SpacesdClient.list_dir#

ListDir (depth 1 = direct children).

async def list_dir(self, path: str, depth: int) -> List[FileEntry]

Returns Vec<FileEntry> · Async · Raises CuaError

SpacesdClient.make_dir#

MakeDir (with parents).

async def make_dir(self, path: str) -> FileEntry

Returns FileEntry · Async · Raises CuaError

SpacesdClient.remove#

Remove.

async def remove(self, path: str, recursive: bool) -> None

Async · Raises CuaError

FileEntry record#

A file or directory in the guest.

Returned by SpacesdClient.list_dir, SpacesdClient.make_dir, SpacesdClient.stat.

TransferResult record#

Result of an upload or download.

Returned by SpacesdClient.download_file, SpacesdClient.upload, SpacesdClient.upload_file.

UploadOptions record#

Upload options.