Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel
Resources  
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Explore Pricing
Product  
Data Engine LLMs Platform Enterprise
Connect to Dagshub Discord channel
Register
Login

Deci-AI
/
super-gradients
connected to https://github.com/Deci-AI/super-gradients.git

Watch 4
Issues 62 Pull Requests 44 Discussions 0

#561 Feature/sg 193 extend output formator

Merged
Ghost merged 1 commits into Deci-AI:master from deci-ai:feature/SG-193-extend_detection_target_transform
Conversation 0 Files changed 27 Commits 1
File Compare
super-gradients
/
docs
/
_modules
/
super_gradients
/
common
/
data_connection
/
s3_connector.html
View left file View right file
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 
  1. <!DOCTYPE html>
    2. 

  2. <html class="writer-html5" lang="en" >
    3. 

  3. <head>
    4. 

  4.   <meta charset="utf-8" />
    5. 

  5.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    6. 

  6.   <title>super_gradients.common.data_connection.s3_connector &mdash; SuperGradients 3.0.3 documentation</title>
    7. 

  7.       <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
    8. 

  8.       <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
    9. 

  9.       <link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
    10. 

  10.       <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
    11. 

  11.   <!--[if lt IE 9]>
    12. 

  12.     <script src="../../../../_static/js/html5shiv.min.js"></script>
    13. 

  13.   <![endif]-->
    14. 

  14.   
    15. 

  15.         <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
    16. 

  16.         <script src="../../../../_static/jquery.js"></script>
    17. 

  17.         <script src="../../../../_static/underscore.js"></script>
    18. 

  18.         <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
    19. 

  19.         <script src="../../../../_static/doctools.js"></script>
    20. 

  20.         <script src="../../../../_static/sphinx_highlight.js"></script>
    21. 

  21.     <script src="../../../../_static/js/theme.js"></script>
    22. 

  22.     <link rel="index" title="Index" href="../../../../genindex.html" />
    23. 

  23.     <link rel="search" title="Search" href="../../../../search.html" /> 
    24. 

  24. </head>
    25. 

  25. 

  26. <body class="wy-body-for-nav"> 
    27. 

  27.   <div class="wy-grid-for-nav">
    28. 

  28.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    29. 

  29.       <div class="wy-side-scroll">
    30. 

  30.         <div class="wy-side-nav-search" >
    31. 

  31.             <a href="../../../../index.html" class="icon icon-home"> SuperGradients
    32. 

  32.           </a>
    33. 

  33. <div role="search">
    34. 

  34.   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
    35. 

  35.     <input type="text" name="q" placeholder="Search docs" />
    36. 

  36.     <input type="hidden" name="check_keywords" value="yes" />
    37. 

  37.     <input type="hidden" name="area" value="default" />
    38. 

  38.   </form>
    39. 

  39. </div>
    40. 

  40.         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    41. 

  41.               <p class="caption" role="heading"><span class="caption-text">Welcome To SuperGradients</span></p>
    42. 

  42. <ul>
    43. 

  43. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html">Version 3 is out! Notebooks have been updated!</a></li>
    44. 

  44. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#build-with-supergradients">Build with SuperGradients</a></li>
    45. 

  45. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#quick-installation">Quick Installation</a></li>
    46. 

  46. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#what-s-new">What’s New</a></li>
    47. 

  47. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#coming-soon">Coming soon</a></li>
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#table-of-content">Table of Content</a></li>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#getting-started">Getting Started</a></li>
    50. 

  50. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#advanced-features">Advanced Features</a></li>
    51. 

  51. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#installation-methods">Installation Methods</a></li>
    52. 

  52. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#implemented-model-architectures">Implemented Model Architectures</a></li>
    53. 

  53. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#documentation">Documentation</a></li>
    54. 

  54. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#contributing">Contributing</a></li>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#citation">Citation</a></li>
    56. 

  56. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#community">Community</a></li>
    57. 

  57. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#license">License</a></li>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../../../../welcome.html#deci-platform">Deci Platform</a></li>
    59. 

  59. </ul>
    60. 

  60. <p class="caption" role="heading"><span class="caption-text">Technical Documentation</span></p>
    61. 

  61. <ul>
    62. 

  62. <li class="toctree-l1"><a class="reference internal" href="../../../../super_gradients.common.html">Common package</a></li>
    63. 

  63. <li class="toctree-l1"><a class="reference internal" href="../../../../super_gradients.training.html">Training package</a></li>
    64. 

  64. </ul>
    65. 

  65. 

  66.         </div>
    67. 

  67.       </div>
    68. 

  68.     </nav>
    69. 

  69. 

  70.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
    71. 

  71.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    72. 

  72.           <a href="../../../../index.html">SuperGradients</a>
    73. 

  73.       </nav>
    74. 

  74. 

  75.       <div class="wy-nav-content">
    76. 

  76.         <div class="rst-content">
    77. 

  77.           <div role="navigation" aria-label="Page navigation">
    78. 

  78.   <ul class="wy-breadcrumbs">
    79. 

  79.       <li><a href="../../../../index.html" class="icon icon-home"></a> &raquo;</li>
    80. 

  80.           <li><a href="../../../index.html">Module code</a> &raquo;</li>
    81. 

  81.       <li>super_gradients.common.data_connection.s3_connector</li>
    82. 

  82.       <li class="wy-breadcrumbs-aside">
    83. 

  83.       </li>
    84. 

  84.   </ul>
    85. 

  85.   <hr/>
    86. 

  86. </div>
    87. 

  87.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    88. 

  88.            <div itemprop="articleBody">
    89. 

  89.              
    90. 

  90.   <h1>Source code for super_gradients.common.data_connection.s3_connector</h1><div class="highlight"><pre>
    91. 

  91. <span></span><span class="kn">import</span> <span class="nn">os</span>
    92. 

  92. <span class="kn">import</span> <span class="nn">sys</span>
    93. 

  93. <span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">StringIO</span><span class="p">,</span> <span class="n">BytesIO</span>
    94. 

  94. <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
    95. 

  95. 

  96. <span class="kn">import</span> <span class="nn">botocore</span>
    97. 

  97. 

  98. <span class="kn">from</span> <span class="nn">super_gradients.common</span> <span class="kn">import</span> <span class="n">AWSConnector</span>
    99. 

  99. <span class="kn">from</span> <span class="nn">super_gradients.common</span> <span class="kn">import</span> <span class="n">explicit_params_validation</span>
    100. 

  100. <span class="kn">from</span> <span class="nn">super_gradients.common.abstractions.abstract_logger</span> <span class="kn">import</span> <span class="n">ILogger</span>
    101. 

  101. 

  102. 

  103. <span class="k">class</span> <span class="nc">KeyNotExistInBucketError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    104. 

  104.     <span class="k">pass</span>
    105. 

  105. 

  106. 

  107. <div class="viewcode-block" id="S3Connector"><a class="viewcode-back" href="../../../../super_gradients.common.html#super_gradients.common.S3Connector">[docs]</a><span class="k">class</span> <span class="nc">S3Connector</span><span class="p">(</span><span class="n">ILogger</span><span class="p">):</span>
    108. 

  108.     <span class="sd">&quot;&quot;&quot;</span>
    109. 

  109. <span class="sd">    S3Connector - S3 Connection Manager</span>
    110. 

  110. <span class="sd">    &quot;&quot;&quot;</span>
    111. 

  111. 

  112.     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    113. 

  113.         <span class="sd">&quot;&quot;&quot;</span>
    114. 

  114. <span class="sd">        :param s3_bucket:</span>
    115. 

  115. <span class="sd">        &quot;&quot;&quot;</span>
    116. 

  116.         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
    117. 

  117.         <span class="bp">self</span><span class="o">.</span><span class="n">env</span> <span class="o">=</span> <span class="n">env</span>
    118. 

  118.         <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span> <span class="o">=</span> <span class="n">bucket_name</span>
    119. 

  119.         <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span> <span class="o">=</span> <span class="n">AWSConnector</span><span class="o">.</span><span class="n">get_aws_client_for_service_name</span><span class="p">(</span><span class="n">profile_name</span><span class="o">=</span><span class="n">env</span><span class="p">,</span> <span class="n">service_name</span><span class="o">=</span><span class="s1">&#39;s3&#39;</span><span class="p">)</span>
    120. 

  120.         <span class="bp">self</span><span class="o">.</span><span class="n">s3_resource</span> <span class="o">=</span> <span class="n">AWSConnector</span><span class="o">.</span><span class="n">get_aws_resource_for_service_name</span><span class="p">(</span><span class="n">profile_name</span><span class="o">=</span><span class="n">env</span><span class="p">,</span> <span class="n">service_name</span><span class="o">=</span><span class="s1">&#39;s3&#39;</span><span class="p">)</span>
    121. 

  121. 

  122.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    123. 

  123.     <span class="k">def</span> <span class="nf">check_key_exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s3_key_to_check</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    124. 

  124.         <span class="sd">&quot;&quot;&quot;</span>
    125. 

  125. <span class="sd">        check_key_exists - Checks if an S3 key exists</span>
    126. 

  126. <span class="sd">        :param s3_key_to_check:</span>
    127. 

  127. <span class="sd">        :return:</span>
    128. 

  128. <span class="sd">        &quot;&quot;&quot;</span>
    129. 

  129.         <span class="k">try</span><span class="p">:</span>
    130. 

  130.             <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">head_object</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">s3_key_to_check</span><span class="p">)</span>
    131. 

  131.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    132. 

  132.             <span class="k">if</span> <span class="n">ex</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s1">&#39;Error&#39;</span><span class="p">][</span><span class="s1">&#39;Code&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;404&quot;</span><span class="p">:</span>
    133. 

  133.                 <span class="k">return</span> <span class="kc">False</span>
    134. 

  134.             <span class="k">else</span><span class="p">:</span>
    135. 

  135.                 <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
    136. 

  136.                     <span class="s1">&#39;Failed to check key: &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">s3_key_to_check</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39; existence in bucket&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">))</span>
    137. 

  137.                 <span class="k">return</span> <span class="kc">None</span>
    138. 

  138.         <span class="k">else</span><span class="p">:</span>
    139. 

  139.             <span class="k">return</span> <span class="kc">True</span>
    140. 

  140. 

  141.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    142. 

  142.     <span class="k">def</span> <span class="nf">get_object_by_etag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket_relative_file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">etag</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">object</span><span class="p">:</span>
    143. 

  143.         <span class="sd">&quot;&quot;&quot;</span>
    144. 

  144. <span class="sd">        get_object_by_etag - Gets S3 object by it&#39;s ETag heder if it. exists</span>
    145. 

  145. <span class="sd">        :param bucket_relative_file_name: The name of the file in the bucket (relative)</span>
    146. 

  146. <span class="sd">        :param etag: The ETag of the object in S3</span>
    147. 

  147. <span class="sd">        :return:</span>
    148. 

  148. <span class="sd">        &quot;&quot;&quot;</span>
    149. 

  149.         <span class="k">try</span><span class="p">:</span>
    150. 

  150.             <span class="n">etag</span> <span class="o">=</span> <span class="n">etag</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">&#39;&quot;&#39;</span><span class="p">)</span>
    151. 

  151.             <span class="n">s3_object</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">bucket_relative_file_name</span><span class="p">,</span> <span class="n">IfMatch</span><span class="o">=</span><span class="n">etag</span><span class="p">)</span>
    152. 

  152.             <span class="k">return</span> <span class="n">s3_object</span>
    153. 

  153.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    154. 

  154.             <span class="k">if</span> <span class="n">ex</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s1">&#39;Error&#39;</span><span class="p">][</span><span class="s1">&#39;Code&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;404&quot;</span><span class="p">:</span>
    155. 

  155.                 <span class="k">return</span> <span class="kc">False</span>
    156. 

  156.             <span class="k">else</span><span class="p">:</span>
    157. 

  157.                 <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
    158. 

  158.                     <span class="s1">&#39;Failed to check ETag: &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">etag</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39; existence in bucket &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">))</span>
    159. 

  159.         <span class="k">return</span>
    160. 

  160. 

  161.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    162. 

  162.     <span class="k">def</span> <span class="nf">create_bucket</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    163. 

  163.         <span class="sd">&quot;&quot;&quot;</span>
    164. 

  164. <span class="sd">        Creates a bucket with the initialized bucket name.</span>
    165. 

  165. <span class="sd">        :return: The new bucket response</span>
    166. 

  166. <span class="sd">        :raises ClientError: If the creation failed for any reason.</span>
    167. 

  167. <span class="sd">        &quot;&quot;&quot;</span>
    168. 

  168.         <span class="k">try</span><span class="p">:</span>
    169. 

  169.             <span class="c1"># TODO: Change bucket_owner_arn to the company&#39;s proper IAM Role</span>
    170. 

  170.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Creating Bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    171. 

  171.             <span class="n">create_bucket_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">create_bucket</span><span class="p">(</span>
    172. 

  172.                 <span class="n">ACL</span><span class="o">=</span><span class="s1">&#39;private&#39;</span><span class="p">,</span>
    173. 

  173.                 <span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span>
    174. 

  174.             <span class="p">)</span>
    175. 

  175.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Successfully created bucket: </span><span class="si">{</span><span class="n">create_bucket_response</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
    176. 

  176. 

  177.             <span class="c1"># Changing the bucket public access block to be private (disable public access)</span>
    178. 

  178.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Disabling public access to the bucket...&#39;</span><span class="p">)</span>
    179. 

  179.             <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">put_public_access_block</span><span class="p">(</span>
    180. 

  180.                 <span class="n">PublicAccessBlockConfiguration</span><span class="o">=</span><span class="p">{</span>
    181. 

  181.                     <span class="s1">&#39;BlockPublicAcls&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    182. 

  182.                     <span class="s1">&#39;IgnorePublicAcls&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    183. 

  183.                     <span class="s1">&#39;BlockPublicPolicy&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    184. 

  184.                     <span class="s1">&#39;RestrictPublicBuckets&#39;</span><span class="p">:</span> <span class="kc">True</span>
    185. 

  185.                 <span class="p">},</span>
    186. 

  186.                 <span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span>
    187. 

  187.             <span class="p">)</span>
    188. 

  188.             <span class="k">return</span> <span class="n">create_bucket_response</span>
    189. 

  189.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
    190. 

  190.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">fatal</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Failed to create bucket &quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="si">}</span><span class="s1">&quot;: </span><span class="si">{</span><span class="n">err</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
    191. 

  191.             <span class="k">raise</span>
    192. 

  192. 

  193.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    194. 

  194.     <span class="k">def</span> <span class="nf">delete_bucket</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    195. 

  195.         <span class="sd">&quot;&quot;&quot;</span>
    196. 

  196. <span class="sd">        Deletes a bucket with the initialized bucket name.</span>
    197. 

  197. <span class="sd">        :return: True if succeeded.</span>
    198. 

  198. <span class="sd">        :raises ClientError: If the creation failed for any reason.</span>
    199. 

  199. <span class="sd">        &quot;&quot;&quot;</span>
    200. 

  200.         <span class="k">try</span><span class="p">:</span>
    201. 

  201.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Deleting Bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span> <span class="o">+</span> <span class="s1">&#39; from S3&#39;</span><span class="p">)</span>
    202. 

  202.             <span class="n">bucket</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_resource</span><span class="o">.</span><span class="n">Bucket</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    203. 

  203.             <span class="n">bucket</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">all</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
    204. 

  204.             <span class="n">bucket</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
    205. 

  205.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Successfully Deleted Bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span> <span class="o">+</span> <span class="s1">&#39; from S3&#39;</span><span class="p">)</span>
    206. 

  206.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    207. 

  207.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">fatal</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Failed to delete bucket </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="si">}</span><span class="s1">: </span><span class="si">{</span><span class="n">ex</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
    208. 

  208.             <span class="k">raise</span> <span class="n">ex</span>
    209. 

  209.         <span class="k">return</span> <span class="kc">True</span>
    210. 

  210. 

  211.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    212. 

  212.     <span class="k">def</span> <span class="nf">get_object_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s3_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    213. 

  213.         <span class="k">try</span><span class="p">:</span>
    214. 

  214.             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">head_object</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">s3_key</span><span class="p">)</span>
    215. 

  215.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    216. 

  216.             <span class="k">if</span> <span class="n">ex</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s1">&#39;Error&#39;</span><span class="p">][</span><span class="s1">&#39;Code&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;404&#39;</span><span class="p">:</span>
    217. 

  217.                 <span class="n">msg</span> <span class="o">=</span> <span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Key does not exist in bucket)&#39;</span>
    218. 

  218.                 <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    219. 

  219.                 <span class="k">raise</span> <span class="n">KeyNotExistInBucketError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
    220. 

  220.             <span class="k">raise</span> <span class="n">ex</span>
    221. 

  221. 

  222.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    223. 

  223.     <span class="k">def</span> <span class="nf">delete_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s3_key_to_delete</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    224. 

  224.         <span class="sd">&quot;&quot;&quot;</span>
    225. 

  225. <span class="sd">        delete_key - Deletes a Key from an S3 Bucket</span>
    226. 

  226. <span class="sd">            :param s3_key_to_delete:</span>
    227. 

  227. <span class="sd">            :return: True/False if the operation succeeded/failed</span>
    228. 

  228. <span class="sd">        &quot;&quot;&quot;</span>
    229. 

  229.         <span class="k">try</span><span class="p">:</span>
    230. 

  230.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Deleting Key: &#39;</span> <span class="o">+</span> <span class="n">s3_key_to_delete</span> <span class="o">+</span> <span class="s1">&#39; from S3 bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    231. 

  231.             <span class="n">obj_status</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">head_object</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">s3_key_to_delete</span><span class="p">)</span>
    232. 

  232.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    233. 

  233.             <span class="k">if</span> <span class="n">ex</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s1">&#39;Error&#39;</span><span class="p">][</span><span class="s1">&#39;Code&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;404&#39;</span><span class="p">:</span>
    234. 

  234.                 <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Key does not exist in bucket)&#39;</span><span class="p">)</span>
    235. 

  235.             <span class="k">return</span> <span class="kc">False</span>
    236. 

  236. 

  237.         <span class="k">if</span> <span class="n">obj_status</span><span class="p">[</span><span class="s1">&#39;ContentLength&#39;</span><span class="p">]:</span>
    238. 

  238.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
    239. 

  239.                 <span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Deleting file s3://&#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span> <span class="o">+</span> <span class="n">s3_key_to_delete</span><span class="p">)</span>
    240. 

  240.             <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">delete_object</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">s3_key_to_delete</span><span class="p">)</span>
    241. 

  241. 

  242.         <span class="k">return</span> <span class="kc">True</span>
    243. 

  243. 

  244.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    245. 

  245.     <span class="k">def</span> <span class="nf">upload_file_from_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    246. 

  246.         <span class="sd">&quot;&quot;&quot;</span>
    247. 

  247. <span class="sd">        upload_file - Uploads a file to S3 via boto3 interface</span>
    248. 

  248. <span class="sd">                      *Please Notice* - This method is for working with files, not objects</span>
    249. 

  249. <span class="sd">            :param key: The key (filename) to create in the S3 bucket</span>
    250. 

  250. <span class="sd">            :param filen: File to upload</span>
    251. 

  251. <span class="sd">            :return True/False if the operation succeeded/failed</span>
    252. 

  252. <span class="sd">        &quot;&quot;&quot;</span>
    253. 

  253.         <span class="k">try</span><span class="p">:</span>
    254. 

  254.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Uploading Key: &#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39; to S3 bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    255. 

  255.             <span class="n">buffer</span> <span class="o">=</span> <span class="n">BytesIO</span><span class="p">(</span><span class="n">file</span><span class="p">)</span>
    256. 

  256.             <span class="bp">self</span><span class="o">.</span><span class="n">upload_buffer</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">buffer</span><span class="p">)</span>
    257. 

  257.             <span class="k">return</span> <span class="kc">True</span>
    258. 

  258.         <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    259. 

  259.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
    260. 

  260.                 <span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Caught Exception while trying to upload file &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span>
    261. 

  261.                     <span class="n">key</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;to S3&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
    262. 

  262.             <span class="k">return</span> <span class="kc">False</span>
    263. 

  263. 

  264.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    265. 

  265.     <span class="k">def</span> <span class="nf">upload_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename_to_upload</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    266. 

  266.         <span class="sd">&quot;&quot;&quot;</span>
    267. 

  267. <span class="sd">        upload_file - Uploads a file to S3 via boto3 interface</span>
    268. 

  268. <span class="sd">                      *Please Notice* - This method is for working with files, not objects</span>
    269. 

  269. <span class="sd">            :param key:                The key (filename) to create in the S3 bucket</span>
    270. 

  270. <span class="sd">            :param filename_to_upload: Filename of the file to upload</span>
    271. 

  271. <span class="sd">            :return True/False if the operation succeeded/failed</span>
    272. 

  272. <span class="sd">        &quot;&quot;&quot;</span>
    273. 

  273.         <span class="k">try</span><span class="p">:</span>
    274. 

  274.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Uploading Key: &#39;</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">&#39; to S3 bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    275. 

  275. 

  276.             <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">upload_file</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Filename</span><span class="o">=</span><span class="n">filename_to_upload</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">key</span><span class="p">)</span>
    277. 

  277.             <span class="k">return</span> <span class="kc">True</span>
    278. 

  278. 

  279.         <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    280. 

  280.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
    281. 

  281.                 <span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Caught Exception while trying to upload file &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span>
    282. 

  282.                     <span class="n">filename_to_upload</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39;to S3&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
    283. 

  283.             <span class="k">return</span> <span class="kc">False</span>
    284. 

  284. 

  285.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    286. 

  286.     <span class="k">def</span> <span class="nf">download_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">key_to_download</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    287. 

  287.         <span class="sd">&quot;&quot;&quot;</span>
    288. 

  288. <span class="sd">        download_file - Downloads a key from S3 using boto3 to the provided filename</span>
    289. 

  289. <span class="sd">                        Please Notice* - This method is for working with files, not objects</span>
    290. 

  290. <span class="sd">            :param key_to_download:    The key (filename) to download from the S3 bucket</span>
    291. 

  291. <span class="sd">            :param target_path:           Filename of the file to download the content of the key to</span>
    292. 

  292. <span class="sd">            :return:                   True/False if the operation succeeded/failed</span>
    293. 

  293. <span class="sd">        &quot;&quot;&quot;</span>
    294. 

  294.         <span class="k">try</span><span class="p">:</span>
    295. 

  295.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">&#39;Uploading Key: &#39;</span> <span class="o">+</span> <span class="n">key_to_download</span> <span class="o">+</span> <span class="s1">&#39; from S3 bucket: &#39;</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    296. 

  296.             <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">download_file</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Filename</span><span class="o">=</span><span class="n">target_path</span><span class="p">,</span> <span class="n">Key</span><span class="o">=</span><span class="n">key_to_download</span><span class="p">)</span>
    297. 

  297.         <span class="k">except</span> <span class="n">botocore</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ClientError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    298. 

  298.             <span class="k">if</span> <span class="n">ex</span><span class="o">.</span><span class="n">response</span><span class="p">[</span><span class="s1">&#39;Error&#39;</span><span class="p">][</span><span class="s1">&#39;Code&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;404&#39;</span><span class="p">:</span>
    299. 

  299.                 <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Key does exist in bucket)&#39;</span><span class="p">)</span>
    300. 

  300.             <span class="k">else</span><span class="p">:</span>
    301. 

  301.                 <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
    302. 

  302.                     <span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Caught Exception while trying to download key &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span>
    303. 

  303.                         <span class="n">key_to_download</span><span class="p">)</span> <span class="o">+</span> <span class="s1">&#39; from S3 &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">))</span>
    304. 

  304.             <span class="k">return</span> <span class="kc">False</span>
    305. 

  305. 

  306.         <span class="k">return</span> <span class="kc">True</span>
    307. 

  307. 

  308.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    309. 

  309.     <span class="k">def</span> <span class="nf">download_keys_by_prefix</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s3_bucket_path_prefix</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">local_download_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
    310. 

  310.                                 <span class="n">s3_file_path_prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">):</span>
    311. 

  311.         <span class="sd">&quot;&quot;&quot;</span>
    312. 

  312. <span class="sd">        download_keys_by_prefix - Download all of the keys who match the provided in-bucket path prefix and file prefix</span>
    313. 

  313. <span class="sd">            :param s3_bucket_path_prefix:   The S3 &quot;folder&quot; to download from</span>
    314. 

  314. <span class="sd">            :param local_download_dir:      The local directory to download the files to</span>
    315. 

  315. <span class="sd">            :param s3_file_path_prefix:     The specific prefix of the files we want to download</span>
    316. 

  316. <span class="sd">        :return:</span>
    317. 

  317. <span class="sd">        &quot;&quot;&quot;</span>
    318. 

  318.         <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">local_download_dir</span><span class="p">):</span>
    319. 

  319.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Provided directory does not exist&#39;</span><span class="p">)</span>
    320. 

  320. 

  321.         <span class="n">paginator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">get_paginator</span><span class="p">(</span><span class="s1">&#39;list_objects&#39;</span><span class="p">)</span>
    322. 

  322.         <span class="n">prefix</span> <span class="o">=</span> <span class="n">s3_bucket_path_prefix</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">s3_file_path_prefix</span> <span class="k">else</span> <span class="n">s3_bucket_path_prefix</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">s3_file_path_prefix</span>
    323. 

  323.         <span class="n">page_iterator</span> <span class="o">=</span> <span class="n">paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Prefix</span><span class="o">=</span><span class="n">prefix</span><span class="p">)</span>
    324. 

  324. 

  325.         <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">page_iterator</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">&#39;Contents&#39;</span><span class="p">):</span>
    326. 

  326.             <span class="k">if</span> <span class="n">item</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    327. 

  327.                 <span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;Key&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="n">s3_bucket_path_prefix</span><span class="p">:</span>
    328. 

  328.                     <span class="k">continue</span>
    329. 

  329.             <span class="n">key_to_download</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;Key&#39;</span><span class="p">]</span>
    330. 

  330.             <span class="n">local_filename</span> <span class="o">=</span> <span class="n">key_to_download</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    331. 

  331.             <span class="bp">self</span><span class="o">.</span><span class="n">download_key</span><span class="p">(</span><span class="n">target_path</span><span class="o">=</span><span class="n">local_download_dir</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">local_filename</span><span class="p">,</span>
    332. 

  332.                               <span class="n">key_to_download</span><span class="o">=</span><span class="n">key_to_download</span><span class="p">)</span>
    333. 

  333. 

  334.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    335. 

  335.     <span class="k">def</span> <span class="nf">download_file_by_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s3_file_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">local_download_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    336. 

  336.         <span class="sd">&quot;&quot;&quot;</span>
    337. 

  337. <span class="sd">        :param s3_file_path: str - path ot s3 file e.g./ &quot;s3://x/y.zip&quot;</span>
    338. 

  338. <span class="sd">        :param local_download_dir: path to download</span>
    339. 

  339. <span class="sd">        :return:</span>
    340. 

  340. <span class="sd">        &quot;&quot;&quot;</span>
    341. 

  341. 

  342.         <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">local_download_dir</span><span class="p">):</span>
    343. 

  343.             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Provided directory does not exist&#39;</span><span class="p">)</span>
    344. 

  344. 

  345.         <span class="n">local_filename</span> <span class="o">=</span> <span class="n">s3_file_path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
    346. 

  346.         <span class="bp">self</span><span class="o">.</span><span class="n">download_key</span><span class="p">(</span><span class="n">target_path</span><span class="o">=</span><span class="n">local_download_dir</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">local_filename</span><span class="p">,</span>
    347. 

  347.                           <span class="n">key_to_download</span><span class="o">=</span><span class="n">s3_file_path</span><span class="p">)</span>
    348. 

  348.         <span class="k">return</span> <span class="n">local_filename</span>
    349. 

  349. 

  350.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    351. 

  351.     <span class="k">def</span> <span class="nf">empty_folder_content_by_path_prefix</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s3_bucket_path_prefix</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
    352. 

  352.         <span class="sd">&quot;&quot;&quot;</span>
    353. 

  353. <span class="sd">        empty_folder_content_by_path_prefix - Deletes all of the files in the specified bucket path</span>
    354. 

  354. <span class="sd">            :param s3_bucket_path_prefix: The &quot;folder&quot; to empty</span>
    355. 

  355. <span class="sd">            :returns: Errors list</span>
    356. 

  356. <span class="sd">        &quot;&quot;&quot;</span>
    357. 

  357.         <span class="n">paginator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">get_paginator</span><span class="p">(</span><span class="s1">&#39;list_objects&#39;</span><span class="p">)</span>
    358. 

  358.         <span class="n">page_iterator</span> <span class="o">=</span> <span class="n">paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Prefix</span><span class="o">=</span><span class="n">s3_bucket_path_prefix</span><span class="p">)</span>
    359. 

  359. 

  360.         <span class="n">files_dict_to_delete</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">Objects</span><span class="o">=</span><span class="p">[])</span>
    361. 

  361.         <span class="n">errors_list</span> <span class="o">=</span> <span class="p">[]</span>
    362. 

  362. 

  363.         <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">page_iterator</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">&#39;Contents&#39;</span><span class="p">):</span>
    364. 

  364.             <span class="k">if</span> <span class="n">item</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
    365. 

  365.                 <span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;Key&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="n">s3_bucket_path_prefix</span><span class="p">:</span>
    366. 

  366.                     <span class="k">continue</span>
    367. 

  367.                 <span class="n">files_dict_to_delete</span><span class="p">[</span><span class="s1">&#39;Objects&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">dict</span><span class="p">(</span><span class="n">Key</span><span class="o">=</span><span class="n">item</span><span class="p">[</span><span class="s1">&#39;Key&#39;</span><span class="p">]))</span>
    368. 

  368. 

  369.                 <span class="c1"># IF OBJECTS LIMIT HAS BEEN REACHED, FLUSH</span>
    370. 

  370.                 <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">files_dict_to_delete</span><span class="p">[</span><span class="s1">&#39;Objects&#39;</span><span class="p">])</span> <span class="o">&gt;=</span> <span class="mi">1000</span><span class="p">:</span>
    371. 

  371.                     <span class="bp">self</span><span class="o">.</span><span class="n">_delete_files_left_in_list</span><span class="p">(</span><span class="n">errors_list</span><span class="p">,</span> <span class="n">files_dict_to_delete</span><span class="p">)</span>
    372. 

  372.                     <span class="n">files_dict_to_delete</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">Objects</span><span class="o">=</span><span class="p">[])</span>
    373. 

  373. 

  374.         <span class="c1"># DELETE THE FILES LEFT IN THE LIST</span>
    375. 

  375.         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">files_dict_to_delete</span><span class="p">[</span><span class="s1">&#39;Objects&#39;</span><span class="p">]):</span>
    376. 

  376.             <span class="bp">self</span><span class="o">.</span><span class="n">_delete_files_left_in_list</span><span class="p">(</span><span class="n">errors_list</span><span class="p">,</span> <span class="n">files_dict_to_delete</span><span class="p">)</span>
    377. 

  377. 

  378.         <span class="k">return</span> <span class="n">errors_list</span>
    379. 

  379. 

  380.     <span class="k">def</span> <span class="nf">_delete_files_left_in_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">errors_list</span><span class="p">,</span> <span class="n">files_dict_to_delete</span><span class="p">):</span>
    381. 

  381.         <span class="k">try</span><span class="p">:</span>
    382. 

  382.             <span class="n">s3_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">delete_objects</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Delete</span><span class="o">=</span><span class="n">files_dict_to_delete</span><span class="p">)</span>
    383. 

  383.         <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
    384. 

  384.             <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span>
    385. 

  385.                 <span class="s1">&#39;[&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_name</span> <span class="o">+</span> <span class="s1">&#39;] - Caught Exception while trying to delete keys &#39;</span> <span class="o">+</span> <span class="s1">&#39;from S3 &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span>
    386. 

  386.                     <span class="n">ex</span><span class="p">))</span>
    387. 

  387.         <span class="k">if</span> <span class="s1">&#39;Errors&#39;</span> <span class="ow">in</span> <span class="n">s3_response</span><span class="p">:</span>
    388. 

  388.             <span class="n">errors_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">s3_response</span><span class="p">[</span><span class="s1">&#39;Errors&#39;</span><span class="p">])</span>
    389. 

  389. 

  390.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    391. 

  391.     <span class="k">def</span> <span class="nf">upload_buffer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_key_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">buffer_to_write</span><span class="p">:</span> <span class="n">StringIO</span><span class="p">):</span>
    392. 

  392.         <span class="sd">&quot;&quot;&quot;</span>
    393. 

  393. <span class="sd">        Uploads a buffer into a file in S3 with the provided key name.</span>
    394. 

  394. <span class="sd">        :bucket: The name of the bucket</span>
    395. 

  395. <span class="sd">        :new_key_name: The name of the file to create in s3</span>
    396. 

  396. <span class="sd">        :buffer_to_write: A buffer that contains the file contents.</span>
    397. 

  397. <span class="sd">        &quot;&quot;&quot;</span>
    398. 

  398.         <span class="bp">self</span><span class="o">.</span><span class="n">s3_resource</span><span class="o">.</span><span class="n">Object</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">new_key_name</span><span class="p">)</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">Body</span><span class="o">=</span><span class="n">buffer_to_write</span><span class="o">.</span><span class="n">getvalue</span><span class="p">())</span>
    399. 

  399. 

  400.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    401. 

  401.     <span class="k">def</span> <span class="nf">list_bucket_objects</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">dict</span><span class="p">]:</span>
    402. 

  402.         <span class="sd">&quot;&quot;&quot;</span>
    403. 

  403. <span class="sd">        Gets a list of dictionaries, representing files in the S3 bucket that is passed in the constructor (self.bucket).</span>
    404. 

  404. <span class="sd">        :param prefix: A prefix filter for the files names.</span>
    405. 

  405. <span class="sd">        :return: the objects, dict as received from botocore.</span>
    406. 

  406. <span class="sd">        &quot;&quot;&quot;</span>
    407. 

  407.         <span class="n">paginator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">get_paginator</span><span class="p">(</span><span class="s1">&#39;list_objects&#39;</span><span class="p">)</span>
    408. 

  408.         <span class="k">if</span> <span class="n">prefix</span><span class="p">:</span>
    409. 

  409.             <span class="n">page_iterator</span> <span class="o">=</span> <span class="n">paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span> <span class="n">Prefix</span><span class="o">=</span><span class="n">prefix</span><span class="p">)</span>
    410. 

  410.         <span class="k">else</span><span class="p">:</span>
    411. 

  411.             <span class="n">page_iterator</span> <span class="o">=</span> <span class="n">paginator</span><span class="o">.</span><span class="n">paginate</span><span class="p">(</span><span class="n">Bucket</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">)</span>
    412. 

  412. 

  413.         <span class="n">bucket_objects</span> <span class="o">=</span> <span class="p">[]</span>
    414. 

  414.         <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">page_iterator</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s1">&#39;Contents&#39;</span><span class="p">):</span>
    415. 

  415.             <span class="k">if</span> <span class="ow">not</span> <span class="n">item</span> <span class="ow">or</span> <span class="n">item</span><span class="p">[</span><span class="s1">&#39;Key&#39;</span><span class="p">]</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">:</span>
    416. 

  416.                 <span class="k">continue</span>
    417. 

  417.             <span class="n">bucket_objects</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
    418. 

  418.         <span class="k">return</span> <span class="n">bucket_objects</span>
    419. 

  419. 

  420.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    421. 

  421.     <span class="k">def</span> <span class="nf">create_presigned_upload_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    422. 

  422.                                     <span class="n">object_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
    423. 

  423.                                     <span class="n">fields</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    424. 

  424.                                     <span class="n">conditions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    425. 

  425.                                     <span class="n">expiration</span><span class="o">=</span><span class="mi">3600</span><span class="p">):</span>
    426. 

  426.         <span class="sd">&quot;&quot;&quot;Generate a presigned URL S3 POST request to upload a file</span>
    427. 

  427. <span class="sd">        :param bucket_name: string</span>
    428. 

  428. <span class="sd">        :param object_name: string</span>
    429. 

  429. <span class="sd">        :param fields: Dictionary of prefilled form fields</span>
    430. 

  430. <span class="sd">        :param conditions: List of conditions to include in the policy</span>
    431. 

  431. <span class="sd">        :param expiration: Time in seconds for the presigned URL to remain valid</span>
    432. 

  432. <span class="sd">        :return: Dictionary with the following keys:</span>
    433. 

  433. <span class="sd">            url: URL to post to</span>
    434. 

  434. <span class="sd">            fields: Dictionary of form fields and values to submit with the POST request</span>
    435. 

  435. <span class="sd">        &quot;&quot;&quot;</span>
    436. 

  436.         <span class="c1"># https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-presigned-urls.html#generating-a-presigned-url-to-upload-a-file</span>
    437. 

  437.         <span class="n">file_already_exist</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_key_exists</span><span class="p">(</span><span class="n">object_name</span><span class="p">)</span>
    438. 

  438.         <span class="k">if</span> <span class="n">file_already_exist</span><span class="p">:</span>
    439. 

  439.             <span class="k">raise</span> <span class="ne">FileExistsError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The key </span><span class="si">{</span><span class="n">object_name</span><span class="si">}</span><span class="s2"> already exists in bucket </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
    440. 

  440. 

  441.         <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">generate_presigned_post</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span>
    442. 

  442.                                                           <span class="n">object_name</span><span class="p">,</span>
    443. 

  443.                                                           <span class="n">Fields</span><span class="o">=</span><span class="n">fields</span><span class="p">,</span>
    444. 

  444.                                                           <span class="n">Conditions</span><span class="o">=</span><span class="n">conditions</span><span class="p">,</span>
    445. 

  445.                                                           <span class="n">ExpiresIn</span><span class="o">=</span><span class="n">expiration</span><span class="p">)</span>
    446. 

  446.         <span class="k">return</span> <span class="n">response</span>
    447. 

  447. 

  448.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    449. 

  449.     <span class="k">def</span> <span class="nf">create_presigned_download_url</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">object_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">expiration</span><span class="o">=</span><span class="mi">3600</span><span class="p">):</span>
    450. 

  450.         <span class="sd">&quot;&quot;&quot;Generate a presigned URL S3 Get request to download a file</span>
    451. 

  451. <span class="sd">        :param bucket_name: string</span>
    452. 

  452. <span class="sd">        :param object_name: string</span>
    453. 

  453. <span class="sd">        :param expiration: Time in seconds for the presigned URL to remain valid</span>
    454. 

  454. <span class="sd">        :return: URL encoded with the credentials in the query, to be fetched using any HTTP client.</span>
    455. 

  455. <span class="sd">        &quot;&quot;&quot;</span>
    456. 

  456.         <span class="c1"># https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-presigned-urls.html</span>
    457. 

  457.         <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_client</span><span class="o">.</span><span class="n">generate_presigned_url</span><span class="p">(</span><span class="s1">&#39;get_object&#39;</span><span class="p">,</span>
    458. 

  458.                                                          <span class="n">Params</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;Bucket&#39;</span><span class="p">:</span> <span class="n">bucket_name</span><span class="p">,</span>
    459. 

  459.                                                                  <span class="s1">&#39;Key&#39;</span><span class="p">:</span> <span class="n">object_name</span><span class="p">},</span>
    460. 

  460.                                                          <span class="n">ExpiresIn</span><span class="o">=</span><span class="n">expiration</span><span class="p">)</span>
    461. 

  461.         <span class="k">return</span> <span class="n">response</span>
    462. 

  462. 

  463. <div class="viewcode-block" id="S3Connector.convert_content_length_to_mb"><a class="viewcode-back" href="../../../../super_gradients.common.html#super_gradients.common.S3Connector.convert_content_length_to_mb">[docs]</a>    <span class="nd">@staticmethod</span>
    464. 

  464.     <span class="k">def</span> <span class="nf">convert_content_length_to_mb</span><span class="p">(</span><span class="n">content_length</span><span class="p">):</span>
    465. 

  465.         <span class="k">return</span> <span class="nb">round</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">content_length</span> <span class="o">/</span> <span class="p">(</span><span class="mf">1e+6</span><span class="p">)</span><span class="si">:</span><span class="s1">2f</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span></div>
    466. 

  466. 

  467.     <span class="nd">@explicit_params_validation</span><span class="p">(</span><span class="n">validation_type</span><span class="o">=</span><span class="s1">&#39;NoneOrEmpty&#39;</span><span class="p">)</span>
    468. 

  468.     <span class="k">def</span> <span class="nf">copy_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
    469. 

  469.                  <span class="n">destination_bucket_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
    470. 

  470.                  <span class="n">source_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
    471. 

  471.                  <span class="n">destination_key</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    472. 

  472.         <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
    473. 

  473.             <span class="sa">f</span><span class="s1">&#39;Copying the bucket object </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="si">}</span><span class="s1">:</span><span class="si">{</span><span class="n">source_key</span><span class="si">}</span><span class="s1"> to </span><span class="si">{</span><span class="n">destination_bucket_name</span><span class="si">}</span><span class="s1">/</span><span class="si">{</span><span class="n">destination_key</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
    474. 

  474.         <span class="n">copy_source</span> <span class="o">=</span> <span class="p">{</span>
    475. 

  475.             <span class="s1">&#39;Bucket&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket_name</span><span class="p">,</span>
    476. 

  476.             <span class="s1">&#39;Key&#39;</span><span class="p">:</span> <span class="n">source_key</span>
    477. 

  477.         <span class="p">}</span>
    478. 

  478. 

  479.         <span class="c1"># Copying the key</span>
    480. 

  480.         <span class="n">bucket</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_resource</span><span class="o">.</span><span class="n">Bucket</span><span class="p">(</span><span class="n">destination_bucket_name</span><span class="p">)</span>
    481. 

  481.         <span class="n">bucket</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">copy_source</span><span class="p">,</span> <span class="n">destination_key</span><span class="p">)</span>
    482. 

  482.         <span class="k">return</span> <span class="kc">True</span></div>
    483. 

  483. 

  484.     <span class="c1"># @explicit_params_validation(validation_type=&#39;NoneOrEmpty&#39;)</span>
    485. 

  485.     <span class="c1"># def list_common_prefixes(self) -&gt; List[str]:</span>
    486. 

  486.     <span class="c1">#     &quot;&quot;&quot;</span>
    487. 

  487.     <span class="c1">#     Gets a list of dictionaries, representing directories in the S3 bucket that is passed in the constructor (self.bucket).</span>
    488. 

  488.     <span class="c1">#     :return: The names of the directories in the bucket.</span>
    489. 

  489.     <span class="c1">#     &quot;&quot;&quot;</span>
    490. 

  490.     <span class="c1">#     paginator = self.s3_client.get_paginator(&#39;list_objects_v2&#39;)</span>
    491. 

  491.     <span class="c1">#     page_iterator = paginator.paginate(Bucket=self.bucket_name)</span>
    492. 

  492.     <span class="c1">#     prefixes = set()</span>
    493. 

  493.     <span class="c1">#     for item in page_iterator.search(&#39;Contents&#39;):</span>
    494. 

  494.     <span class="c1">#         if not item:</span>
    495. 

  495.     <span class="c1">#             continue</span>
    496. 

  496.     <span class="c1">#</span>
    497. 

  497.     <span class="c1">#         if len(item.split(&#39;/&#39;) == 1):</span>
    498. 

  498.     <span class="c1">#             prefixes.append(item)</span>
    499. 

  499.     <span class="c1">#     return prefixes</span>
    500. 

  500. </pre></div>
    501. 

  501. 

  502.            </div>
    503. 

  503.           </div>
    504. 

  504.           <footer>
    505. 

  505. 

  506.   <hr/>
    507. 

  507. 

  508.   <div role="contentinfo">
    509. 

  509.     <p>&#169; Copyright 2021, SuperGradients team.</p>
    510. 

  510.   </div>
    511. 

  511. 

  512.   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    513. 

  513.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    514. 

  514.     provided by <a href="https://readthedocs.org">Read the Docs</a>.
    515. 

  515.    
    516. 

  516. 

  517. </footer>
    518. 

  518.         </div>
    519. 

  519.       </div>
    520. 

  520.     </section>
    521. 

  521.   </div>
    522. 

  522.   <script>
    523. 

  523.       jQuery(function () {
    524. 

  524.           SphinxRtdTheme.Navigation.enable(true);
    525. 

  525.       });
    526. 

  526.   </script> 
    527. 

  527. 

  528. </body>
    529. 

  529. </html>
    530.
Discard
Prev
Next
Tip!

Press p or to see the previous file or, n or to see the next file