| |
| |
| |
| |
| <!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>airflow.contrib.hooks.ftp_hook — Airflow 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 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" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </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"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.4 |
| </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="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">API Reference</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">Airflow</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><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.ftp_hook</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 airflow.contrib.hooks.ftp_hook</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with 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,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| <span class="c1">#</span> |
| |
| <span class="kn">import</span> <span class="nn">datetime</span> |
| <span class="kn">import</span> <span class="nn">ftplib</span> |
| <span class="kn">import</span> <span class="nn">os.path</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="k">import</span> <span class="n">BaseHook</span> |
| <span class="kn">from</span> <span class="nn">past.builtins</span> <span class="k">import</span> <span class="n">basestring</span> |
| |
| |
| <div class="viewcode-block" id="mlsd"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.mlsd">[docs]</a><span class="k">def</span> <span class="nf">mlsd</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">facts</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> BACKPORT FROM PYTHON3 FTPLIB.</span> |
| |
| <span class="sd"> List a directory in a standardized format by using MLSD</span> |
| <span class="sd"> command (RFC-3659). If path is omitted the current directory</span> |
| <span class="sd"> is assumed. "facts" is a list of strings representing the type</span> |
| <span class="sd"> of information desired (e.g. ["type", "size", "perm"]).</span> |
| |
| <span class="sd"> Return a generator object yielding a tuple of two elements</span> |
| <span class="sd"> for every file found in path.</span> |
| <span class="sd"> First element is the file name, the second one is a dictionary</span> |
| <span class="sd"> including a variable number of "facts" depending on the server</span> |
| <span class="sd"> and whether "facts" argument has been provided.</span> |
| <span class="sd"> """</span> |
| <span class="n">facts</span> <span class="o">=</span> <span class="n">facts</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="k">if</span> <span class="n">facts</span><span class="p">:</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">sendcmd</span><span class="p">(</span><span class="s2">"OPTS MLST "</span> <span class="o">+</span> <span class="s2">";"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">facts</span><span class="p">)</span> <span class="o">+</span> <span class="s2">";"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">path</span><span class="p">:</span> |
| <span class="n">cmd</span> <span class="o">=</span> <span class="s2">"MLSD </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">path</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">cmd</span> <span class="o">=</span> <span class="s2">"MLSD"</span> |
| <span class="n">lines</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">retrlines</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">:</span> |
| <span class="n">facts_found</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="n">ftplib</span><span class="o">.</span><span class="n">CRLF</span><span class="p">)</span><span class="o">.</span><span class="n">partition</span><span class="p">(</span><span class="s1">' '</span><span class="p">)</span> |
| <span class="n">entry</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">for</span> <span class="n">fact</span> <span class="ow">in</span> <span class="n">facts_found</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">";"</span><span class="p">):</span> |
| <span class="n">key</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">value</span> <span class="o">=</span> <span class="n">fact</span><span class="o">.</span><span class="n">partition</span><span class="p">(</span><span class="s2">"="</span><span class="p">)</span> |
| <span class="n">entry</span><span class="p">[</span><span class="n">key</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="n">value</span> |
| <span class="k">yield</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">entry</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="FTPHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook">[docs]</a><span class="k">class</span> <span class="nc">FTPHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Interact with FTP.</span> |
| |
| <span class="sd"> Errors that may occur throughout but should be handled downstream.</span> |
| <span class="sd"> You can specify mode for data transfers in the extra field of your</span> |
| <span class="sd"> connection as ``{"passive": "true"}``.</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ftp_conn_id</span><span class="o">=</span><span class="s1">'ftp_default'</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ftp_conn_id</span> <span class="o">=</span> <span class="n">ftp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="FTPHook.__enter__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.__enter__">[docs]</a> <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.__exit__"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.__exit__">[docs]</a> <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">close_conn</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a FTP connection object</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ftp_conn_id</span><span class="p">)</span> |
| <span class="n">pasv</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"passive"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="n">ftplib</span><span class="o">.</span><span class="n">FTP</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">host</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">login</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">set_pasv</span><span class="p">(</span><span class="n">pasv</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.close_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.close_conn">[docs]</a> <span class="k">def</span> <span class="nf">close_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Closes the connection. An error will occur if the</span> |
| <span class="sd"> connection wasn't ever opened.</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="kc">None</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.describe_directory"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.describe_directory">[docs]</a> <span class="k">def</span> <span class="nf">describe_directory</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">"""</span> |
| <span class="sd"> Returns a dictionary of {filename: {attributes}} for all files</span> |
| <span class="sd"> on the remote system (where the MLSD command is supported).</span> |
| |
| <span class="sd"> :param path: full path to the remote directory</span> |
| <span class="sd"> :type path: str</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">cwd</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="c1"># only works in Python 3</span> |
| <span class="n">files</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">mlsd</span><span class="p">())</span> |
| <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span> |
| <span class="n">files</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">mlsd</span><span class="p">(</span><span class="n">conn</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">files</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.list_directory"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.list_directory">[docs]</a> <span class="k">def</span> <span class="nf">list_directory</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">nlst</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a list of files on the remote system.</span> |
| |
| <span class="sd"> :param path: full path to the remote directory to list</span> |
| <span class="sd"> :type path: str</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">cwd</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| |
| <span class="n">files</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">nlst</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">files</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.create_directory"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.create_directory">[docs]</a> <span class="k">def</span> <span class="nf">create_directory</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">"""</span> |
| <span class="sd"> Creates a directory on the remote system.</span> |
| |
| <span class="sd"> :param path: full path to the remote directory to create</span> |
| <span class="sd"> :type path: str</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">mkd</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.delete_directory"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.delete_directory">[docs]</a> <span class="k">def</span> <span class="nf">delete_directory</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">"""</span> |
| <span class="sd"> Deletes a directory on the remote system.</span> |
| |
| <span class="sd"> :param path: full path to the remote directory to delete</span> |
| <span class="sd"> :type path: str</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">rmd</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.retrieve_file"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.retrieve_file">[docs]</a> <span class="k">def</span> <span class="nf">retrieve_file</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">remote_full_path</span><span class="p">,</span> |
| <span class="n">local_full_path_or_buffer</span><span class="p">,</span> |
| <span class="n">callback</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Transfers the remote file to a local location.</span> |
| |
| <span class="sd"> If local_full_path_or_buffer is a string path, the file will be put</span> |
| <span class="sd"> at that location; if it is a file-like buffer, the file will</span> |
| <span class="sd"> be written to the buffer but not closed.</span> |
| |
| <span class="sd"> :param remote_full_path: full path to the remote file</span> |
| <span class="sd"> :type remote_full_path: str</span> |
| <span class="sd"> :param local_full_path_or_buffer: full path to the local file or a</span> |
| <span class="sd"> file-like buffer</span> |
| <span class="sd"> :type local_full_path_or_buffer: str or file-like buffer</span> |
| <span class="sd"> :param callback: callback which is called each time a block of data</span> |
| <span class="sd"> is read. if you do not use a callback, these blocks will be written</span> |
| <span class="sd"> to the file or buffer passed in. if you do pass in a callback, note</span> |
| <span class="sd"> that writing to a file or buffer will need to be handled inside the</span> |
| <span class="sd"> callback.</span> |
| <span class="sd"> [default: output_handle.write()]</span> |
| <span class="sd"> :type callback: callable</span> |
| |
| <span class="sd"> .. code-block:: python</span> |
| |
| <span class="sd"> hook = FTPHook(ftp_conn_id='my_conn')</span> |
| |
| <span class="sd"> remote_path = '/path/to/remote/file'</span> |
| <span class="sd"> local_path = '/path/to/local/file'</span> |
| |
| <span class="sd"> # with a custom callback (in this case displaying progress on each read)</span> |
| <span class="sd"> def print_progress(percent_progress):</span> |
| <span class="sd"> self.log.info('Percent Downloaded: %s%%' % percent_progress)</span> |
| |
| <span class="sd"> total_downloaded = 0</span> |
| <span class="sd"> total_file_size = hook.get_size(remote_path)</span> |
| <span class="sd"> output_handle = open(local_path, 'wb')</span> |
| <span class="sd"> def write_to_file_with_progress(data):</span> |
| <span class="sd"> total_downloaded += len(data)</span> |
| <span class="sd"> output_handle.write(data)</span> |
| <span class="sd"> percent_progress = (total_downloaded / total_file_size) * 100</span> |
| <span class="sd"> print_progress(percent_progress)</span> |
| <span class="sd"> hook.retrieve_file(remote_path, None, callback=write_to_file_with_progress)</span> |
| |
| <span class="sd"> # without a custom callback data is written to the local_path</span> |
| <span class="sd"> hook.retrieve_file(remote_path, local_path)</span> |
| |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">is_path</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">local_full_path_or_buffer</span><span class="p">,</span> <span class="n">basestring</span><span class="p">)</span> |
| |
| <span class="c1"># without a callback, default to writing to a user-provided file or</span> |
| <span class="c1"># file-like buffer</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">callback</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">is_path</span><span class="p">:</span> |
| <span class="n">output_handle</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">local_full_path_or_buffer</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">output_handle</span> <span class="o">=</span> <span class="n">local_full_path_or_buffer</span> |
| <span class="n">callback</span> <span class="o">=</span> <span class="n">output_handle</span><span class="o">.</span><span class="n">write</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">output_handle</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="n">remote_path</span><span class="p">,</span> <span class="n">remote_file_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">remote_full_path</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">cwd</span><span class="p">(</span><span class="n">remote_path</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Retrieving file from FTP: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">remote_full_path</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">retrbinary</span><span class="p">(</span><span class="s1">'RETR </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">remote_file_name</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Finished retrieving file from FTP: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">remote_full_path</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">is_path</span> <span class="ow">and</span> <span class="n">output_handle</span><span class="p">:</span> |
| <span class="n">output_handle</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.store_file"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.store_file">[docs]</a> <span class="k">def</span> <span class="nf">store_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remote_full_path</span><span class="p">,</span> <span class="n">local_full_path_or_buffer</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Transfers a local file to the remote location.</span> |
| |
| <span class="sd"> If local_full_path_or_buffer is a string path, the file will be read</span> |
| <span class="sd"> from that location; if it is a file-like buffer, the file will</span> |
| <span class="sd"> be read from the buffer but not closed.</span> |
| |
| <span class="sd"> :param remote_full_path: full path to the remote file</span> |
| <span class="sd"> :type remote_full_path: str</span> |
| <span class="sd"> :param local_full_path_or_buffer: full path to the local file or a</span> |
| <span class="sd"> file-like buffer</span> |
| <span class="sd"> :type local_full_path_or_buffer: str or file-like buffer</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| |
| <span class="n">is_path</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">local_full_path_or_buffer</span><span class="p">,</span> <span class="n">basestring</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">is_path</span><span class="p">:</span> |
| <span class="n">input_handle</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">local_full_path_or_buffer</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">input_handle</span> <span class="o">=</span> <span class="n">local_full_path_or_buffer</span> |
| <span class="n">remote_path</span><span class="p">,</span> <span class="n">remote_file_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">remote_full_path</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">cwd</span><span class="p">(</span><span class="n">remote_path</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">storbinary</span><span class="p">(</span><span class="s1">'STOR </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">remote_file_name</span><span class="p">,</span> <span class="n">input_handle</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">is_path</span><span class="p">:</span> |
| <span class="n">input_handle</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.delete_file"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.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">path</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Removes a file on the FTP Server.</span> |
| |
| <span class="sd"> :param path: full path to the remote file</span> |
| <span class="sd"> :type path: str</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.rename"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.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">from_name</span><span class="p">,</span> <span class="n">to_name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Rename a file.</span> |
| |
| <span class="sd"> :param from_name: rename file from name</span> |
| <span class="sd"> :param to_name: rename file to name</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">conn</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">from_name</span><span class="p">,</span> <span class="n">to_name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.get_mod_time"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.get_mod_time">[docs]</a> <span class="k">def</span> <span class="nf">get_mod_time</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">"""</span> |
| <span class="sd"> Returns a datetime object representing the last time the file was modified</span> |
| |
| <span class="sd"> :param path: remote file path</span> |
| <span class="sd"> :type path: string</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="n">ftp_mdtm</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">sendcmd</span><span class="p">(</span><span class="s1">'MDTM '</span> <span class="o">+</span> <span class="n">path</span><span class="p">)</span> |
| <span class="n">time_val</span> <span class="o">=</span> <span class="n">ftp_mdtm</span><span class="p">[</span><span class="mi">4</span><span class="p">:]</span> |
| <span class="c1"># time_val optionally has microseconds</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">time_val</span><span class="p">,</span> <span class="s2">"%Y%m</span><span class="si">%d</span><span class="s2">%H%M%S.</span><span class="si">%f</span><span class="s2">"</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">time_val</span><span class="p">,</span> <span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">%H%M%S'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="FTPHook.get_size"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPHook.get_size">[docs]</a> <span class="k">def</span> <span class="nf">get_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">"""</span> |
| <span class="sd"> Returns the size of a file (in bytes)</span> |
| |
| <span class="sd"> :param path: remote file path</span> |
| <span class="sd"> :type path: string</span> |
| <span class="sd"> """</span> |
| <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">conn</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">path</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="FTPSHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPSHook">[docs]</a><span class="k">class</span> <span class="nc">FTPSHook</span><span class="p">(</span><span class="n">FTPHook</span><span class="p">):</span> |
| |
| <div class="viewcode-block" id="FTPSHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/ftp_hook/index.html#airflow.contrib.hooks.ftp_hook.FTPSHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a FTPS connection object.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ftp_conn_id</span><span class="p">)</span> |
| <span class="n">pasv</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"passive"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">port</span><span class="p">:</span> |
| <span class="n">ftplib</span><span class="o">.</span><span class="n">FTP_TLS</span><span class="o">.</span><span class="n">port</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">port</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="n">ftplib</span><span class="o">.</span><span class="n">FTP_TLS</span><span class="p">(</span> |
| <span class="n">params</span><span class="o">.</span><span class="n">host</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">login</span><span class="p">,</span> <span class="n">params</span><span class="o">.</span><span class="n">password</span> |
| <span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">set_pasv</span><span class="p">(</span><span class="n">pasv</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </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> |
