Skip to content

Commit 6b81629

Browse files
committedFeb 19, 2025·
Merge branch 'master' of github.com:asgersvenning/pyremotedata
2 parents 7da90aa + 5932e90 commit 6b81629

21 files changed

+130
-121
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: 692492e2c84316a76b9978da0589b880
3+
config: b4a519d49320c932d1087956648b1b2a
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: fb62a8e079e5e6286d6229b4a102f855
3+
config: 692492e2c84316a76b9978da0589b880
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_build/html/IOHandler.html

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

4747

4848

49-
<title>IOHandler &#8212; PyRemoteData 0.0.40 documentation</title>
49+
<title>IOHandler &#8212; PyRemoteData 0.0.41 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=84bd753f"></script>
53+
<script src="_static/documentation_options.js?v=20c5f126"></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.40 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.41 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.40 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.41 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/ImplicitMount.html

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

4747

4848

49-
<title>ImplicitMount &#8212; PyRemoteData 0.0.40 documentation</title>
49+
<title>ImplicitMount &#8212; PyRemoteData 0.0.41 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=84bd753f"></script>
53+
<script src="_static/documentation_options.js?v=20c5f126"></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.40 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.41 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.40 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.41 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">
@@ -321,14 +321,16 @@ <h1 id="implicitmount--page-root">ImplicitMount<a class="headerlink" href="#impl
321321
</dd></dl>
322322
<dl class="py method">
323323
<dt class="sig sig-object py">
324-
<span class="sig-name descname"><span class="pre">ls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'.'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recursive</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">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cache</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><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#ImplicitMount.ls"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
324+
<span class="sig-name descname"><span class="pre">ls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'.'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">recursive</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">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_cache</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">pbar</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">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">top</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><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#ImplicitMount.ls"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
325325
<dd><p>Find all files in the given remote directory using the LFTP command <cite>cls</cite>. Can be used recursively, even though LFTP does not support recursive listing with the <cite>cls</cite> command.</p>
326326
<dl class="field-list simple">
327327
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
328328
<dd class="field-odd"><ul class="simple">
329329
<li><p><strong>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 remote directory to search in.</p></li>
330330
<li><p><strong>recursive</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 search recursively.</p></li>
331331
<li><p><strong>use_cache</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 use <cite>cls</cite>, otherwise it will use <cite>recls</cite>. <cite>recls</cite> forces a refresh of the cache.</p></li>
332+
<li><p><strong>pbar</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – If 1, prints something to show that the process is not dead, only relevant if recursive is True. Defaults to 0.</p></li>
333+
<li><p><strong>top</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – DO NOT USE! Flag to indicate whether the recursion is at the top level.</p></li>
332334
</ul>
333335
</dd>
334336
<dt class="field-even">Returns<span class="colon">:</span></dt>

‎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.40 documentation</title>
49+
<title>RemotePathDataLoader &#8212; PyRemoteData 0.0.41 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=84bd753f"></script>
53+
<script src="_static/documentation_options.js?v=20c5f126"></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.40 documentation"
83+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation</a></li>
169+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.41 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.40 documentation" class="md-nav__button md-logo">
182+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation">PyRemoteData</a>
188+
title="PyRemoteData 0.0.41 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.40 documentation</title>
49+
<title>RemotePathDataset &#8212; PyRemoteData 0.0.41 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=84bd753f"></script>
53+
<script src="_static/documentation_options.js?v=20c5f126"></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.40 documentation"
84+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation</a></li>
170+
<li class="md-tabs__item"><a href="index.html" class="md-tabs__link">PyRemoteData 0.0.41 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.40 documentation" class="md-nav__button md-logo">
183+
<a href="index.html" title="PyRemoteData 0.0.41 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.40 documentation">PyRemoteData</a>
189+
title="PyRemoteData 0.0.41 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)
Please sign in to comment.