Utils in SDK

Overview

Utils provide access to utility functionalities of the SDK.

Class: ImageFile

A class that enables access to files, including authenticated ones.

Attributes

Attribute	Description
`url`	str The URL of the file to be downloaded.
`file_name`	str The name of the file to be saved locally. If not provided by the server or specified by the user, defaults to `output`.

1
import pathlib
2

3
# Select a URL
4
url = "https://storage.googleapis.com/user-storage-interstellar-prod/assets/a0d443a2-41e8-4995-8b54-a5cc4c448227"
5

6
# Define a directory to store the downloaded image
7
output_directory = pathlib.Path("downloaded_images")
8
output_directory.mkdir(exist_ok=True)
9

10
# Instantiate the file
11
image_file = up42.utils.ImageFile(
12
    url=url,
13
    file_name="my_mage_name"  # This will be used as the filename
14
)
15

16
# Download to the desired output directory
17
downloaded_file_path = image_file.download(output_directory=output_directory)
18
print(f"\nDownload finished.")
19
print(f"File was saved to: {downloaded_file_path}")

Methods

download

Downloads the file into the specified folder. Returns pathlib.Path.

Parameter	Description
`output_directory`	Union[str, pathlib.Path] The file output directory.

1
import pathlib
2

3
# Select a URL
4
url = "https://storage.googleapis.com/user-storage-interstellar-prod/assets/a0d443a2-41e8-4995-8b54-a5cc4c448227"
5

6
# Define a directory to store the downloaded image
7
output_directory = pathlib.Path("downloaded_images")
8
output_directory.mkdir(exist_ok=True)
9

10
# Instantiate the file
11
image_file = up42.utils.ImageFile(
12
    url=url,
13
    file_name="my_mage_name"  # This will be used as the filename
14
)
15

16
# Download to the desired output directory
17
downloaded_file_path = image_file.download(output_directory=output_directory)
18
print(f"\nDownload finished.")
19
print(f"File was saved to: {downloaded_file_path}")