-
-
Notifications
You must be signed in to change notification settings - Fork 385
Expand file tree
/
Copy paths3.py
More file actions
1317 lines (1112 loc) · 41.3 KB
/
s3.py
File metadata and controls
1317 lines (1112 loc) · 41.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
#
# Copyright (C) 2019 Radim Rehurek <[email protected]>
#
# This code is distributed under the terms and conditions
# from the MIT License (MIT).
#
"""Implements file-like objects for reading and writing from/to AWS S3."""
import io
import functools
import logging
import time
import warnings
try:
import boto3
import botocore.client
import botocore.exceptions
import urllib3.exceptions
except ImportError:
MISSING_DEPS = True
import smart_open.bytebuffer
import smart_open.concurrency
import smart_open.utils
from smart_open import constants
logger = logging.getLogger(__name__)
DEFAULT_MIN_PART_SIZE = 50 * 1024**2
"""Default minimum part size for S3 multipart uploads"""
MIN_MIN_PART_SIZE = 5 * 1024 ** 2
"""The absolute minimum permitted by Amazon."""
SCHEMES = ("s3", "s3n", 's3u', "s3a")
DEFAULT_PORT = 443
DEFAULT_HOST = 's3.amazonaws.com'
DEFAULT_BUFFER_SIZE = 128 * 1024
URI_EXAMPLES = (
's3://my_bucket/my_key',
's3://my_key:my_secret@my_bucket/my_key',
's3://my_key:my_secret@my_server:my_port@my_bucket/my_key',
)
_UPLOAD_ATTEMPTS = 6
_SLEEP_SECONDS = 10
# Returned by AWS when we try to seek beyond EOF.
_OUT_OF_RANGE = 'InvalidRange'
class _ClientWrapper:
"""Wraps a client to inject the appropriate keyword args into each method call.
The keyword args are a dictionary keyed by the fully qualified method name.
For example, S3.Client.create_multipart_upload.
See https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#client
This wrapper behaves identically to the client otherwise.
"""
def __init__(self, client, kwargs):
self.client = client
self.kwargs = kwargs
def __getattr__(self, method_name):
method = getattr(self.client, method_name)
kwargs = self.kwargs.get('S3.Client.%s' % method_name, {})
return functools.partial(method, **kwargs)
def parse_uri(uri_as_string):
#
# Restrictions on bucket names and labels:
#
# - Bucket names must be at least 3 and no more than 63 characters long.
# - Bucket names must be a series of one or more labels.
# - Adjacent labels are separated by a single period (.).
# - Bucket names can contain lowercase letters, numbers, and hyphens.
# - Each label must start and end with a lowercase letter or a number.
#
# We use the above as a guide only, and do not perform any validation. We
# let boto3 take care of that for us.
#
split_uri = smart_open.utils.safe_urlsplit(uri_as_string)
assert split_uri.scheme in SCHEMES
port = DEFAULT_PORT
host = DEFAULT_HOST
ordinary_calling_format = False
#
# These defaults tell boto3 to look for credentials elsewhere
#
access_id, access_secret = None, None
#
# Common URI template [secret:key@][host[:port]@]bucket/object
#
# The urlparse function doesn't handle the above schema, so we have to do
# it ourselves.
#
uri = split_uri.netloc + split_uri.path
#
# Attempt to extract edge-case authentication details from the URL.
#
# See:
# 1. https://summitroute.com/blog/2018/06/20/aws_security_credential_formats/
# 2. test_s3_uri_with_credentials* in test_smart_open.py for example edge cases
#
if '@' in uri:
maybe_auth, rest = uri.split('@', 1)
if ':' in maybe_auth:
maybe_id, maybe_secret = maybe_auth.split(':', 1)
if '/' not in maybe_id:
access_id, access_secret = maybe_id, maybe_secret
uri = rest
head, key_id = uri.split('/', 1)
if '@' in head and ':' in head:
ordinary_calling_format = True
host_port, bucket_id = head.split('@')
host, port = host_port.split(':', 1)
port = int(port)
elif '@' in head:
ordinary_calling_format = True
host, bucket_id = head.split('@')
else:
bucket_id = head
return dict(
scheme=split_uri.scheme,
bucket_id=bucket_id,
key_id=key_id,
port=port,
host=host,
ordinary_calling_format=ordinary_calling_format,
access_id=access_id,
access_secret=access_secret,
)
def _consolidate_params(uri, transport_params):
"""Consolidates the parsed Uri with the additional parameters.
This is necessary because the user can pass some of the parameters can in
two different ways:
1) Via the URI itself
2) Via the transport parameters
These are not mutually exclusive, but we have to pick one over the other
in a sensible way in order to proceed.
"""
transport_params = dict(transport_params)
def inject(**kwargs):
try:
client_kwargs = transport_params['client_kwargs']
except KeyError:
client_kwargs = transport_params['client_kwargs'] = {}
try:
init_kwargs = client_kwargs['S3.Client']
except KeyError:
init_kwargs = client_kwargs['S3.Client'] = {}
init_kwargs.update(**kwargs)
client = transport_params.get('client')
if client is not None and (uri['access_id'] or uri['access_secret']):
logger.warning(
'ignoring credentials parsed from URL because they conflict with '
'transport_params["client"]. Set transport_params["client"] to None '
'to suppress this warning.'
)
uri.update(access_id=None, access_secret=None)
elif (uri['access_id'] and uri['access_secret']):
inject(
aws_access_key_id=uri['access_id'],
aws_secret_access_key=uri['access_secret'],
)
uri.update(access_id=None, access_secret=None)
if client is not None and uri['host'] != DEFAULT_HOST:
logger.warning(
'ignoring endpoint_url parsed from URL because they conflict with '
'transport_params["client"]. Set transport_params["client"] to None '
'to suppress this warning.'
)
uri.update(host=None)
elif uri['host'] != DEFAULT_HOST:
inject(endpoint_url='https://%(host)s:%(port)d' % uri)
uri.update(host=None)
return uri, transport_params
def open_uri(uri, mode, transport_params):
deprecated = (
'multipart_upload_kwargs',
'object_kwargs',
'resource',
'resource_kwargs',
'session',
'singlepart_upload_kwargs',
)
detected = [k for k in deprecated if k in transport_params]
if detected:
doc_url = (
'https://github.com/RaRe-Technologies/smart_open/blob/develop/'
'MIGRATING_FROM_OLDER_VERSIONS.rst'
)
#
# We use warnings.warn /w UserWarning instead of logger.warn here because
#
# 1) Not everyone has logging enabled; and
# 2) check_kwargs (below) already uses logger.warn with a similar message
#
# https://github.com/RaRe-Technologies/smart_open/issues/614
#
message = (
'ignoring the following deprecated transport parameters: %r. '
'See <%s> for details' % (detected, doc_url)
)
warnings.warn(message, UserWarning)
parsed_uri = parse_uri(uri)
parsed_uri, transport_params = _consolidate_params(parsed_uri, transport_params)
kwargs = smart_open.utils.check_kwargs(open, transport_params)
return open(parsed_uri['bucket_id'], parsed_uri['key_id'], mode, **kwargs)
def open(
bucket_id,
key_id,
mode,
version_id=None,
buffer_size=DEFAULT_BUFFER_SIZE,
min_part_size=DEFAULT_MIN_PART_SIZE,
multipart_upload=True,
defer_seek=False,
client=None,
client_kwargs=None,
writebuffer=None,
):
"""Open an S3 object for reading or writing.
Parameters
----------
bucket_id: str
The name of the bucket this object resides in.
key_id: str
The name of the key within the bucket.
mode: str
The mode for opening the object. Must be either "rb" or "wb".
buffer_size: int, optional
The buffer size to use when performing I/O.
min_part_size: int, optional
The minimum part size for multipart uploads. For writing only.
multipart_upload: bool, optional
Default: `True`
If set to `True`, will use multipart upload for writing to S3. If set
to `False`, S3 upload will use the S3 Single-Part Upload API, which
is more ideal for small file sizes.
For writing only.
version_id: str, optional
Version of the object, used when reading object.
If None, will fetch the most recent version.
defer_seek: boolean, optional
Default: `False`
If set to `True` on a file opened for reading, GetObject will not be
called until the first seek() or read().
Avoids redundant API queries when seeking before reading.
client: object, optional
The S3 client to use when working with boto3.
If you don't specify this, then smart_open will create a new client for you.
client_kwargs: dict, optional
Additional parameters to pass to the relevant functions of the client.
The keys are fully qualified method names, e.g. `S3.Client.create_multipart_upload`.
The values are kwargs to pass to that method each time it is called.
writebuffer: IO[bytes], optional
By default, this module will buffer data in memory using io.BytesIO
when writing. Pass another binary IO instance here to use it instead.
For example, you may pass a file object to buffer to local disk instead
of in RAM. Use this to keep RAM usage low at the expense of additional
disk IO. If you pass in an open file, then you are responsible for
cleaning it up after writing completes.
"""
logger.debug('%r', locals())
if mode not in constants.BINARY_MODES:
raise NotImplementedError('bad mode: %r expected one of %r' % (mode, constants.BINARY_MODES))
if (mode == constants.WRITE_BINARY) and (version_id is not None):
raise ValueError("version_id must be None when writing")
if mode == constants.READ_BINARY:
fileobj = Reader(
bucket_id,
key_id,
version_id=version_id,
buffer_size=buffer_size,
defer_seek=defer_seek,
client=client,
client_kwargs=client_kwargs,
)
elif mode == constants.WRITE_BINARY:
if multipart_upload:
fileobj = MultipartWriter(
bucket_id,
key_id,
min_part_size=min_part_size,
client=client,
client_kwargs=client_kwargs,
writebuffer=writebuffer,
)
else:
fileobj = SinglepartWriter(
bucket_id,
key_id,
client=client,
client_kwargs=client_kwargs,
writebuffer=writebuffer,
)
else:
assert False, 'unexpected mode: %r' % mode
fileobj.name = key_id
return fileobj
def _get(client, bucket, key, version, range_string):
try:
params = dict(Bucket=bucket, Key=key)
if version:
params["VersionId"] = version
if range_string:
params["Range"] = range_string
return client.get_object(**params)
except botocore.client.ClientError as error:
wrapped_error = IOError(
'unable to access bucket: %r key: %r version: %r error: %s' % (
bucket, key, version, error
)
)
wrapped_error.backend_error = error
raise wrapped_error from error
def _unwrap_ioerror(ioe):
"""Given an IOError from _get, return the 'Error' dictionary from boto."""
try:
return ioe.backend_error.response['Error']
except (AttributeError, KeyError):
return None
class _SeekableRawReader(object):
"""Read an S3 object.
This class is internal to the S3 submodule.
"""
def __init__(
self,
client,
bucket,
key,
version_id=None,
):
self._client = client
self._bucket = bucket
self._key = key
self._version_id = version_id
self._content_length = None
self._position = 0
self._body = None
def seek(self, offset, whence=constants.WHENCE_START):
"""Seek to the specified position.
:param int offset: The offset in bytes.
:param int whence: Where the offset is from.
:returns: the position after seeking.
:rtype: int
"""
if whence not in constants.WHENCE_CHOICES:
raise ValueError('invalid whence, expected one of %r' % constants.WHENCE_CHOICES)
#
# Close old body explicitly.
# When first seek() after __init__(), self._body is not exist.
#
if self._body is not None:
self._body.close()
self._body = None
start = None
stop = None
if whence == constants.WHENCE_START:
start = max(0, offset)
elif whence == constants.WHENCE_CURRENT:
start = max(0, offset + self._position)
else:
stop = max(0, -offset)
#
# If we can figure out that we've read past the EOF, then we can save
# an extra API call.
#
if self._content_length is None:
reached_eof = False
elif start is not None and start >= self._content_length:
reached_eof = True
elif stop == 0:
reached_eof = True
else:
reached_eof = False
if reached_eof:
self._body = io.BytesIO()
self._position = self._content_length
else:
self._open_body(start, stop)
return self._position
def _open_body(self, start=None, stop=None):
"""Open a connection to download the specified range of bytes. Store
the open file handle in self._body.
If no range is specified, start defaults to self._position.
start and stop follow the semantics of the http range header,
so a stop without a start will read bytes beginning at stop.
As a side effect, set self._content_length. Set self._position
to self._content_length if start is past end of file.
"""
if start is None and stop is None:
start = self._position
range_string = smart_open.utils.make_range_string(start, stop)
try:
# Optimistically try to fetch the requested content range.
response = _get(
self._client,
self._bucket,
self._key,
self._version_id,
range_string,
)
except IOError as ioe:
# Handle requested content range exceeding content size.
error_response = _unwrap_ioerror(ioe)
if error_response is None or error_response.get('Code') != _OUT_OF_RANGE:
raise
try:
self._position = self._content_length = int(error_response['ActualObjectSize'])
self._body = io.BytesIO()
except KeyError:
response = _get(
self._client,
self._bucket,
self._key,
self._version_id,
None,
)
self._position = self._content_length = response["ContentLength"]
self._body = response["Body"]
else:
#
# Keep track of how many times boto3's built-in retry mechanism
# activated.
#
# https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html#checking-retry-attempts-in-an-aws-service-response
#
logger.debug(
'%s: RetryAttempts: %d',
self,
response['ResponseMetadata']['RetryAttempts'],
)
_, start, stop, length = smart_open.utils.parse_content_range(response['ContentRange'])
self._content_length = length
self._position = start
self._body = response['Body']
def read(self, size=-1):
"""Read from the continuous connection with the remote peer."""
if self._body is None:
# This is necessary for the very first read() after __init__().
self._open_body()
if self._position >= self._content_length:
return b''
#
# Boto3 has built-in error handling and retry mechanisms:
#
# https://boto3.amazonaws.com/v1/documentation/api/latest/guide/error-handling.html
# https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html
#
# Unfortunately, it isn't always enough. There is still a non-zero
# possibility that an exception will slip past these mechanisms and
# terminate the read prematurely. Luckily, at this stage, it's very
# simple to recover from the problem: wait a little bit, reopen the
# HTTP connection and try again. Usually, a single retry attempt is
# enough to recover, but we try multiple times "just in case".
#
for attempt, seconds in enumerate([1, 2, 4, 8, 16], 1):
try:
if size == -1:
binary = self._body.read()
else:
binary = self._body.read(size)
except (
ConnectionResetError,
botocore.exceptions.BotoCoreError,
urllib3.exceptions.HTTPError,
) as err:
logger.warning(
'%s: caught %r while reading %d bytes, sleeping %ds before retry',
self,
err,
size,
seconds,
)
time.sleep(seconds)
self._open_body()
else:
self._position += len(binary)
return binary
raise IOError('%s: failed to read %d bytes after %d attempts' % (self, size, attempt))
def __str__(self):
return 'smart_open.s3._SeekableReader(%r, %r)' % (self._bucket, self._key)
def _initialize_boto3(rw, client, client_kwargs, bucket, key):
"""Created the required objects for accessing S3. Ideally, they have
been already created for us and we can just reuse them."""
if client_kwargs is None:
client_kwargs = {}
if client is None:
init_kwargs = client_kwargs.get('S3.Client', {})
client = boto3.client('s3', **init_kwargs)
assert client
rw._client = _ClientWrapper(client, client_kwargs)
rw._bucket = bucket
rw._key = key
class Reader(io.BufferedIOBase):
"""Reads bytes from S3.
Implements the io.BufferedIOBase interface of the standard library."""
def __init__(
self,
bucket,
key,
version_id=None,
buffer_size=DEFAULT_BUFFER_SIZE,
line_terminator=constants.BINARY_NEWLINE,
defer_seek=False,
client=None,
client_kwargs=None,
):
self._version_id = version_id
self._buffer_size = buffer_size
_initialize_boto3(self, client, client_kwargs, bucket, key)
self._raw_reader = _SeekableRawReader(
self._client,
bucket,
key,
self._version_id,
)
self._current_pos = 0
self._buffer = smart_open.bytebuffer.ByteBuffer(buffer_size)
self._eof = False
self._line_terminator = line_terminator
self._seek_initialized = False
#
# This member is part of the io.BufferedIOBase interface.
#
self.raw = None
if not defer_seek:
self.seek(0)
#
# io.BufferedIOBase methods.
#
def close(self):
"""Flush and close this stream."""
pass
def readable(self):
"""Return True if the stream can be read from."""
return True
def read(self, size=-1):
"""Read up to size bytes from the object and return them."""
if size == 0:
return b''
elif size < 0:
# call read() before setting _current_pos to make sure _content_length is set
out = self._read_from_buffer() + self._raw_reader.read()
self._current_pos = self._raw_reader._content_length
return out
#
# Return unused data first
#
if len(self._buffer) >= size:
return self._read_from_buffer(size)
#
# If the stream is finished, return what we have.
#
if self._eof:
return self._read_from_buffer()
self._fill_buffer(size)
return self._read_from_buffer(size)
def read1(self, size=-1):
"""This is the same as read()."""
return self.read(size=size)
def readinto(self, b):
"""Read up to len(b) bytes into b, and return the number of bytes
read."""
data = self.read(len(b))
if not data:
return 0
b[:len(data)] = data
return len(data)
def readline(self, limit=-1):
"""Read up to and including the next newline. Returns the bytes read."""
if limit != -1:
raise NotImplementedError('limits other than -1 not implemented yet')
#
# A single line may span multiple buffers.
#
line = io.BytesIO()
while not (self._eof and len(self._buffer) == 0):
line_part = self._buffer.readline(self._line_terminator)
line.write(line_part)
self._current_pos += len(line_part)
if line_part.endswith(self._line_terminator):
break
else:
self._fill_buffer()
return line.getvalue()
def seekable(self):
"""If False, seek(), tell() and truncate() will raise IOError.
We offer only seek support, and no truncate support."""
return True
def seek(self, offset, whence=constants.WHENCE_START):
"""Seek to the specified position.
:param int offset: The offset in bytes.
:param int whence: Where the offset is from.
Returns the position after seeking."""
# Convert relative offset to absolute, since self._raw_reader
# doesn't know our current position.
if whence == constants.WHENCE_CURRENT:
whence = constants.WHENCE_START
offset += self._current_pos
if not self._seek_initialized or not (
whence == constants.WHENCE_START and offset == self._current_pos
):
self._current_pos = self._raw_reader.seek(offset, whence)
self._buffer.empty()
self._eof = self._current_pos == self._raw_reader._content_length
self._seek_initialized = True
return self._current_pos
def tell(self):
"""Return the current position within the file."""
return self._current_pos
def truncate(self, size=None):
"""Unsupported."""
raise io.UnsupportedOperation
def detach(self):
"""Unsupported."""
raise io.UnsupportedOperation
def terminate(self):
"""Do nothing."""
pass
def to_boto3(self, resource):
"""Create an **independent** `boto3.s3.Object` instance that points to
the same S3 object as this instance.
Changes to the returned object will not affect the current instance.
"""
assert resource, 'resource must be a boto3.resource instance'
obj = resource.Object(self._bucket, self._key)
if self._version_id is not None:
return obj.Version(self._version_id)
else:
return obj
#
# Internal methods.
#
def _read_from_buffer(self, size=-1):
"""Remove at most size bytes from our buffer and return them."""
size = size if size >= 0 else len(self._buffer)
part = self._buffer.read(size)
self._current_pos += len(part)
return part
def _fill_buffer(self, size=-1):
size = max(size, self._buffer._chunk_size)
while len(self._buffer) < size and not self._eof:
bytes_read = self._buffer.fill(self._raw_reader)
if bytes_read == 0:
logger.debug('%s: reached EOF while filling buffer', self)
self._eof = True
def __str__(self):
return "smart_open.s3.Reader(%r, %r)" % (self._bucket, self._key)
def __repr__(self):
return (
"smart_open.s3.Reader("
"bucket=%r, "
"key=%r, "
"version_id=%r, "
"buffer_size=%r, "
"line_terminator=%r)"
) % (
self._bucket,
self._key,
self._version_id,
self._buffer_size,
self._line_terminator,
)
class MultipartWriter(io.BufferedIOBase):
"""Writes bytes to S3 using the multi part API.
Implements the io.BufferedIOBase interface of the standard library."""
def __init__(
self,
bucket,
key,
min_part_size=DEFAULT_MIN_PART_SIZE,
client=None,
client_kwargs=None,
writebuffer=None,
):
if min_part_size < MIN_MIN_PART_SIZE:
logger.warning("S3 requires minimum part size >= 5MB; \
multipart upload may fail")
self._min_part_size = min_part_size
_initialize_boto3(self, client, client_kwargs, bucket, key)
try:
partial = functools.partial(
self._client.create_multipart_upload,
Bucket=bucket,
Key=key,
)
self._upload_id = _retry_if_failed(partial)['UploadId']
except botocore.client.ClientError as error:
raise ValueError(
'the bucket %r does not exist, or is forbidden for access (%r)' % (
bucket, error
)
) from error
if writebuffer is None:
self._buf = io.BytesIO()
else:
self._buf = writebuffer
self._total_bytes = 0
self._total_parts = 0
self._parts = []
#
# This member is part of the io.BufferedIOBase interface.
#
self.raw = None
def flush(self):
pass
#
# Override some methods from io.IOBase.
#
def close(self):
if self._buf.tell():
self._upload_next_part()
if self._total_bytes and self._upload_id:
partial = functools.partial(
self._client.complete_multipart_upload,
Bucket=self._bucket,
Key=self._key,
UploadId=self._upload_id,
MultipartUpload={'Parts': self._parts},
)
_retry_if_failed(partial)
logger.debug('%s: completed multipart upload', self)
elif self._upload_id:
#
# AWS complains with "The XML you provided was not well-formed or
# did not validate against our published schema" when the input is
# completely empty => abort the upload, no file created.
#
# We work around this by creating an empty file explicitly.
#
assert self._upload_id, "no multipart upload in progress"
self._client.abort_multipart_upload(
Bucket=self._bucket,
Key=self._key,
UploadId=self._upload_id,
)
self._client.put_object(
Bucket=self._bucket,
Key=self._key,
Body=b'',
)
logger.debug('%s: wrote 0 bytes to imitate multipart upload', self)
self._upload_id = None
@property
def closed(self):
return self._upload_id is None
def writable(self):
"""Return True if the stream supports writing."""
return True
def seekable(self):
"""If False, seek(), tell() and truncate() will raise IOError.
We offer only tell support, and no seek or truncate support."""
return True
def seek(self, offset, whence=constants.WHENCE_START):
"""Unsupported."""
raise io.UnsupportedOperation
def truncate(self, size=None):
"""Unsupported."""
raise io.UnsupportedOperation
def tell(self):
"""Return the current stream position."""
return self._total_bytes
#
# io.BufferedIOBase methods.
#
def detach(self):
raise io.UnsupportedOperation("detach() not supported")
def write(self, b):
"""Write the given buffer (bytes, bytearray, memoryview or any buffer
interface implementation) to the S3 file.
For more information about buffers, see https://docs.python.org/3/c-api/buffer.html
There's buffering happening under the covers, so this may not actually
do any HTTP transfer right away."""
length = self._buf.write(b)
self._total_bytes += length
if self._buf.tell() >= self._min_part_size:
self._upload_next_part()
return length
def terminate(self):
"""Cancel the underlying multipart upload."""
assert self._upload_id, "no multipart upload in progress"
self._client.abort_multipart_upload(
Bucket=self._bucket,
Key=self._key,
UploadId=self._upload_id,
)
self._upload_id = None
def to_boto3(self, resource):
"""Create an **independent** `boto3.s3.Object` instance that points to
the same S3 object as this instance.
Changes to the returned object will not affect the current instance.
"""
assert resource, 'resource must be a boto3.resource instance'
return resource.Object(self._bucket, self._key)
#
# Internal methods.
#
def _upload_next_part(self):
part_num = self._total_parts + 1
logger.info(
"%s: uploading part_num: %i, %i bytes (total %.3fGB)",
self,
part_num,
self._buf.tell(),
self._total_bytes / 1024.0 ** 3,
)
self._buf.seek(0)
#
# Network problems in the middle of an upload are particularly
# troublesome. We don't want to abort the entire upload just because
# of a temporary connection problem, so this part needs to be
# especially robust.
#
upload = _retry_if_failed(
functools.partial(
self._client.upload_part,
Bucket=self._bucket,
Key=self._key,
UploadId=self._upload_id,
PartNumber=part_num,
Body=self._buf,
)
)
self._parts.append({'ETag': upload['ETag'], 'PartNumber': part_num})
logger.debug("%s: upload of part_num #%i finished", self, part_num)
self._total_parts += 1
self._buf.seek(0)
self._buf.truncate(0)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
if exc_type is not None:
self.terminate()
else:
self.close()
def __str__(self):
return "smart_open.s3.MultipartWriter(%r, %r)" % (self._bucket, self._key)
def __repr__(self):
return "smart_open.s3.MultipartWriter(bucket=%r, key=%r, min_part_size=%r)" % (
self._bucket,
self._key,
self._min_part_size,
)
class SinglepartWriter(io.BufferedIOBase):
"""Writes bytes to S3 using the single part API.
Implements the io.BufferedIOBase interface of the standard library.
This class buffers all of its input in memory until its `close` method is called. Only then will
the data be written to S3 and the buffer is released."""
def __init__(
self,
bucket,
key,
client=None,
client_kwargs=None,