pydoc/2.47.0/_modules/apache_beam/io/aws/clients/s3/fake_client.html - beam-site - Git at Google



 <!DOCTYPE html>
 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
   <meta charset="utf-8">

   <meta name="viewport" content="width=device-width, initial-scale=1.0">

   <title>apache_beam.io.aws.clients.s3.fake_client &mdash; Apache Beam 2.47.0 documentation</title>


   <script type="text/javascript" src="../../../../../../_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="../../../../../../" src="../../../../../../_static/documentation_options.js"></script>
         <script type="text/javascript" src="../../../../../../_static/jquery.js"></script>
         <script type="text/javascript" src="../../../../../../_static/underscore.js"></script>
         <script type="text/javascript" src="../../../../../../_static/doctools.js"></script>
         <script type="text/javascript" src="../../../../../../_static/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

     <script type="text/javascript" src="../../../../../../_static/js/theme.js"></script>


   <link rel="stylesheet" href="../../../../../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../../../search.html" />
 </head>

 <body class="wy-body-for-nav">


   <div class="wy-grid-for-nav">

     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


             <a href="../../../../../../index.html" class="icon icon-home"> Apache Beam


           </a>


               <div class="version">
                 2.47.0
               </div>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.io.html">apache_beam.io package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.yaml.html">apache_beam.yaml package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../../../../../index.html">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">

         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="../../../../../../index.html">Docs</a> &raquo;</li>

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

       <li>apache_beam.io.aws.clients.s3.fake_client</li>


       <li class="wy-breadcrumbs-aside">

       </li>

   </ul>


   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">

   <h1>Source code for apache_beam.io.aws.clients.s3.fake_client</h1><div class="highlight"><pre>
 <span></span><span class="c1">#</span>
 <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
 <span class="c1"># contributor license agreements.  See the NOTICE file distributed with</span>
 <span class="c1"># this work for additional information regarding copyright ownership.</span>
 <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
 <span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
 <span class="c1"># the License.  You may obtain a copy of the License at</span>
 <span class="c1">#</span>
 <span class="c1">#    http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="c1">#</span>
 <span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
 <span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
 <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="c1"># See the License for the specific language governing permissions and</span>
 <span class="c1"># limitations under the License.</span>
 <span class="c1">#</span>

 <span class="c1"># pytype: skip-file</span>

 <span class="kn">import</span> <span class="nn">datetime</span>
 <span class="kn">import</span> <span class="nn">time</span>

 <span class="kn">import</span> <span class="nn">pytz</span>

 <span class="kn">from</span> <span class="nn">apache_beam.io.aws.clients.s3</span> <span class="kn">import</span> <span class="n">messages</span>


 <div class="viewcode-block" id="FakeFile"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeFile">[docs]</a><span class="k">class</span> <span class="nc">FakeFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
   <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">bucket</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">contents</span><span class="p">,</span> <span class="n">etag</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">key</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">contents</span> <span class="o">=</span> <span class="n">contents</span>

     <span class="bp">self</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>

     <span class="k">if</span> <span class="ow">not</span> <span class="n">etag</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s1">&#39;&quot;</span><span class="si">%s</span><span class="s1">-1&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="s1">&#39;x&#39;</span> <span class="o">*</span> <span class="mi">32</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="n">etag</span>

 <div class="viewcode-block" id="FakeFile.get_metadata"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeFile.get_metadata">[docs]</a>  <span class="k">def</span> <span class="nf">get_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="n">last_modified_datetime</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_modified</span><span class="p">:</span>
       <span class="n">last_modified_datetime</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span>
           <span class="bp">self</span><span class="o">.</span><span class="n">last_modified</span><span class="p">,</span> <span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>

     <span class="k">return</span> <span class="n">messages</span><span class="o">.</span><span class="n">Item</span><span class="p">(</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">etag</span><span class="p">,</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span>
         <span class="n">last_modified_datetime</span><span class="p">,</span>
         <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">contents</span><span class="p">),</span>
         <span class="n">mime_type</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></div></div>


 <div class="viewcode-block" id="FakeS3Client"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client">[docs]</a><span class="k">class</span> <span class="nc">FakeS3Client</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
   <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="bp">self</span><span class="o">.</span><span class="n">files</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">list_continuation_tokens</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">multipart_uploads</span> <span class="o">=</span> <span class="p">{}</span>

     <span class="c1"># boto3 has different behavior when running some operations against a bucket</span>
     <span class="c1"># that exists vs. against one that doesn&#39;t. To emulate that behavior, the</span>
     <span class="c1"># mock client keeps a set of bucket names that it knows &quot;exist&quot;.</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">known_buckets</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>

 <div class="viewcode-block" id="FakeS3Client.add_file"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.add_file">[docs]</a>  <span class="k">def</span> <span class="nf">add_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">[(</span><span class="n">f</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">f</span><span class="o">.</span><span class="n">key</span><span class="p">)]</span> <span class="o">=</span> <span class="n">f</span>
     <span class="k">if</span> <span class="n">f</span><span class="o">.</span><span class="n">bucket</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_buckets</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">known_buckets</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">bucket</span><span class="p">)</span></div>

 <div class="viewcode-block" id="FakeS3Client.get_file"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.get_file">[docs]</a>  <span class="k">def</span> <span class="nf">get_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
     <span class="k">try</span><span class="p">:</span>
       <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">[</span><span class="n">bucket</span><span class="p">,</span> <span class="n">obj</span><span class="p">]</span>
     <span class="k">except</span><span class="p">:</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="s1">&#39;Not Found&#39;</span><span class="p">,</span> <span class="mi">404</span><span class="p">)</span></div>

 <div class="viewcode-block" id="FakeS3Client.delete_file"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.delete_file">[docs]</a>  <span class="k">def</span> <span class="nf">delete_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="p">,</span> <span class="n">obj</span><span class="p">):</span>
     <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">[(</span><span class="n">bucket</span><span class="p">,</span> <span class="n">obj</span><span class="p">)]</span></div>

 <div class="viewcode-block" id="FakeS3Client.get_object_metadata"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.get_object_metadata">[docs]</a>  <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">request</span><span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Retrieves an object&#39;s metadata.</span>

 <span class="sd">    Args:</span>
 <span class="sd">      request: (GetRequest) input message</span>

 <span class="sd">    Returns:</span>
 <span class="sd">      (Item) The response message.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># TODO: Do we want to mock out a lack of credentials?</span>
     <span class="n">file_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_file</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">file_</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">()</span></div>

 <div class="viewcode-block" id="FakeS3Client.list"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.list">[docs]</a>  <span class="k">def</span> <span class="nf">list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
     <span class="n">bucket</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">bucket</span>
     <span class="n">prefix</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">prefix</span> <span class="ow">or</span> <span class="s1">&#39;&#39;</span>
     <span class="n">matching_files</span> <span class="o">=</span> <span class="p">[]</span>

     <span class="k">for</span> <span class="n">file_bucket</span><span class="p">,</span> <span class="n">file_name</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">)):</span>
       <span class="k">if</span> <span class="n">bucket</span> <span class="o">==</span> <span class="n">file_bucket</span> <span class="ow">and</span> <span class="n">file_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">prefix</span><span class="p">):</span>
         <span class="n">file_object</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_file</span><span class="p">(</span><span class="n">file_bucket</span><span class="p">,</span> <span class="n">file_name</span><span class="p">)</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">()</span>
         <span class="n">matching_files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">file_object</span><span class="p">)</span>

     <span class="k">if</span> <span class="ow">not</span> <span class="n">matching_files</span><span class="p">:</span>
       <span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Tried to list nonexistent S3 path: s3://</span><span class="si">%s</span><span class="s1">/</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
           <span class="n">bucket</span><span class="p">,</span> <span class="n">prefix</span><span class="p">)</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="mi">404</span><span class="p">)</span>

     <span class="c1"># Handle pagination.</span>
     <span class="n">items_per_page</span> <span class="o">=</span> <span class="mi">5</span>
     <span class="k">if</span> <span class="ow">not</span> <span class="n">request</span><span class="o">.</span><span class="n">continuation_token</span><span class="p">:</span>
       <span class="n">range_start</span> <span class="o">=</span> <span class="mi">0</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">continuation_token</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_continuation_tokens</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Invalid page token.&#39;</span><span class="p">)</span>
       <span class="n">range_start</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_continuation_tokens</span><span class="p">[</span><span class="n">request</span><span class="o">.</span><span class="n">continuation_token</span><span class="p">]</span>
       <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_continuation_tokens</span><span class="p">[</span><span class="n">request</span><span class="o">.</span><span class="n">continuation_token</span><span class="p">]</span>

     <span class="n">result</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">ListResponse</span><span class="p">(</span>
         <span class="n">items</span><span class="o">=</span><span class="n">matching_files</span><span class="p">[</span><span class="n">range_start</span><span class="p">:</span><span class="n">range_start</span> <span class="o">+</span> <span class="n">items_per_page</span><span class="p">])</span>

     <span class="k">if</span> <span class="n">range_start</span> <span class="o">+</span> <span class="n">items_per_page</span> <span class="o">&lt;</span> <span class="nb">len</span><span class="p">(</span><span class="n">matching_files</span><span class="p">):</span>
       <span class="n">next_range_start</span> <span class="o">=</span> <span class="n">range_start</span> <span class="o">+</span> <span class="n">items_per_page</span>
       <span class="n">next_continuation_token</span> <span class="o">=</span> <span class="s1">&#39;_page_token_</span><span class="si">%s</span><span class="s1">_</span><span class="si">%s</span><span class="s1">_</span><span class="si">%d</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span>
           <span class="n">bucket</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">next_range_start</span><span class="p">)</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">list_continuation_tokens</span><span class="p">[</span><span class="n">next_continuation_token</span><span class="p">]</span> <span class="o">=</span> <span class="n">next_range_start</span>
       <span class="n">result</span><span class="o">.</span><span class="n">next_token</span> <span class="o">=</span> <span class="n">next_continuation_token</span>

     <span class="k">return</span> <span class="n">result</span></div>

 <div class="viewcode-block" id="FakeS3Client.get_range"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.get_range">[docs]</a>  <span class="k">def</span> <span class="nf">get_range</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
 <span class="w">    </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Retrieves an object.</span>

 <span class="sd">      Args:</span>
 <span class="sd">        request: (GetRequest) request</span>
 <span class="sd">      Returns:</span>
 <span class="sd">        (bytes) The response message.</span>
 <span class="sd">      &quot;&quot;&quot;</span>

     <span class="n">file_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_file</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">)</span>

     <span class="c1"># Replicates S3&#39;s behavior, per the spec here:</span>
     <span class="c1"># https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</span>
     <span class="k">if</span> <span class="n">start</span> <span class="o">&lt;</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">end</span> <span class="o">&lt;=</span> <span class="n">start</span><span class="p">:</span>
       <span class="k">return</span> <span class="n">file_</span><span class="o">.</span><span class="n">contents</span>

     <span class="k">return</span> <span class="n">file_</span><span class="o">.</span><span class="n">contents</span><span class="p">[</span><span class="n">start</span><span class="p">:</span><span class="n">end</span><span class="p">]</span></div>

 <div class="viewcode-block" id="FakeS3Client.delete"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.delete">[docs]</a>  <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
     <span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">bucket</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_buckets</span><span class="p">:</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="s1">&#39;The specified bucket does not exist&#39;</span><span class="p">,</span> <span class="mi">404</span><span class="p">)</span>

     <span class="k">if</span> <span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">files</span><span class="p">:</span>
       <span class="bp">self</span><span class="o">.</span><span class="n">delete_file</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">)</span>
     <span class="k">else</span><span class="p">:</span>
       <span class="c1"># S3 doesn&#39;t raise an error if you try to delete a nonexistent file from</span>
       <span class="c1"># an extant bucket</span>
       <span class="k">return</span></div>

 <div class="viewcode-block" id="FakeS3Client.delete_batch"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.delete_batch">[docs]</a>  <span class="k">def</span> <span class="nf">delete_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>

     <span class="n">deleted</span><span class="p">,</span> <span class="n">failed</span><span class="p">,</span> <span class="n">errors</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[],</span> <span class="p">[]</span>
     <span class="k">for</span> <span class="nb">object</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">objects</span><span class="p">:</span>
       <span class="k">try</span><span class="p">:</span>
         <span class="n">delete_request</span> <span class="o">=</span> <span class="n">messages</span><span class="o">.</span><span class="n">DeleteRequest</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="nb">object</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">delete_request</span><span class="p">)</span>
         <span class="n">deleted</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">object</span><span class="p">)</span>
       <span class="k">except</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
         <span class="n">failed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">object</span><span class="p">)</span>
         <span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>

     <span class="k">return</span> <span class="n">messages</span><span class="o">.</span><span class="n">DeleteBatchResponse</span><span class="p">(</span><span class="n">deleted</span><span class="p">,</span> <span class="n">failed</span><span class="p">,</span> <span class="n">errors</span><span class="p">)</span></div>

 <div class="viewcode-block" id="FakeS3Client.copy"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.copy">[docs]</a>  <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>

     <span class="n">src_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_file</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">src_bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">src_key</span><span class="p">)</span>
     <span class="n">dest_file</span> <span class="o">=</span> <span class="n">FakeFile</span><span class="p">(</span>
         <span class="n">request</span><span class="o">.</span><span class="n">dest_bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">dest_key</span><span class="p">,</span> <span class="n">src_file</span><span class="o">.</span><span class="n">contents</span><span class="p">)</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">add_file</span><span class="p">(</span><span class="n">dest_file</span><span class="p">)</span></div>

 <div class="viewcode-block" id="FakeS3Client.create_multipart_upload"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.create_multipart_upload">[docs]</a>  <span class="k">def</span> <span class="nf">create_multipart_upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
     <span class="c1"># Create hash of bucket and key</span>
     <span class="c1"># Store upload_id internally</span>
     <span class="n">upload_id</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">bucket</span> <span class="o">+</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">multipart_uploads</span><span class="p">[</span><span class="n">upload_id</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
     <span class="k">return</span> <span class="n">messages</span><span class="o">.</span><span class="n">UploadResponse</span><span class="p">(</span><span class="n">upload_id</span><span class="p">)</span></div>

 <div class="viewcode-block" id="FakeS3Client.upload_part"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.upload_part">[docs]</a>  <span class="k">def</span> <span class="nf">upload_part</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
     <span class="c1"># Save off bytes passed to internal data store</span>
     <span class="n">upload_id</span><span class="p">,</span> <span class="n">part_number</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">upload_id</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">part_number</span>

     <span class="k">if</span> <span class="n">part_number</span> <span class="o">&lt;</span> <span class="mi">0</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">part_number</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span>
           <span class="s1">&#39;Param validation failed on part number&#39;</span><span class="p">,</span> <span class="mi">400</span><span class="p">)</span>

     <span class="k">if</span> <span class="n">upload_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">multipart_uploads</span><span class="p">:</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="s1">&#39;The specified upload does not exist&#39;</span><span class="p">,</span> <span class="mi">404</span><span class="p">)</span>

     <span class="bp">self</span><span class="o">.</span><span class="n">multipart_uploads</span><span class="p">[</span><span class="n">upload_id</span><span class="p">][</span><span class="n">part_number</span><span class="p">]</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">bytes</span>

     <span class="n">etag</span> <span class="o">=</span> <span class="s1">&#39;&quot;</span><span class="si">%s</span><span class="s1">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="s1">&#39;x&#39;</span> <span class="o">*</span> <span class="mi">32</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">messages</span><span class="o">.</span><span class="n">UploadPartResponse</span><span class="p">(</span><span class="n">etag</span><span class="p">,</span> <span class="n">part_number</span><span class="p">)</span></div>

 <div class="viewcode-block" id="FakeS3Client.complete_multipart_upload"><a class="viewcode-back" href="../../../../../../apache_beam.io.aws.clients.s3.fake_client.html#apache_beam.io.aws.clients.s3.fake_client.FakeS3Client.complete_multipart_upload">[docs]</a>  <span class="k">def</span> <span class="nf">complete_multipart_upload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">):</span>
     <span class="n">MIN_PART_SIZE</span> <span class="o">=</span> <span class="mi">5</span> <span class="o">*</span> <span class="mi">2</span><span class="o">**</span><span class="mi">10</span>  <span class="c1"># 5 KiB</span>

     <span class="n">parts_received</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">multipart_uploads</span><span class="p">[</span><span class="n">request</span><span class="o">.</span><span class="n">upload_id</span><span class="p">]</span>

     <span class="c1"># Check that we got all the parts that they intended to send</span>
     <span class="n">part_numbers_to_confirm</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">part</span><span class="p">[</span><span class="s1">&#39;PartNumber&#39;</span><span class="p">]</span> <span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span>

     <span class="c1"># Make sure all the expected parts are present</span>
     <span class="k">if</span> <span class="n">part_numbers_to_confirm</span> <span class="o">!=</span> <span class="nb">set</span><span class="p">(</span><span class="n">parts_received</span><span class="o">.</span><span class="n">keys</span><span class="p">()):</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span>
           <span class="s1">&#39;One or more of the specified parts could not be found&#39;</span><span class="p">,</span> <span class="mi">400</span><span class="p">)</span>

     <span class="c1"># Sort by part number</span>
     <span class="n">sorted_parts</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">parts_received</span><span class="o">.</span><span class="n">items</span><span class="p">(),</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">pair</span><span class="p">:</span> <span class="n">pair</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
     <span class="n">sorted_bytes</span> <span class="o">=</span> <span class="p">[</span><span class="n">bytes_</span> <span class="k">for</span> <span class="p">(</span><span class="n">_</span><span class="p">,</span> <span class="n">bytes_</span><span class="p">)</span> <span class="ow">in</span> <span class="n">sorted_parts</span><span class="p">]</span>

     <span class="c1"># Make sure that the parts aren&#39;t too small (except the last part)</span>
     <span class="n">part_sizes</span> <span class="o">=</span> <span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">bytes_</span><span class="p">)</span> <span class="k">for</span> <span class="n">bytes_</span> <span class="ow">in</span> <span class="n">sorted_bytes</span><span class="p">]</span>
     <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">size</span> <span class="o">&lt;</span> <span class="n">MIN_PART_SIZE</span> <span class="k">for</span> <span class="n">size</span> <span class="ow">in</span> <span class="n">part_sizes</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]):</span>
       <span class="n">e_message</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span>
 <span class="s2">      All parts but the last must be larger than </span><span class="si">%d</span><span class="s2"> bytes</span>
 <span class="s2">      &quot;&quot;&quot;</span> <span class="o">%</span> <span class="n">MIN_PART_SIZE</span>
       <span class="k">raise</span> <span class="n">messages</span><span class="o">.</span><span class="n">S3ClientError</span><span class="p">(</span><span class="n">e_message</span><span class="p">,</span> <span class="mi">400</span><span class="p">)</span>

     <span class="c1"># String together all bytes for the given upload</span>
     <span class="n">final_contents</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sorted_bytes</span><span class="p">)</span>

     <span class="c1"># Create FakeFile object</span>
     <span class="n">num_parts</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">parts_received</span><span class="p">)</span>
     <span class="n">etag</span> <span class="o">=</span> <span class="s1">&#39;&quot;</span><span class="si">%s</span><span class="s1">-</span><span class="si">%d</span><span class="s1">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="s1">&#39;x&#39;</span> <span class="o">*</span> <span class="mi">32</span><span class="p">,</span> <span class="n">num_parts</span><span class="p">)</span>
     <span class="n">file_</span> <span class="o">=</span> <span class="n">FakeFile</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">request</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> <span class="n">final_contents</span><span class="p">,</span> <span class="n">etag</span><span class="o">=</span><span class="n">etag</span><span class="p">)</span>

     <span class="c1"># Store FakeFile in self.files</span>
     <span class="bp">self</span><span class="o">.</span><span class="n">add_file</span><span class="p">(</span><span class="n">file_</span><span class="p">)</span></div></div>
 </pre></div>

            </div>

           </div>
           <footer>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>