Skip to content

Commit fb64ca0

Browse files
committed
Merge branch 'master' of github.com:asgersvenning/pyremotedata
2 parents be6a364 + a89599c commit fb64ca0

22 files changed

+283
-264
lines changed

docs/_build/html/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 93443d61ba22c056372c068d09ee27f4
3+
config: 21c4a10ca95e0fad1e8e3c678c689fc2
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/.buildinfo.bak

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: a0619ffc553f9c25977c4a66dfa203be
3+
config: 93443d61ba22c056372c068d09ee27f4
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/IOHandler.html

+29-6
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@
4646

4747

4848

49-
<title>IOHandler &#8212; PyRemoteData 0.0.37 documentation</title>
49+
<title>IOHandler &#8212; PyRemoteData 0.0.38 documentation</title>
5050
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=75810a84" />
5151
<link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" />
5252
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=fb6b2637" />
53-
<script src="_static/documentation_options.js?v=aa2ad26f"></script>
53+
<script src="_static/documentation_options.js?v=423071ad"></script>
5454
<script src="_static/doctools.js?v=9bcbadda"></script>
5555
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<link rel="canonical" href="_build/html/IOHandler.html" />
@@ -81,7 +81,7 @@
8181
<nav class="md-header-nav md-grid">
8282
<div class="md-flex navheader">
8383
<div class="md-flex__cell md-flex__cell--shrink">
84-
<a href="index.html" title="PyRemoteData 0.0.37 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.38 documentation"
8585
class="md-header-nav__button md-logo">
8686

8787
&nbsp;
@@ -167,7 +167,7 @@
167167
<nav class="md-tabs" data-md-component="tabs">
168168
<div class="md-tabs__inner md-grid">
169169
<ul class="md-tabs__list">
170-
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.37 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.38 documentation</a></li>
171171
<li class="md-tabs__item"><a href="implicit_mount.html" class="md-tabs__link">SFTP Backend</a></li>
172172
</ul>
173173
</div>
@@ -180,13 +180,13 @@
180180
<div class="md-sidebar__inner">
181181
<nav class="md-nav md-nav--primary" data-md-level="0">
182182
<label class="md-nav__title md-nav__title--site" for="__drawer">
183-
<a href="index.html" title="PyRemoteData 0.0.37 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.38 documentation" class="md-nav__button md-logo">
184184

185185
<img src="_static/" alt=" logo" width="48" height="48">
186186

187187
</a>
188188
<a href="index.html"
189-
title="PyRemoteData 0.0.37 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.38 documentation">PyRemoteData</a>
190190
</label>
191191
<div class="md-nav__source">
192192
<a href="https://github.com/asgersvenning/pyremotedata" title="Go to repository" class="md-source" data-md-source="github">
@@ -303,6 +303,29 @@ <h1 id="iohandler--page-root">IOHandler<a class="headerlink" href="#iohandler--p
303303
</dd></dl>
304304
<dl class="py method">
305305
<dt class="sig sig-object py">
306+
<span class="sig-name descname"><span class="pre">lcd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">local_path</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyremotedata/implicit_mount.html#IOHandler.lcd"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
307+
<dd><p>Changes the current local directory using the LFTP command <cite>lcd</cite>.</p>
308+
<dl class="field-list simple">
309+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
310+
<dd class="field-odd"><p><strong>local_path</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 directory to change to.</p>
311+
</dd>
312+
</dl>
313+
</dd></dl>
314+
<dl class="py method">
315+
<dt class="sig sig-object py">
316+
<span class="sig-name descname"><span class="pre">lpwd</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyremotedata/implicit_mount.html#IOHandler.lpwd"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
317+
<dd><p>Get the current local directory using the LFTP command <cite>lpwd</cite>.</p>
318+
<dl class="field-list simple">
319+
<dt class="field-odd">Returns<span class="colon">:</span></dt>
320+
<dd class="field-odd"><p>The current local directory.</p>
321+
</dd>
322+
<dt class="field-even">Return type<span class="colon">:</span></dt>
323+
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a></p>
324+
</dd>
325+
</dl>
326+
</dd></dl>
327+
<dl class="py method">
328+
<dt class="sig sig-object py">
306329
<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>
307330
<dd><p>Downloads a list of files from the remote directory to the given local destination.</p>
308331
<dl class="field-list simple">

docs/_build/html/ImplicitMount.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@
4646

4747

4848

