| |
| |
| <!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.s3filesystem — Apache Beam 2.38.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.38.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.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> |
| </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> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li>apache_beam.io.aws.s3filesystem</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.s3filesystem</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 "License"); 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 "AS IS" 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="sd">"""S3 file system implementation for accessing files on AWS S3."""</span> |
| |
| <span class="c1"># pytype: skip-file</span> |
| |
| <span class="kn">from</span> <span class="nn">apache_beam.io.aws</span> <span class="kn">import</span> <span class="n">s3io</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.io.filesystem</span> <span class="kn">import</span> <span class="n">BeamIOError</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.io.filesystem</span> <span class="kn">import</span> <span class="n">CompressedFile</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.io.filesystem</span> <span class="kn">import</span> <span class="n">CompressionTypes</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.io.filesystem</span> <span class="kn">import</span> <span class="n">FileMetadata</span> |
| <span class="kn">from</span> <span class="nn">apache_beam.io.filesystem</span> <span class="kn">import</span> <span class="n">FileSystem</span> |
| |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'S3FileSystem'</span><span class="p">]</span> |
| |
| |
| <div class="viewcode-block" id="S3FileSystem"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem">[docs]</a><span class="k">class</span> <span class="nc">S3FileSystem</span><span class="p">(</span><span class="n">FileSystem</span><span class="p">):</span> |
| <span class="sd">"""An S3 `FileSystem` implementation for accessing files on AWS S3</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">CHUNK_SIZE</span> <span class="o">=</span> <span class="n">s3io</span><span class="o">.</span><span class="n">MAX_BATCH_OPERATION_SIZE</span> |
| <span class="n">S3_PREFIX</span> <span class="o">=</span> <span class="s1">'s3://'</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">pipeline_options</span><span class="p">):</span> |
| <span class="sd">"""Initializes a connection to S3.</span> |
| |
| <span class="sd"> Connection configuration is done by passing pipeline options.</span> |
| <span class="sd"> See :class:`~apache_beam.options.pipeline_options.S3Options`.</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">pipeline_options</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_options</span> <span class="o">=</span> <span class="n">pipeline_options</span> |
| |
| <div class="viewcode-block" id="S3FileSystem.scheme"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.scheme">[docs]</a> <span class="nd">@classmethod</span> |
| <span class="k">def</span> <span class="nf">scheme</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span> |
| <span class="sd">"""URI scheme for the FileSystem</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="s1">'s3'</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.join"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.join">[docs]</a> <span class="k">def</span> <span class="nf">join</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">basepath</span><span class="p">,</span> <span class="o">*</span><span class="n">paths</span><span class="p">):</span> |
| <span class="sd">"""Join two or more pathname components for the filesystem</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> basepath: string path of the first component of the path</span> |
| <span class="sd"> paths: path components to be added</span> |
| |
| <span class="sd"> Returns: full path after combining all of the return nulled components</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">basepath</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">S3FileSystem</span><span class="o">.</span><span class="n">S3_PREFIX</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Basepath </span><span class="si">%r</span><span class="s1"> must be S3 path.'</span> <span class="o">%</span> <span class="n">basepath</span><span class="p">)</span> |
| |
| <span class="n">path</span> <span class="o">=</span> <span class="n">basepath</span> |
| <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">paths</span><span class="p">:</span> |
| <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">p</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">path</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.split"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.split">[docs]</a> <span class="k">def</span> <span class="nf">split</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| <span class="sd">"""Splits the given path into two parts.</span> |
| |
| <span class="sd"> Splits the path into a pair (head, tail) such that tail contains the last</span> |
| <span class="sd"> component of the path and head contains everything up to that.</span> |
| |
| <span class="sd"> Head will include the S3 prefix ('s3://').</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: path as a string</span> |
| <span class="sd"> Returns:</span> |
| <span class="sd"> a pair of path components as strings.</span> |
| <span class="sd"> """</span> |
| <span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">S3FileSystem</span><span class="o">.</span><span class="n">S3_PREFIX</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Path </span><span class="si">%r</span><span class="s1"> must be S3 path.'</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span> |
| |
| <span class="n">prefix_len</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">S3FileSystem</span><span class="o">.</span><span class="n">S3_PREFIX</span><span class="p">)</span> |
| <span class="n">last_sep</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="n">prefix_len</span><span class="p">:]</span><span class="o">.</span><span class="n">rfind</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">last_sep</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="n">last_sep</span> <span class="o">+=</span> <span class="n">prefix_len</span> |
| |
| <span class="k">if</span> <span class="n">last_sep</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">return</span> <span class="p">(</span><span class="n">path</span><span class="p">[:</span><span class="n">last_sep</span><span class="p">],</span> <span class="n">path</span><span class="p">[</span><span class="n">last_sep</span> <span class="o">+</span> <span class="mi">1</span><span class="p">:])</span> |
| <span class="k">elif</span> <span class="n">last_sep</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">return</span> <span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid path: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">path</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.mkdirs"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.mkdirs">[docs]</a> <span class="k">def</span> <span class="nf">mkdirs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| <span class="sd">"""Recursively create directories for the provided path.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path of the directory structure that should be created</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> IOError: if leaf directory already exists.</span> |
| <span class="sd"> """</span> |
| <span class="k">pass</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.has_dirs"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.has_dirs">[docs]</a> <span class="k">def</span> <span class="nf">has_dirs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""Whether this FileSystem supports directories."""</span> |
| <span class="k">return</span> <span class="kc">False</span></div> |
| |
| <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">dir_or_prefix</span><span class="p">):</span> |
| <span class="sd">"""List files in a location.</span> |
| |
| <span class="sd"> Listing is non-recursive, for filesystems that support directories.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> dir_or_prefix: (string) A directory or location prefix (for filesystems</span> |
| <span class="sd"> that don't have directories).</span> |
| |
| <span class="sd"> Returns:</span> |
| <span class="sd"> Generator of ``FileMetadata`` objects.</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> ``BeamIOError``: if listing fails, but not if no files were found.</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">path</span><span class="p">,</span> <span class="n">size</span> <span class="ow">in</span> \ |
| <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">list_prefix</span><span class="p">(</span><span class="n">dir_or_prefix</span><span class="p">)</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="k">yield</span> <span class="n">FileMetadata</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"List operation failed"</span><span class="p">,</span> <span class="p">{</span><span class="n">dir_or_prefix</span><span class="p">:</span> <span class="n">e</span><span class="p">})</span> |
| |
| <span class="k">def</span> <span class="nf">_path_open</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">path</span><span class="p">,</span> |
| <span class="n">mode</span><span class="p">,</span> |
| <span class="n">mime_type</span><span class="o">=</span><span class="s1">'application/octet-stream'</span><span class="p">,</span> |
| <span class="n">compression_type</span><span class="o">=</span><span class="n">CompressionTypes</span><span class="o">.</span><span class="n">AUTO</span><span class="p">):</span> |
| <span class="sd">"""Helper functions to open a file in the provided mode.</span> |
| <span class="sd"> """</span> |
| <span class="n">compression_type</span> <span class="o">=</span> <span class="n">FileSystem</span><span class="o">.</span><span class="n">_get_compression_type</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">compression_type</span><span class="p">)</span> |
| <span class="n">mime_type</span> <span class="o">=</span> <span class="n">CompressionTypes</span><span class="o">.</span><span class="n">mime_type</span><span class="p">(</span><span class="n">compression_type</span><span class="p">,</span> <span class="n">mime_type</span><span class="p">)</span> |
| <span class="n">raw_file</span> <span class="o">=</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">open</span><span class="p">(</span> |
| <span class="n">path</span><span class="p">,</span> <span class="n">mode</span><span class="p">,</span> <span class="n">mime_type</span><span class="o">=</span><span class="n">mime_type</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">compression_type</span> <span class="o">==</span> <span class="n">CompressionTypes</span><span class="o">.</span><span class="n">UNCOMPRESSED</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">raw_file</span> |
| <span class="k">return</span> <span class="n">CompressedFile</span><span class="p">(</span><span class="n">raw_file</span><span class="p">,</span> <span class="n">compression_type</span><span class="o">=</span><span class="n">compression_type</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="S3FileSystem.create"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">path</span><span class="p">,</span> |
| <span class="n">mime_type</span><span class="o">=</span><span class="s1">'application/octet-stream'</span><span class="p">,</span> |
| <span class="n">compression_type</span><span class="o">=</span><span class="n">CompressionTypes</span><span class="o">.</span><span class="n">AUTO</span><span class="p">):</span> |
| <span class="sd">"""Returns a write channel for the given file path.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path of the file object to be written to the system</span> |
| <span class="sd"> mime_type: MIME type to specify the type of content in the file object</span> |
| <span class="sd"> compression_type: Type of compression to be used for this object</span> |
| |
| <span class="sd"> Returns: file handle with a close function for the user to use</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path_open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">,</span> <span class="n">mime_type</span><span class="p">,</span> <span class="n">compression_type</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.open"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.open">[docs]</a> <span class="k">def</span> <span class="nf">open</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">path</span><span class="p">,</span> |
| <span class="n">mime_type</span><span class="o">=</span><span class="s1">'application/octet-stream'</span><span class="p">,</span> |
| <span class="n">compression_type</span><span class="o">=</span><span class="n">CompressionTypes</span><span class="o">.</span><span class="n">AUTO</span><span class="p">):</span> |
| <span class="sd">"""Returns a read channel for the given file path.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path of the file object to be written to the system</span> |
| <span class="sd"> mime_type: MIME type to specify the type of content in the file object</span> |
| <span class="sd"> compression_type: Type of compression to be used for this object</span> |
| |
| <span class="sd"> Returns: file handle with a close function for the user to use</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path_open</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">,</span> <span class="n">mime_type</span><span class="p">,</span> <span class="n">compression_type</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.copy"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.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">source_file_names</span><span class="p">,</span> <span class="n">destination_file_names</span><span class="p">):</span> |
| <span class="sd">"""Recursively copy the file tree from the source to the destination</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> source_file_names: list of source file objects that needs to be copied</span> |
| <span class="sd"> destination_file_names: list of destination of the new object</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> ``BeamIOError``: if any of the copy operations fail</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">source_file_names</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">destination_file_names</span><span class="p">):</span> |
| <span class="n">message</span> <span class="o">=</span> <span class="s1">'Unable to copy unequal number of sources and destinations'</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> |
| <span class="n">src_dest_pairs</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">source_file_names</span><span class="p">,</span> <span class="n">destination_file_names</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">copy_paths</span><span class="p">(</span><span class="n">src_dest_pairs</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.rename"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.rename">[docs]</a> <span class="k">def</span> <span class="nf">rename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_file_names</span><span class="p">,</span> <span class="n">destination_file_names</span><span class="p">):</span> |
| <span class="sd">"""Rename the files at the source list to the destination list.</span> |
| <span class="sd"> Source and destination lists should be of the same size.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> source_file_names: List of file paths that need to be moved</span> |
| <span class="sd"> destination_file_names: List of destination_file_names for the files</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> ``BeamIOError``: if any of the rename operations fail</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">len</span><span class="p">(</span><span class="n">source_file_names</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">destination_file_names</span><span class="p">):</span> |
| <span class="n">message</span> <span class="o">=</span> <span class="s1">'Unable to rename unequal number of sources and destinations'</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> |
| <span class="n">src_dest_pairs</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">source_file_names</span><span class="p">,</span> <span class="n">destination_file_names</span><span class="p">))</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">rename_files</span><span class="p">(</span><span class="n">src_dest_pairs</span><span class="p">)</span> |
| <span class="n">exceptions</span> <span class="o">=</span> <span class="p">{(</span><span class="n">src</span><span class="p">,</span> <span class="n">dest</span><span class="p">):</span> <span class="n">error</span> |
| <span class="k">for</span> <span class="p">(</span><span class="n">src</span><span class="p">,</span> <span class="n">dest</span><span class="p">,</span> <span class="n">error</span><span class="p">)</span> <span class="ow">in</span> <span class="n">results</span> <span class="k">if</span> <span class="n">error</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">}</span> |
| <span class="k">if</span> <span class="n">exceptions</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"Rename operation failed"</span><span class="p">,</span> <span class="n">exceptions</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.exists"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.exists">[docs]</a> <span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| <span class="sd">"""Check if the provided path exists on the FileSystem.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path that needs to be checked.</span> |
| |
| <span class="sd"> Returns: boolean flag indicating if path exists</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"exists() operation failed"</span><span class="p">,</span> <span class="p">{</span><span class="n">path</span><span class="p">:</span> <span class="n">e</span><span class="p">})</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.size"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.size">[docs]</a> <span class="k">def</span> <span class="nf">size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| <span class="sd">"""Get size of path on the FileSystem.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path in question.</span> |
| |
| <span class="sd"> Returns: int size of path according to the FileSystem.</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> ``BeamIOError``: if path doesn't exist.</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"size() operation failed"</span><span class="p">,</span> <span class="p">{</span><span class="n">path</span><span class="p">:</span> <span class="n">e</span><span class="p">})</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.last_updated"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.last_updated">[docs]</a> <span class="k">def</span> <span class="nf">last_updated</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| <span class="sd">"""Get UNIX Epoch time in seconds on the FileSystem.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path of file.</span> |
| |
| <span class="sd"> Returns: float UNIX Epoch time</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> ``BeamIOError``: if path doesn't exist.</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">last_updated</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"last_updated operation failed"</span><span class="p">,</span> <span class="p">{</span><span class="n">path</span><span class="p">:</span> <span class="n">e</span><span class="p">})</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.checksum"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.checksum">[docs]</a> <span class="k">def</span> <span class="nf">checksum</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span> |
| <span class="sd">"""Fetch checksum metadata of a file on the</span> |
| <span class="sd"> :class:`~apache_beam.io.filesystem.FileSystem`.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> path: string path of a file.</span> |
| |
| <span class="sd"> Returns: string containing checksum</span> |
| |
| <span class="sd"> Raises:</span> |
| <span class="sd"> ``BeamIOError``: if path isn't a file or doesn't exist.</span> |
| <span class="sd"> """</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">checksum</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"Checksum operation failed"</span><span class="p">,</span> <span class="p">{</span><span class="n">path</span><span class="p">:</span> <span class="n">e</span><span class="p">})</span></div> |
| |
| <div class="viewcode-block" id="S3FileSystem.delete"><a class="viewcode-back" href="../../../../apache_beam.io.aws.s3filesystem.html#apache_beam.io.aws.s3filesystem.S3FileSystem.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">paths</span><span class="p">):</span> |
| <span class="sd">"""Deletes files or directories at the provided paths.</span> |
| <span class="sd"> Directories will be deleted recursively.</span> |
| |
| <span class="sd"> Args:</span> |
| <span class="sd"> paths: list of paths that give the file objects to be deleted</span> |
| <span class="sd"> """</span> |
| <span class="n">results</span> <span class="o">=</span> <span class="n">s3io</span><span class="o">.</span><span class="n">S3IO</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_options</span><span class="p">)</span><span class="o">.</span><span class="n">delete_paths</span><span class="p">(</span><span class="n">paths</span><span class="p">)</span> |
| <span class="n">exceptions</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">path</span><span class="p">:</span> <span class="n">error</span> |
| <span class="k">for</span> <span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">error</span><span class="p">)</span> <span class="ow">in</span> <span class="n">results</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">error</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> |
| <span class="p">}</span> |
| <span class="k">if</span> <span class="n">exceptions</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">BeamIOError</span><span class="p">(</span><span class="s2">"Delete operation failed"</span><span class="p">,</span> <span class="n">exceptions</span><span class="p">)</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |