AGBCLOUD

Appearance

Delete files ​

What you’ll do ​

Delete a file in an AGB session using session.file_system.delete_file(path) and handle common failure cases safely.

Prerequisites ​

  • AGB_API_KEY
  • A valid image_id that supports filesystem operations (commonly agb-code-space-1)

Quickstart ​

Minimal runnable example: delete an existing file, then clean up.

python
from agb import AGB
from agb.session_params import CreateSessionParams

agb = AGB()
create_result = agb.create(CreateSessionParams(image_id="agb-code-space-1"))
if not create_result.success:
    raise SystemExit(f"Session creation failed: {create_result.error_message}")

session = create_result.session
try:
    # Assume the file already exists in the session.
    # For example, it may have been produced by a previous step in your workflow.
    path = "/tmp/to_delete.txt"

    delete_result = session.file_system.delete_file(path)
    if not delete_result.success:
        raise SystemExit(f"Delete failed: {delete_result.error_message}")
finally:
    agb.delete(session)

Common tasks ​

Delete multiple files under a directory ​

python
entries = session.file_system.list_directory("/tmp").entries
for e in entries:
    if e.is_file and e.name.endswith(".tmp"):
        session.file_system.delete_file(f"/tmp/{e.name}")

Best practices ​

  • Prefer deleting under /tmp unless you know the image’s writable locations.
  • Treat delete as a potentially destructive operation; verify paths and patterns.
  • Always check delete_result.success and log error_message for diagnosis.

Troubleshooting ​

Permission denied ​

  • Likely cause: the target path is not writable for the default user.
  • Fix: delete under writable directories (e.g. /tmp), or use an image/user with the required permissions.

“Path is a directory” ​

  • Likely cause: you passed a directory path to delete_file.
  • Fix: delete a file path; for directories use directory APIs (see directory management docs).