49-
<title>ImplicitMount &#8212; PyRemoteData 0.0.37 documentation</title>
49+
<title>ImplicitMount &#8212; PyRemoteData 0.0.38 documentation</title>
5050
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=75810a84" />
5151
<link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" />
5252
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=fb6b2637" />
53-
<script src="_static/documentation_options.js?v=aa2ad26f"></script>
53+
<script src="_static/documentation_options.js?v=423071ad"></script>
5454
<script src="_static/doctools.js?v=9bcbadda"></script>
5555
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<link rel="canonical" href="_build/html/ImplicitMount.html" />
@@ -81,7 +81,7 @@
8181
<nav class="md-header-nav md-grid">
8282
<div class="md-flex navheader">
8383
<div class="md-flex__cell md-flex__cell--shrink">
84-
<a href="index.html" title="PyRemoteData 0.0.37 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.38 documentation"
8585
class="md-header-nav__button md-logo">
8686

8787
&nbsp;
@@ -167,7 +167,7 @@
167167
<nav class="md-tabs" data-md-component="tabs">
168168
<div class="md-tabs__inner md-grid">
169169
<ul class="md-tabs__list">
170-
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.37 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.38 documentation</a></li>
171171
<li class="md-tabs__item"><a href="implicit_mount.html" class="md-tabs__link">SFTP Backend</a></li>
172172
</ul>
173173
</div>
@@ -180,13 +180,13 @@
180180
<div class="md-sidebar__inner">
181181
<nav class="md-nav md-nav--primary" data-md-level="0">
182182
<label class="md-nav__title md-nav__title--site" for="__drawer">
183-
<a href="index.html" title="PyRemoteData 0.0.37 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.38 documentation" class="md-nav__button md-logo">
184184

185185
<img src="_static/" alt=" logo" width="48" height="48">
186186

187187
</a>
188188
<a href="index.html"
189-
title="PyRemoteData 0.0.37 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.38 documentation">PyRemoteData</a>
190190
</label>
191191
<div class="md-nav__source">
192192
<a href="https://github.com/asgersvenning/pyremotedata" title="Go to repository" class="md-source" data-md-source="github">

docs/_build/html/RemotePathDataLoader.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@
4646

4747

4848

49-
<title>RemotePathDataLoader &#8212; PyRemoteData 0.0.37 documentation</title>
49+
<title>RemotePathDataLoader &#8212; PyRemoteData 0.0.38 documentation</title>
5050
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=75810a84" />
5151
<link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" />
5252
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=fb6b2637" />
53-
<script src="_static/documentation_options.js?v=aa2ad26f"></script>
53+
<script src="_static/documentation_options.js?v=423071ad"></script>
5454
<script src="_static/doctools.js?v=9bcbadda"></script>
5555
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<link rel="canonical" href="_build/html/RemotePathDataLoader.html" />
@@ -80,7 +80,7 @@
8080
<nav class="md-header-nav md-grid">
8181
<div class="md-flex navheader">
8282
<div class="md-flex__cell md-flex__cell--shrink">
83-
<a href="index.html" title="PyRemoteData 0.0.37 documentation"
83+
<a href="index.html" title="PyRemoteData 0.0.38 documentation"
8484
class="md-header-nav__button md-logo">
8585

8686
&nbsp;
@@ -166,7 +166,7 @@
166166
<nav class="md-tabs" data-md-component="tabs">
167167
<div class="md-tabs__inner md-grid">
168168
<ul class="md-tabs__list">
169-
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.37 documentation</a></li>
169+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.38 documentation</a></li>
170170
<li class="md-tabs__item"><a href="dataloader.html" class="md-tabs__link">PyTorch Integration</a></li>
171171
</ul>
172172
</div>
@@ -179,13 +179,13 @@
179179
<div class="md-sidebar__inner">
180180
<nav class="md-nav md-nav--primary" data-md-level="0">
181181
<label class="md-nav__title md-nav__title--site" for="__drawer">
182-
<a href="index.html" title="PyRemoteData 0.0.37 documentation" class="md-nav__button md-logo">
182+
<a href="index.html" title="PyRemoteData 0.0.38 documentation" class="md-nav__button md-logo">
183183

184184
<img src="_static/" alt=" logo" width="48" height="48">
185185

186186
</a>
187187
<a href="index.html"
188-
title="PyRemoteData 0.0.37 documentation">PyRemoteData</a>
188+
title="PyRemoteData 0.0.38 documentation">PyRemoteData</a>
189189
</label>
190190
<div class="md-nav__source">
191191
<a href="https://github.com/asgersvenning/pyremotedata" title="Go to repository" class="md-source" data-md-source="github">

