Python SDK
Managing Files
In this section, you will find information and examples on how to manipulate the files associated with your application. Learn how to list, read, create, and delete files using the Client or the Application class for efficient resource administration of your application.
All operations below can be performed by either the Client class, the Application class and the CLI. Below are examples of how to perform each of these tasks using both classes:
Getting a list of files
client.app_files_list
and app.files_list
return a list of FileInfo
objects.
Using Client
Using Application
Using CLI
import squarecloud as square
client = square.Client(api_key='API KEY')
async def example():
files_list = await client.app_files_list(app_id='application_id', path='/')
for file in files_list:
print(file.name) # 'main.py'
print(file.type) # 'directory' or 'file'
print(file.size) # 2140
print(file.lastModified) # 1677112835000
Reading a file
client.read_app_file
and app.read_file
return a BytesIO
object.
Using Client
Using Application
Using CLI
import squarecloud as square
client = square.Client(api_key='API KEY')
async def example():
file_bytes = await client.read_app_file(
app_id='application_id', path='main.py'
)
print(file_bytes) # b'01101000 01101001'
Creating a file
client.create_app_file
and app.create_file
return a Response
object.
Using Client
Using Application
Using CLI
import squarecloud as square
client = square.Client(api_key='API KEY')
async def example():
await client.create_app_file(
app_id='application_id', path='/file.txt', file=square.File('file.txt')
)
Deleting a file
client.delete_app_file
and app.delete_file
return a Response
object.
Using Client
Using Application
Using CLI
import squarecloud as square
client = square.Client(api_key='API KEY')
async def example():
await client.delete_app_file(app_id='application_id', path='/file.txt')
Was this page helpful?