Skip to content

Commit e4b9ead

Browse files
author
github-actions
committed
Docs build 2025-07-09
1 parent 55adec8 commit e4b9ead

File tree

6 files changed

+18
-6
lines changed

6 files changed

+18
-6
lines changed

en/latest/_sources/operations/files.rst.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ Download files from remote locations using ``curl`` or ``wget``.
167167
cache_time: int | None=None, force=False, sha384sum: str | None=None,
168168
sha256sum: str | None=None, sha1sum: str | None=None, md5sum: str | None=None,
169169
headers: dict[str, str] | None=None, insecure=False, proxy: str | None=None,
170-
temp_dir: str | Path | None=None, **kwargs,
170+
temp_dir: str | Path | None=None, extra_curl_args: dict[str, str] | None=None,
171+
extra_wget_args: dict[str, str] | None=None, **kwargs,
171172
)
172173
173174
+ **src**: source URL of the file
@@ -185,6 +186,8 @@ Download files from remote locations using ``curl`` or ``wget``.
185186
+ **insecure**: disable SSL verification for the HTTP request
186187
+ **proxy**: simple HTTP proxy through which we can download files, form `http://<yourproxy>:<port>`
187188
+ **temp_dir**: use this custom temporary directory during the download
189+
+ **extra_curl_args**: optional dictionary with custom arguments for curl
190+
+ **extra_wget_args**: optional dictionary with custom arguments for wget
188191

189192
**Example:**
190193

en/latest/operations/files.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,8 @@ <h1>Files Operations<a class="headerlink" href="#files-operations" title="Link t
343343
<span class="n">cache_time</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">sha384sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
344344
<span class="n">sha256sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sha1sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">md5sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
345345
<span class="n">headers</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">insecure</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">proxy</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
346-
<span class="n">temp_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
346+
<span class="n">temp_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_curl_args</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
347+
<span class="n">extra_wget_args</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
347348
<span class="p">)</span>
348349
</pre></div>
349350
</div>
@@ -363,6 +364,8 @@ <h1>Files Operations<a class="headerlink" href="#files-operations" title="Link t
363364
<li><p><strong>insecure</strong>: disable SSL verification for the HTTP request</p></li>
364365
<li><p><strong>proxy</strong>: simple HTTP proxy through which we can download files, form <cite>http://&lt;yourproxy&gt;:&lt;port&gt;</cite></p></li>
365366
<li><p><strong>temp_dir</strong>: use this custom temporary directory during the download</p></li>
367+
<li><p><strong>extra_curl_args</strong>: optional dictionary with custom arguments for curl</p></li>
368+
<li><p><strong>extra_wget_args</strong>: optional dictionary with custom arguments for wget</p></li>
366369
</ul>
367370
<p><strong>Example:</strong></p>
368371
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="o">.</span><span class="n">download</span><span class="p">(</span>

en/latest/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

en/next/_sources/operations/files.rst.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,8 @@ Download files from remote locations using ``curl`` or ``wget``.
167167
cache_time: int | None=None, force=False, sha384sum: str | None=None,
168168
sha256sum: str | None=None, sha1sum: str | None=None, md5sum: str | None=None,
169169
headers: dict[str, str] | None=None, insecure=False, proxy: str | None=None,
170-
temp_dir: str | Path | None=None, **kwargs,
170+
temp_dir: str | Path | None=None, extra_curl_args: dict[str, str] | None=None,
171+
extra_wget_args: dict[str, str] | None=None, **kwargs,
171172
)
172173
173174
+ **src**: source URL of the file
@@ -185,6 +186,8 @@ Download files from remote locations using ``curl`` or ``wget``.
185186
+ **insecure**: disable SSL verification for the HTTP request
186187
+ **proxy**: simple HTTP proxy through which we can download files, form `http://<yourproxy>:<port>`
187188
+ **temp_dir**: use this custom temporary directory during the download
189+
+ **extra_curl_args**: optional dictionary with custom arguments for curl
190+
+ **extra_wget_args**: optional dictionary with custom arguments for wget
188191

189192
**Example:**
190193

en/next/operations/files.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,8 @@ <h1>Files Operations<a class="headerlink" href="#files-operations" title="Link t
343343
<span class="n">cache_time</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">sha384sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
344344
<span class="n">sha256sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sha1sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">md5sum</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
345345
<span class="n">headers</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">insecure</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">proxy</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
346-
<span class="n">temp_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
346+
<span class="n">temp_dir</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">Path</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_curl_args</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
347+
<span class="n">extra_wget_args</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
347348
<span class="p">)</span>
348349
</pre></div>
349350
</div>
@@ -363,6 +364,8 @@ <h1>Files Operations<a class="headerlink" href="#files-operations" title="Link t
363364
<li><p><strong>insecure</strong>: disable SSL verification for the HTTP request</p></li>
364365
<li><p><strong>proxy</strong>: simple HTTP proxy through which we can download files, form <cite>http://&lt;yourproxy&gt;:&lt;port&gt;</cite></p></li>
365366
<li><p><strong>temp_dir</strong>: use this custom temporary directory during the download</p></li>
367+
<li><p><strong>extra_curl_args</strong>: optional dictionary with custom arguments for curl</p></li>
368+
<li><p><strong>extra_wget_args</strong>: optional dictionary with custom arguments for wget</p></li>
366369
</ul>
367370
<p><strong>Example:</strong></p>
368371
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="o">.</span><span class="n">download</span><span class="p">(</span>

en/next/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)