This commit is contained in:
Sarsoo 2022-11-28 22:33:50 +00:00
parent 2e7ecff013
commit 952da95867
9 changed files with 20 additions and 12 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -84,6 +84,8 @@
<li><a href="src/music.api.html#music.api.api.all_playlists_route">all_playlists_route() (in module music.api.api)</a>
</li>
<li><a href="src/music.api.html#music.api.api.all_users_route">all_users_route() (in module music.api.api)</a>
</li>
<li><a href="src/music.model.html#music.model.user.User.apns_tokens">apns_tokens (music.model.user.User attribute)</a>
</li>
<li><a href="src/music.model.html#music.model.tag.Tag.artists">artists (music.model.tag.Tag attribute)</a>
</li>

Binary file not shown.

File diff suppressed because one or more lines are too long

View File

@ -53,7 +53,7 @@
<span id="api-api"></span><h2>api.api<a class="headerlink" href="#module-music.api.api" title="Permalink to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.all_playlists_route">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">all_playlists_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.all_playlists_route" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">all_playlists_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.all_playlists_route" title="Permalink to this definition"></a></dt>
<dd><p>Retrieve all playlists for a given user</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
@ -70,32 +70,32 @@
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.all_users_route">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">all_users_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.all_users_route" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">all_users_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.all_users_route" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.change_password">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">change_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.change_password" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">change_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.change_password" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.image">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.image" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">image</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.image" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.playlist_get_delete_route">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">playlist_get_delete_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.playlist_get_delete_route" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">playlist_get_delete_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.playlist_get_delete_route" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.playlist_post_put_route">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">playlist_post_put_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.playlist_post_put_route" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">playlist_post_put_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.playlist_post_put_route" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.run_playlist">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">run_playlist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.run_playlist" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">run_playlist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.run_playlist" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
@ -105,7 +105,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.run_user">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">run_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.run_user" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">run_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.run_user" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
@ -115,17 +115,17 @@
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.run_users">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">run_users</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.run_users" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">run_users</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.run_users" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.user_delete_route">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">user_delete_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.user_delete_route" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">user_delete_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.user_delete_route" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="music.api.api.user_route">
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">user_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.user_route" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">music.api.api.</span></span><span class="sig-name descname"><span class="pre">user_route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="music.model.html#music.model.user.User" title="music.model.user.User"><span class="pre">User</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.api.api.user_route" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>

View File

@ -271,6 +271,7 @@
<li class="toctree-l3"><a class="reference internal" href="music.model.html#music.model.user.User"><code class="docutils literal notranslate"><span class="pre">User</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="music.model.html#music.model.user.User.Meta"><code class="docutils literal notranslate"><span class="pre">User.Meta</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="music.model.html#music.model.user.User.access_token"><code class="docutils literal notranslate"><span class="pre">User.access_token</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="music.model.html#music.model.user.User.apns_tokens"><code class="docutils literal notranslate"><span class="pre">User.apns_tokens</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="music.model.html#music.model.user.User.check_password"><code class="docutils literal notranslate"><span class="pre">User.check_password()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="music.model.html#music.model.user.User.collection"><code class="docutils literal notranslate"><span class="pre">User.collection</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="music.model.html#music.model.user.User.collection_name"><code class="docutils literal notranslate"><span class="pre">User.collection_name</span></code></a></li>

View File

@ -442,6 +442,11 @@
<span class="sig-name descname"><span class="pre">access_token</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#music.model.user.User.access_token" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="music.model.user.User.apns_tokens">
<span class="sig-name descname"><span class="pre">apns_tokens</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#music.model.user.User.apns_tokens" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="music.model.user.User.check_password">
<span class="sig-name descname"><span class="pre">check_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">password</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#music.model.user.User.check_password" title="Permalink to this definition"></a></dt>