docs/_build/html/RemotePathDataset.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@
4646

4747

4848

49-
<title>RemotePathDataset &#8212; PyRemoteData 0.0.37 documentation</title>
49+
<title>RemotePathDataset &#8212; PyRemoteData 0.0.38 documentation</title>
5050
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=75810a84" />
5151
<link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" />
5252
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=fb6b2637" />
53-
<script src="_static/documentation_options.js?v=aa2ad26f"></script>
53+
<script src="_static/documentation_options.js?v=423071ad"></script>
5454
<script src="_static/doctools.js?v=9bcbadda"></script>
5555
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<link rel="canonical" href="_build/html/RemotePathDataset.html" />
@@ -81,7 +81,7 @@
8181
<nav class="md-header-nav md-grid">
8282
<div class="md-flex navheader">
8383
<div class="md-flex__cell md-flex__cell--shrink">
84-
<a href="index.html" title="PyRemoteData 0.0.37 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.38 documentation"
8585
class="md-header-nav__button md-logo">
8686

8787
&nbsp;
@@ -167,7 +167,7 @@
167167
<nav class="md-tabs" data-md-component="tabs">
168168
<div class="md-tabs__inner md-grid">
169169
<ul class="md-tabs__list">
170-
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.37 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.38 documentation</a></li>
171171
<li class="md-tabs__item"><a href="dataloader.html" class="md-tabs__link">PyTorch Integration</a></li>
172172
</ul>
173173
</div>
@@ -180,13 +180,13 @@
180180
<div class="md-sidebar__inner">
181181
<nav class="md-nav md-nav--primary" data-md-level="0">
182182
<label class="md-nav__title md-nav__title--site" for="__drawer">
183-
<a href="index.html" title="PyRemoteData 0.0.37 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.38 documentation" class="md-nav__button md-logo">
184184

185185
<img src="_static/" alt=" logo" width="48" height="48">
186186

187187
</a>
188188
<a href="index.html"
189-
title="PyRemoteData 0.0.37 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.38 documentation">PyRemoteData</a>
190190
</label>
191191
<div class="md-nav__source">
192192
<a href="https://github.com/asgersvenning/pyremotedata" title="Go to repository" class="md-source" data-md-source="github">

docs/_build/html/RemotePathIterator.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@
4646

4747

4848

49-
<title>RemotePathIterator &#8212; PyRemoteData 0.0.37 documentation</title>
49+
<title>RemotePathIterator &#8212; PyRemoteData 0.0.38 documentation</title>
5050
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=75810a84" />
5151
<link rel="stylesheet" type="text/css" href="_static/material.css?v=79c92029" />
5252
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=fb6b2637" />
53-
<script src="_static/documentation_options.js?v=aa2ad26f"></script>
53+
<script src="_static/documentation_options.js?v=423071ad"></script>
5454
<script src="_static/doctools.js?v=9bcbadda"></script>
5555
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
5656
<link rel="canonical" href="_build/html/RemotePathIterator.html" />
@@ -81,7 +81,7 @@
8181
<nav class="md-header-nav md-grid">
8282
<div class="md-flex navheader">
8383
<div class="md-flex__cell md-flex__cell--shrink">
84-
<a href="index.html" title="PyRemoteData 0.0.37 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.38 documentation"
8585
class="md-header-nav__button md-logo">
8686

8787
&nbsp;
@@ -167,7 +167,7 @@
167167
<nav class="md-tabs" data-md-component="tabs">
168168
<div class="md-tabs__inner md-grid">
169169
<ul class="md-tabs__list">
170-
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.37 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.38 documentation</a></li>
171171
<li class="md-tabs__item"><a href="implicit_mount.html" class="md-tabs__link">SFTP Backend</a></li>
172172
</ul>
173173
</div>
@@ -180,13 +180,13 @@
180180
<div class="md-sidebar__inner">
181181
<nav class="md-nav md-nav--primary" data-md-level="0">
182182
<label class="md-nav__title md-nav__title--site" for="__drawer">
183-
<a href="index.html" title="PyRemoteData 0.0.37 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.38 documentation" class="md-nav__button md-logo">
184184

185185
<img src="_static/" alt=" logo" width="48" height="48">
186186

187187
</a>
188188
<a href="index.html"
189-
title="PyRemoteData 0.0.37 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.38 documentation">PyRemoteData</a>
190190
</label>
191191
<div class="md-nav__source">
192192
<a href="https://github.com/asgersvenning/pyremotedata" title="Go to repository" class="md-source" data-md-source="github">

0 commit comments

Comments
 (0)