ENAC-IT4R Python Files Utils

A Python library of files utils that are commomly used in the EPFL ENAC IT infrastructure:

• S3Service: a service to upload, get, list, check, copy, move and delete files in a S3 file storage.
• FileChecker: a class for checking the size of uploaded files.
• FileNodeBuilder: a class to represent file references from S3 (FileRef class) a tree of file nodes (FileNode class) to facilitate the display of a folder in a web UI.

Usage

To include the files library in your project:

poetry add git+https://github.com/EPFL-ENAC/enacit4r-files#someref

Note: someref should be replaced by the commit hash, tag or branch name you want to use.

S3Service

from enacit4r_files.services.s3 import S3Service, S3Error
from enacit4r_files.models.files import FileRef

s3_service = S3Service(config.S3_ENDPOINT_PROTOCOL + config.S3_ENDPOINT_HOSTNAME,
                     config.S3_ACCESS_KEY_ID,
                     config.S3_SECRET_ACCESS_KEY, 
                     config.S3_REGION,
                     config.S3_BUCKET,
                     config.S3_PATH_PREFIX)

try:
  # do something with s3_service
  pass
except S3Error as e:
    print(e)

Available methods:

• upload_file: Upload a file provided by FastAPI to S3.
• upload_local_file: Upload a local file to S3.
• get_file: Get a file content from S3.
• list_files: List files from a "folder" in S3.
• path_exists: Check if a file exists in S3.
• copy_file: Copy a file in S3.
• move_file: Move a file in S3.
• delete_file: Delete a file in S3.

FileChecker

from enacit4r_files.tools.files import FileChecker

# Example using the default max file size
file_checker = FileChecker()

# Example usage with FastAPI
@router.post("/tmp",
             status_code=200,
             description="Upload any assets to S3 to a temporary folder",
             dependencies=[Depends(file_checker.check_size)])
async def upload_temp_files(
        files: list[UploadFile] = File(description="multiple file upload")):
        pass

FileNodeBuilder

from enacit4r_files.tools.files import FileNodeBuilder
from enacit4r_files.models.files import FileNode

builder = FileNodeBuilder.from_name("root")
# include a list of FileRef from S3
builder.add_files(file_refs)
root = builder.build()