|
46 | 46 |
|
47 | 47 |
|
48 | 48 |
|
49 |
| - <title>IOHandler — PyRemoteData 0.0.41 documentation</title> |
| 49 | + <title>IOHandler — PyRemoteData 0.0.42 documentation</title> |
50 | 50 | <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=75810a84" />
|
51 | 51 | <link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" />
|
52 | 52 | <link rel="stylesheet" type="text/css" href="_static/custom.css?v=fb6b2637" />
|
53 |
| - <script src="_static/documentation_options.js?v=20c5f126"></script> |
| 53 | + <script src="_static/documentation_options.js?v=173d7b4c"></script> |
54 | 54 | <script src="_static/doctools.js?v=9bcbadda"></script>
|
55 | 55 | <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
56 | 56 | <link rel="canonical" href="_build/html/IOHandler.html" />
|
|
81 | 81 | <nav class="md-header-nav md-grid">
|
82 | 82 | <div class="md-flex navheader">
|
83 | 83 | <div class="md-flex__cell md-flex__cell--shrink">
|
84 |
| - <a href="index.html" title="PyRemoteData 0.0.41 documentation" |
| 84 | + <a href="index.html" title="PyRemoteData 0.0.42 documentation" |
85 | 85 | class="md-header-nav__button md-logo">
|
86 | 86 |
|
87 | 87 |
|
|
167 | 167 | <nav class="md-tabs" data-md-component="tabs">
|
168 | 168 | <div class="md-tabs__inner md-grid">
|
169 | 169 | <ul class="md-tabs__list">
|
170 |
| - <li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.41 documentation</a></li> |
| 170 | + <li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.42 documentation</a></li> |
171 | 171 | <li class="md-tabs__item"><a href="implicit_mount.html" class="md-tabs__link">SFTP Backend</a></li>
|
172 | 172 | </ul>
|
173 | 173 | </div>
|
|
180 | 180 | <div class="md-sidebar__inner">
|
181 | 181 | <nav class="md-nav md-nav--primary" data-md-level="0">
|
182 | 182 | <label class="md-nav__title md-nav__title--site" for="__drawer">
|
183 |
| - <a href="index.html" title="PyRemoteData 0.0.41 documentation" class="md-nav__button md-logo"> |
| 183 | + <a href="index.html" title="PyRemoteData 0.0.42 documentation" class="md-nav__button md-logo"> |
184 | 184 |
|
185 | 185 | <img src="_static/" alt=" logo" width="48" height="48">
|
186 | 186 |
|
187 | 187 | </a>
|
188 | 188 | <a href="index.html"
|
189 |
| - title="PyRemoteData 0.0.41 documentation">PyRemoteData</a> |
| 189 | + title="PyRemoteData 0.0.42 documentation">PyRemoteData</a> |
190 | 190 | </label>
|
191 | 191 | <div class="md-nav__source">
|
192 | 192 | <a href="https://github.com/asgersvenning/pyremotedata" title="Go to repository" class="md-source" data-md-source="github">
|
@@ -326,13 +326,13 @@ <h1 id="iohandler--page-root">IOHandler<a class="headerlink" href="#iohandler--p
|
326 | 326 | </dd></dl>
|
327 | 327 | <dl class="py method">
|
328 | 328 | <dt class="sig sig-object py">
|
329 |
| -<span class="sig-name descname"><span class="pre">multi_download</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remote_paths</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_destination</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blocking</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pyremotedata/implicit_mount.html#IOHandler.multi_download"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt> |
| 329 | +<span class="sig-name descname"><span class="pre">multi_download</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remote_paths</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_destination</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">blocking</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/pyremotedata/implicit_mount.html#IOHandler.multi_download"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt> |
330 | 330 | <dd><p>Downloads a list of files from the remote directory to the given local destination.</p>
|
331 | 331 | <dl class="field-list simple">
|
332 | 332 | <dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
333 | 333 | <dd class="field-odd"><ul class="simple">
|
334 | 334 | <li><p><strong>remote_paths</strong> (<em>List</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – A list of remote paths to download.</p></li>
|
335 |
| -<li><p><strong>local_destination</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>List</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em><em>]</em>) – The local destination to download the files to. If None, the files will be downloaded to the current local directory.</p></li> |
| 335 | +<li><p><strong>local_destination</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The local destination to download the files to. If None, the files will be downloaded to the current local directory.</p></li> |
336 | 336 | <li><p><strong>blocking</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, the function will block until the download is complete.</p></li>
|
337 | 337 | <li><p><strong>n</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The number of connections to use for downloading each file.</p></li>
|
338 | 338 | <li><p><strong>**kwargs</strong> – Extra keyword arguments are ignored.</p></li>
|
|
0 commit comments