aidevelopementtoolkit.logging_utils.boto3_utils
create_s3_client()
Create a boto3 S3 client from environment variables.
Reads the following environment variables:
DATASET_S3_ENDPOINT_URL- custom endpoint URL.DATASET_S3_AWS_ACCESS_KEY_ID- access key ID.DATASET_S3_AWS_SECRET_ACCESS_KEY- secret access key.
| Returns: |
|
|---|
Examples:
>>> import os
>>> os.environ["DATASET_S3_ENDPOINT_URL"] = "http://localhost:9000"
>>> os.environ["DATASET_S3_AWS_ACCESS_KEY_ID"] = "minioadmin"
>>> os.environ["DATASET_S3_AWS_SECRET_ACCESS_KEY"] = "minioadmin"
>>> client = create_s3_client()
Source code in aidevelopementtoolkit/logging_utils/boto3_utils.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
read_s3_object(client, bucket: str, key: str, process_rank: int = 0) -> bytes
Download an S3 object and return its content as bytes.
Displays a tqdm progress bar during the download, using the
object's Content-Length as the total when available.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Examples:
>>> client = create_s3_client()
>>> data = read_s3_object(client, bucket="my-bucket", key="data/file.npy")
Source code in aidevelopementtoolkit/logging_utils/boto3_utils.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | |
write_s3_object(client, bucket: str, key: str, data: bytes) -> None
Upload bytes to an S3 object.
Displays a tqdm progress bar during the upload.
| Parameters: |
|
|---|
Examples:
>>> client = create_s3_client()
>>> write_s3_object(client, bucket="my-bucket", key="data/file.npy", data=b"...")
Source code in aidevelopementtoolkit/logging_utils/boto3_utils.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | |
parse_s3_path(path: str) -> Tuple[str, str]
Parse an S3 path into bucket and key.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in aidevelopementtoolkit/logging_utils/boto3_utils.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | |