Skip to content

Commit

Permalink
deploy: be2eb83
Browse files Browse the repository at this point in the history
  • Loading branch information
@hagenw
hagenw committed Jan 23, 2025
1 parent 328f1cb commit f70f5d7
Show file tree
Hide file tree
Showing 42 changed files with 432 additions and 417 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6f2959273866350c254233cd99575444
config: 6a06f42eb38b9bd5df94f45761710056
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified .doctrees/changelog.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/install.doctree
View file
Binary file not shown.
66 changes: 34 additions & 32 deletions _modules/audbackend/core/backend/artifactory.html
View file

Large diffs are not rendered by default.

102 changes: 51 additions & 51 deletions _modules/audbackend/core/backend/base.html
View file

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions _modules/audbackend/core/backend/filesystem.html
View file

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions _modules/audbackend/core/backend/minio.html
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions _modules/audbackend/core/errors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@


<div class="version">
2.2.1
2.2.2
</div>


Expand Down Expand Up @@ -142,7 +142,7 @@
<div itemprop="articleBody">

<h1>Source code for audbackend.core.errors</h1><div class="highlight"><pre>
<div class="viewcode-block" id="BackendError"><a class="viewcode-back" href="../../../api/audbackend.BackendError.html#audbackend.BackendError">[docs]</a><span></span><span class="k">class</span> <span class="nc">BackendError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<div class="viewcode-block" id="BackendError"><a class="viewcode-back" href="../../../api/audbackend.BackendError.html#audbackend.BackendError">[docs]</a><span></span><span class="k">class</span><span class="w"> </span><span class="nc">BackendError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Wrapper for any error raised on the backend.</span>

<span class="sd"> Args:</span>
Expand Down Expand Up @@ -173,7 +173,7 @@ <h1>Source code for audbackend.core.errors</h1><div class="highlight"><pre>

<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">exception</span><span class="p">:</span> <span class="ne">Exception</span><span class="p">,</span>
<span class="p">):</span>
Expand All @@ -199,15 +199,15 @@ <h1>Source code for audbackend.core.errors</h1><div class="highlight"><pre>



Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2024/11/27 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2025/01/23 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2021-2024 audEERING GmbH
&copy; 2021-2025 audEERING GmbH
</p>
</div>

Expand Down
26 changes: 13 additions & 13 deletions _modules/audbackend/core/interface/base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@


<div class="version">
2.2.1
2.2.2
</div>


Expand Down Expand Up @@ -142,10 +142,10 @@
<div itemprop="articleBody">

<h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">audbackend.core.backend.base</span> <span class="kn">import</span> <span class="n">Base</span> <span class="k">as</span> <span class="n">Backend</span>
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">audbackend.core.backend.base</span><span class="w"> </span><span class="kn">import</span> <span class="n">Base</span> <span class="k">as</span> <span class="n">Backend</span>


<div class="viewcode-block" id="Base"><a class="viewcode-back" href="../../../../api/audbackend.interface.Base.html#audbackend.interface.Base">[docs]</a><span class="k">class</span> <span class="nc">Base</span><span class="p">:</span>
<div class="viewcode-block" id="Base"><a class="viewcode-back" href="../../../../api/audbackend.interface.Base.html#audbackend.interface.Base">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">Base</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Interface base class.</span>

<span class="sd"> Provides an interface to a backend,</span>
Expand All @@ -162,18 +162,18 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p

<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">backend</span><span class="p">:</span> <span class="n">Backend</span><span class="p">,</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_backend</span> <span class="o">=</span> <span class="n">backend</span>

<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span> <span class="c1"># noqa: D105</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span> <span class="c1"># noqa: D105</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;audbackend.interface.</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">(</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_backend</span><span class="si">}</span><span class="s2">)&quot;</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">backend</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Backend</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">backend</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Backend</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Backend object.</span>

<span class="sd"> Returns:</span>
Expand All @@ -192,7 +192,7 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_backend</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">host</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">host</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Host path.</span>

<span class="sd"> Returns: host path</span>
Expand All @@ -204,7 +204,7 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">host</span>

<div class="viewcode-block" id="Base.join"><a class="viewcode-back" href="../../../../api/audbackend.interface.Base.html#audbackend.interface.Base.join">[docs]</a> <span class="k">def</span> <span class="nf">join</span><span class="p">(</span>
<div class="viewcode-block" id="Base.join"><a class="viewcode-back" href="../../../../api/audbackend.interface.Base.html#audbackend.interface.Base.join">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">join</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="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="n">paths</span><span class="p">,</span>
Expand Down Expand Up @@ -235,7 +235,7 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="o">*</span><span class="n">paths</span><span class="p">)</span></div>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">repository</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">repository</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Repository name.</span>

<span class="sd"> Returns:</span>
Expand All @@ -249,7 +249,7 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">repository</span>

<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">sep</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">def</span><span class="w"> </span><span class="nf">sep</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;File separator on backend.</span>

<span class="sd"> Returns:</span>
Expand All @@ -262,7 +262,7 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">backend</span><span class="o">.</span><span class="n">sep</span>

