52
53
54
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
124
125
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
174
175
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471 | @support_hooks
class S3(FileConnection):
"""S3 file connection. |support_hooks|
Based on `minio-py client <https://pypi.org/project/minio/>`_.
.. warning::
Since onETL v0.7.0 to use S3 connector you should install package as follows:
.. code:: bash
pip install "onetl[s3]"
# or
pip install "onetl[files]"
See :ref:`install-files` installation instruction for more details.
.. versionadded:: 0.5.1
Parameters
----------
host : str
Host of S3 source. For example: ``s3.domain.com``
port : int, optional
Port of S3 source
bucket : str
Bucket name in the S3 file source
access_key : str
Access key (aka user ID) of an account in the S3 service
secret_key : str
Secret key (aka password) of an account in the S3 service
protocol : str, default : ``https``
Connection protocol. Allowed values: ``https`` or ``http``
.. versionchanged:: 0.6.0
Renamed ``secure: bool`` to ``protocol: Literal["https", "http"]``
region : str, optional
Region name of bucket in S3 service.
Optional for some S3 implementations (MinIO, Ozone), but could be mandatory for others.
session_token : str, optional
Session token generated by S3 STS service, if used.
Examples
--------
Create and check S3 connection:
.. code:: python
from onetl.connection import S3
s3 = S3(
host="s3.domain.com",
protocol="http",
bucket="my-bucket",
access_key="ACCESS_KEY",
secret_key="SECRET_KEY",
region="us-east-1",
).check()
"""
host: Host
port: Optional[int] = None
bucket: str
access_key: str
secret_key: SecretStr
protocol: Literal["http", "https"] = "https"
region: Optional[str] = None
session_token: Optional[SecretStr] = None
@root_validator
def _validate_port(cls, values):
if values["port"] is not None:
return values
values["port"] = 443 if values["protocol"] == "https" else 80
return values
@validator("region", always=True)
def _region_is_recommended(cls, value):
if not value:
warnings.warn(
f"It is highly recommended to specify {cls.__name__}(region=...)" " to avoid potential access errors",
category=UserWarning,
stacklevel=3,
)
return value
@property
def instance_url(self) -> str:
return f"{self.__class__.__name__.lower()}://{self.host}:{self.port}/{self.bucket}"
def __str__(self):
return f"{self.__class__.__name__}[{self.host}:{self.port}/{self.bucket}]"
@slot
def create_dir(self, path: os.PathLike | str) -> RemoteDirectory:
# the method is overridden because S3 does not create a directory
# and the method must return the created directory
log.debug("|%s| Creating directory '%s'", self.__class__.__name__, path)
remote_directory = RemotePath(path)
if self.path_exists(remote_directory):
return self.resolve_dir(remote_directory)
self._create_dir(remote_directory)
log.info("|%s| Successfully created directory '%s'", self.__class__.__name__, remote_directory)
return RemoteDirectory(path=remote_directory, stats=RemotePathStat())
@slot
def remove_dir(self, path: os.PathLike | str, recursive: bool = False) -> bool: # noqa: WPS321
# optimize S3 directory recursive removal by using batch object deletion
description = "RECURSIVELY" if recursive else "NON-recursively"
log.debug("|%s| %s removing directory '%s'", self.__class__.__name__, description, path)
remote_dir = RemotePath(path)
directory_info = RemoteDirectory(path=remote_dir, stats=RemotePathStat())
is_empty = True
def _scan_entries_recursive(root: RemotePath) -> Iterable[Object]: # noqa: WPS430
nonlocal is_empty
directory_path_str = self._delete_absolute_path_slash(root) + "/"
entries = self.client.list_objects(
bucket_name=self.bucket,
prefix=directory_path_str,
recursive=True,
)
for entry in entries:
is_empty = False # noqa: WPS442
name = self._extract_name_from_entry(entry)
stat = self._extract_stat_from_entry(root, entry)
if self._is_dir_entry(root, entry):
file = RemoteDirectory(path=root / name, stats=stat)
log.debug("|%s| Directory to remove: %s", self.__class__.__name__, path_repr(file))
yield entry
elif self._is_file_entry(root, entry):
directory = RemoteFile(path=root / name, stats=stat)
log.debug("|%s| File to remove: %s", self.__class__.__name__, directory)
yield entry
else:
yield entry
if not recursive:
# self.list_dir may return large list
# self._scan_entries return an iterator, which have to be iterated at least once
for _entry in self._scan_entries(remote_dir): # noqa: WPS122, WPS328
raise DirectoryNotEmptyError(
"|%s| Cannot delete non-empty directory %s",
self.__class__.__name__,
directory_info,
)
log.debug("|%s| Directory to remove: %s", self.__class__.__name__, directory_info)
self._remove_dir(remote_dir)
log.info("|%s| Successfully removed directory '%s'", self.__class__.__name__, remote_dir)
return is_empty
log.debug("|%s| Directory to remove: %s", self.__class__.__name__, directory_info)
objects_to_delete = (
DeleteObject(obj.object_name) for obj in _scan_entries_recursive(remote_dir) # type: ignore[arg-type]
)
errors = list(
self.client.remove_objects(
bucket_name=self.bucket,
delete_object_list=objects_to_delete,
),
)
if errors:
if log.isEnabledFor(logging.DEBUG):
log.debug(
"|%s| Failed to remove directory %s:\n%s",
self.__class__.__name__,
directory_info,
pformat(errors),
)
raise errors[0]
log.info("|%s| Successfully removed directory '%s'", self.__class__.__name__, remote_dir)
return is_empty
@slot
def path_exists(self, path: os.PathLike | str) -> bool:
remote_path = RemotePath(os.fspath(path))
if self._is_root(remote_path):
return True
remote_path_str = self._delete_absolute_path_slash(remote_path)
for component in self.client.list_objects( # noqa: WPS352
bucket_name=self.bucket,
prefix=remote_path_str,
):
component_path = RemotePath(component.object_name)
component_path_str = self._delete_absolute_path_slash(component_path)
if component_path_str == remote_path_str:
return True
return False
@slot
def resolve_dir(self, path: os.PathLike | str) -> RemoteDirectory:
remote_path = RemotePath("/" + os.fspath(path).lstrip("/"))
if self._is_root(remote_path):
return RemoteDirectory(path=RemotePath("/"), stats=RemotePathStat())
return super().resolve_dir(remote_path)
@slot
def resolve_file(self, path: os.PathLike | str) -> RemoteFile:
remote_path = RemotePath("/" + os.fspath(path).lstrip("/"))
return super().resolve_file(remote_path)
def _get_client(self) -> Minio:
return Minio(
endpoint=f"{self.host}:{self.port}",
access_key=self.access_key,
secret_key=self.secret_key.get_secret_value(),
secure=self.protocol == "https",
session_token=self.session_token.get_secret_value() if self.session_token else None,
region=self.region,
)
def _is_client_closed(self, client: Minio):
return False
def _close_client(self, client: Minio) -> None: # NOSONAR
pass
@staticmethod
def _is_root(path: RemotePath) -> bool:
return path.name == ""
@classmethod
def _delete_absolute_path_slash(cls, path: RemotePath) -> str:
if cls._is_root(path):
return ""
if path.is_absolute():
path = path.relative_to("/")
return os.fspath(path).rstrip("/")
def _download_file(self, remote_file_path: RemotePath, local_file_path: LocalPath) -> None:
path_str = self._delete_absolute_path_slash(remote_file_path)
self.client.fget_object(
bucket_name=self.bucket,
object_name=path_str,
file_path=os.fspath(local_file_path),
)
def _get_stat(self, path: RemotePath) -> RemotePathStat:
if self._is_root(path):
return RemotePathStat()
# for some reason, client.stat_object returns less precise st_mtime than client.list_objects
path_str = self._delete_absolute_path_slash(path)
objects = self.client.list_objects(
bucket_name=self.bucket,
prefix=path_str,
)
for obj in objects:
object_path = RemotePath(obj.object_name)
object_path_str = self._delete_absolute_path_slash(object_path)
if object_path_str == path_str:
return self._extract_stat_from_entry(path.parent, obj)
# for empty directory return empty stat
return RemotePathStat()
def _remove_file(self, remote_file_path: RemotePath) -> None:
path_str = self._delete_absolute_path_slash(remote_file_path)
self.client.remove_object(
bucket_name=self.bucket,
object_name=path_str,
)
def _create_dir(self, path: RemotePath) -> None:
# in s3 dirs do not exist
pass
def _upload_file(self, local_file_path: LocalPath, remote_file_path: RemotePath) -> None:
path_str = self._delete_absolute_path_slash(remote_file_path)
self.client.fput_object(
bucket_name=self.bucket,
object_name=path_str,
file_path=os.fspath(local_file_path),
)
def _rename_file(self, source: RemotePath, target: RemotePath) -> None:
source_str = self._delete_absolute_path_slash(source)
target_str = self._delete_absolute_path_slash(target)
self.client.copy_object(
bucket_name=self.bucket,
object_name=target_str,
source=commonconfig.CopySource(self.bucket, source_str),
)
self._remove_file(source)
def _scan_entries(self, path: RemotePath) -> Iterable[Object]:
if self._is_root(path):
return self.client.list_objects(bucket_name=self.bucket)
directory_path_str = self._delete_absolute_path_slash(path) + "/"
objects = self.client.list_objects(
bucket_name=self.bucket,
prefix=directory_path_str,
)
return (obj for obj in objects if obj.object_name != directory_path_str)
def _extract_name_from_entry(self, entry: Object) -> str:
return RemotePath(entry.object_name).name
def _is_dir_entry(self, top: RemotePath, entry: Object) -> bool:
return entry.is_dir
def _is_file_entry(self, top: RemotePath, entry: Object) -> bool:
return not entry.is_dir
def _extract_stat_from_entry(self, top: RemotePath, entry: Object) -> RemotePathStat:
return RemotePathStat(
st_size=entry.size if entry.size else 0,
st_mtime=entry.last_modified.timestamp() if entry.last_modified else None,
st_uid=entry.owner_name or entry.owner_id,
)
def _remove_dir(self, path: RemotePath) -> None:
directory_path_str = self._delete_absolute_path_slash(path) + "/"
try:
# S3 does not have directories, but some integrations (like Iceberg or Spark 4.0)
# may create empty object with name ending with /, and it will be considered as a directory marker.
# delete such object if it present, and ignore error if it does not
self.client.remove_object(
bucket_name=self.bucket,
object_name=directory_path_str,
)
except S3Error as err:
if err.code == "NoSuchKey":
return
raise
def _read_text(self, path: RemotePath, encoding: str, **kwargs) -> str:
path_str = self._delete_absolute_path_slash(path)
file_handler = self.client.get_object(
bucket_name=self.bucket,
object_name=path_str,
**kwargs,
)
return file_handler.read().decode(encoding)
def _read_bytes(self, path: RemotePath, **kwargs) -> bytes:
path_str = self._delete_absolute_path_slash(path)
file_handler = self.client.get_object(
bucket_name=self.bucket,
object_name=path_str,
**kwargs,
)
return file_handler.read()
def _write_text(self, path: RemotePath, content: str, encoding: str, **kwargs) -> None:
content_bytes = content.encode(encoding)
stream = io.BytesIO(content_bytes)
self.client.put_object(
bucket_name=self.bucket,
data=stream,
object_name=self._delete_absolute_path_slash(path),
length=len(content_bytes),
**kwargs,
)
def _write_bytes(self, path: RemotePath, content: bytes, **kwargs) -> None:
stream = io.BytesIO(content)
self.client.put_object(
bucket_name=self.bucket,
data=stream,
object_name=self._delete_absolute_path_slash(path),
length=len(content),
**kwargs,
)
def _is_dir(self, path: RemotePath) -> bool:
if self._is_root(path):
return True
directory_path_str = self._delete_absolute_path_slash(path) + "/"
try:
next(
self.client.list_objects(
bucket_name=self.bucket,
prefix=directory_path_str,
),
)
return True
except StopIteration:
return False
def _is_file(self, path: RemotePath) -> bool:
path_str = self._delete_absolute_path_slash(path)
try:
self.client.stat_object(
bucket_name=self.bucket,
object_name=path_str,
)
return True
except S3Error as err:
if err.code == "NoSuchKey":
return False
raise
|