<div class="viewcode-block" id="Base.split"><a class="viewcode-back" href="../../../../api/audbackend.interface.Base.html#audbackend.interface.Base.split">[docs]</a> <span class="k">def</span> <span class="nf">split</span><span class="p">(</span>
<div class="viewcode-block" id="Base.split"><a class="viewcode-back" href="../../../../api/audbackend.interface.Base.html#audbackend.interface.Base.split">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">split</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="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
Expand Down Expand Up @@ -305,15 +305,15 @@ <h1>Source code for audbackend.core.interface.base</h1><div class="highlight"><p



Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2024/11/27 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2025/01/23 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2021-2024 audEERING GmbH
&copy; 2021-2025 audEERING GmbH
</p>
</div>

Expand Down
34 changes: 17 additions & 17 deletions _modules/audbackend/core/interface/maven.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@


<div class="version">
2.2.1
2.2.2
</div>


Expand Down Expand Up @@ -142,20 +142,20 @@
<div itemprop="articleBody">

<h1>Source code for audbackend.core.interface.maven</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Sequence</span>
<span class="kn">import</span> <span class="nn">fnmatch</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Sequence</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">fnmatch</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>

<span class="kn">import</span> <span class="nn">audeer</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">audeer</span>

<span class="kn">from</span> <span class="nn">audbackend.core</span> <span class="kn">import</span> <span class="n">utils</span>
<span class="kn">from</span> <span class="nn">audbackend.core.backend.base</span> <span class="kn">import</span> <span class="n">Base</span> <span class="k">as</span> <span class="n">Backend</span>
<span class="kn">from</span> <span class="nn">audbackend.core.errors</span> <span class="kn">import</span> <span class="n">BackendError</span>
<span class="kn">from</span> <span class="nn">audbackend.core.interface.versioned</span> <span class="kn">import</span> <span class="n">Versioned</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">audbackend.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">utils</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">audbackend.core.backend.base</span><span class="w"> </span><span class="kn">import</span> <span class="n">Base</span> <span class="k">as</span> <span class="n">Backend</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">audbackend.core.errors</span><span class="w"> </span><span class="kn">import</span> <span class="n">BackendError</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">audbackend.core.interface.versioned</span><span class="w"> </span><span class="kn">import</span> <span class="n">Versioned</span>


<div class="viewcode-block" id="Maven"><a class="viewcode-back" href="../../../../api/audbackend.interface.Maven.html#audbackend.interface.Maven">[docs]</a><span class="k">class</span> <span class="nc">Maven</span><span class="p">(</span><span class="n">Versioned</span><span class="p">):</span>
<div class="viewcode-block" id="Maven"><a class="viewcode-back" href="../../../../api/audbackend.interface.Maven.html#audbackend.interface.Maven">[docs]</a><span class="k">class</span><span class="w"> </span><span class="nc">Maven</span><span class="p">(</span><span class="n">Versioned</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Interface for Maven style versioned file access.</span>

<span class="sd"> Use this interface,</span>
Expand Down Expand Up @@ -228,7 +228,7 @@ <h1>Source code for audbackend.core.interface.maven</h1><div class="highlight"><

<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">backend</span><span class="p">:</span> <span class="n">Backend</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
Expand All @@ -239,7 +239,7 @@ <h1>Source code for audbackend.core.interface.maven</h1><div class="highlight"><
<span class="bp">self</span><span class="o">.</span><span class="n">extensions</span> <span class="o">=</span> <span class="n">extensions</span>
<span class="bp">self</span><span class="o">.</span><span class="n">regex</span> <span class="o">=</span> <span class="n">regex</span>

<div class="viewcode-block" id="Maven.ls"><a class="viewcode-back" href="../../../../api/audbackend.interface.Maven.html#audbackend.interface.Maven.ls">[docs]</a> <span class="k">def</span> <span class="nf">ls</span><span class="p">(</span>
<div class="viewcode-block" id="Maven.ls"><a class="viewcode-back" href="../../../../api/audbackend.interface.Maven.html#audbackend.interface.Maven.ls">[docs]</a> <span class="k">def</span><span class="w"> </span><span class="nf">ls</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="nb">str</span> <span class="o">=</span> <span class="s2">&quot;/&quot;</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h1>Source code for audbackend.core.interface.maven</h1><div class="highlight"><

<span class="k">return</span> <span class="n">paths_and_versions</span></div>

<span class="k">def</span> <span class="nf">_split_ext</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_split_ext</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
Expand Down Expand Up @@ -423,7 +423,7 @@ <h1>Source code for audbackend.core.interface.maven</h1><div class="highlight"><

<span class="k">return</span> <span class="n">base</span><span class="p">,</span> <span class="n">ext</span>

<span class="k">def</span> <span class="nf">_path_with_version</span><span class="p">(</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_path_with_version</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="nb">str</span><span class="p">,</span>
<span class="n">version</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
Expand Down Expand Up @@ -455,15 +455,15 @@ <h1>Source code for audbackend.core.interface.maven</h1><div class="highlight"><



Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2024/11/27 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2025/01/23 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; 2021-2024 audEERING GmbH
&copy; 2021-2025 audEERING GmbH
</p>
</div>

Expand Down
Loading

0 comments on commit f70f5d7

Please sign in to comment.