mirror of
https://github.com/unshackle-dl/unshackle.git
synced 2026-11-13 12:35:05 +00:00
Deployed 8cf1700 with MkDocs version: 1.6.1
This commit is contained in:
+319
-317
@@ -2648,7 +2648,8 @@ from config, cookies, retry handler, and a proxy if available.
|
||||
<span class="normal"><a href="#__codelineno-0-332">332</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-333">333</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-334">334</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-335">335</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-318"><a id="__codelineno-0-318" name="__codelineno-0-318"></a><span class="nd">@staticmethod</span>
|
||||
<span class="normal"><a href="#__codelineno-0-335">335</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-336">336</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-318"><a id="__codelineno-0-318" name="__codelineno-0-318"></a><span class="nd">@staticmethod</span>
|
||||
</span><span id="__span-0-319"><a id="__codelineno-0-319" name="__codelineno-0-319"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_session</span><span class="p">()</span> <span class="o">-></span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">:</span>
|
||||
</span><span id="__span-0-320"><a id="__codelineno-0-320" name="__codelineno-0-320"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-321"><a id="__codelineno-0-321" name="__codelineno-0-321"></a><span class="sd"> Creates a Python-requests Session, adds common headers</span>
|
||||
@@ -2661,11 +2662,12 @@ from config, cookies, retry handler, and a proxy if available.
|
||||
</span><span id="__span-0-328"><a id="__codelineno-0-328" name="__codelineno-0-328"></a> <span class="s2">"https://"</span><span class="p">,</span>
|
||||
</span><span id="__span-0-329"><a id="__codelineno-0-329" name="__codelineno-0-329"></a> <span class="n">HTTPAdapter</span><span class="p">(</span>
|
||||
</span><span id="__span-0-330"><a id="__codelineno-0-330" name="__codelineno-0-330"></a> <span class="n">max_retries</span><span class="o">=</span><span class="n">Retry</span><span class="p">(</span><span class="n">total</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">backoff_factor</span><span class="o">=</span><span class="mf">0.2</span><span class="p">,</span> <span class="n">status_forcelist</span><span class="o">=</span><span class="p">[</span><span class="mi">429</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span> <span class="mi">502</span><span class="p">,</span> <span class="mi">503</span><span class="p">,</span> <span class="mi">504</span><span class="p">]),</span>
|
||||
</span><span id="__span-0-331"><a id="__codelineno-0-331" name="__codelineno-0-331"></a> <span class="n">pool_block</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||||
</span><span id="__span-0-332"><a id="__codelineno-0-332" name="__codelineno-0-332"></a> <span class="p">),</span>
|
||||
</span><span id="__span-0-333"><a id="__codelineno-0-333" name="__codelineno-0-333"></a> <span class="p">)</span>
|
||||
</span><span id="__span-0-334"><a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="n">session</span><span class="o">.</span><span class="n">mount</span><span class="p">(</span><span class="s2">"http://"</span><span class="p">,</span> <span class="n">session</span><span class="o">.</span><span class="n">adapters</span><span class="p">[</span><span class="s2">"https://"</span><span class="p">])</span>
|
||||
</span><span id="__span-0-335"><a id="__codelineno-0-335" name="__codelineno-0-335"></a> <span class="k">return</span> <span class="n">session</span>
|
||||
</span><span id="__span-0-331"><a id="__codelineno-0-331" name="__codelineno-0-331"></a> <span class="n">pool_maxsize</span><span class="o">=</span><span class="mi">64</span><span class="p">,</span>
|
||||
</span><span id="__span-0-332"><a id="__codelineno-0-332" name="__codelineno-0-332"></a> <span class="n">pool_block</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||||
</span><span id="__span-0-333"><a id="__codelineno-0-333" name="__codelineno-0-333"></a> <span class="p">),</span>
|
||||
</span><span id="__span-0-334"><a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="p">)</span>
|
||||
</span><span id="__span-0-335"><a id="__codelineno-0-335" name="__codelineno-0-335"></a> <span class="n">session</span><span class="o">.</span><span class="n">mount</span><span class="p">(</span><span class="s2">"http://"</span><span class="p">,</span> <span class="n">session</span><span class="o">.</span><span class="n">adapters</span><span class="p">[</span><span class="s2">"https://"</span><span class="p">])</span>
|
||||
</span><span id="__span-0-336"><a id="__codelineno-0-336" name="__codelineno-0-336"></a> <span class="k">return</span> <span class="n">session</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -2697,8 +2699,7 @@ the Cookie jar into the service session.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-337">337</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-338">338</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-338">338</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-339">339</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-340">340</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-341">341</a></span>
|
||||
@@ -2717,27 +2718,28 @@ the Cookie jar into the service session.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-354">354</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-355">355</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-356">356</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-357">357</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-337"><a id="__codelineno-0-337" name="__codelineno-0-337"></a><span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cookies</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">CookieJar</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">credential</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Credential</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-338"><a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-339"><a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="sd"> Authenticate the Service with Cookies and/or Credentials (Email/Username and Password).</span>
|
||||
</span><span id="__span-0-340"><a id="__codelineno-0-340" name="__codelineno-0-340"></a>
|
||||
</span><span id="__span-0-341"><a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> This is effectively a login() function. Any API calls or object initializations</span>
|
||||
</span><span id="__span-0-342"><a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="sd"> needing to be made, should be made here. This will be run before any of the</span>
|
||||
</span><span id="__span-0-343"><a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="sd"> following abstract functions.</span>
|
||||
</span><span id="__span-0-344"><a id="__codelineno-0-344" name="__codelineno-0-344"></a>
|
||||
</span><span id="__span-0-345"><a id="__codelineno-0-345" name="__codelineno-0-345"></a><span class="sd"> You should avoid storing or using the Credential outside this function.</span>
|
||||
</span><span id="__span-0-346"><a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="sd"> Make any calls you need for any Cookies, Tokens, or such, then use those.</span>
|
||||
</span><span id="__span-0-347"><a id="__codelineno-0-347" name="__codelineno-0-347"></a>
|
||||
</span><span id="__span-0-348"><a id="__codelineno-0-348" name="__codelineno-0-348"></a><span class="sd"> The Cookie jar should also not be stored outside this function. However, you may load</span>
|
||||
</span><span id="__span-0-349"><a id="__codelineno-0-349" name="__codelineno-0-349"></a><span class="sd"> the Cookie jar into the service session.</span>
|
||||
</span><span id="__span-0-350"><a id="__codelineno-0-350" name="__codelineno-0-350"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-351"><a id="__codelineno-0-351" name="__codelineno-0-351"></a> <span class="k">if</span> <span class="n">cookies</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-352"><a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cookies</span><span class="p">,</span> <span class="n">CookieJar</span><span class="p">):</span>
|
||||
</span><span id="__span-0-353"><a id="__codelineno-0-353" name="__codelineno-0-353"></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Expected cookies to be a </span><span class="si">{</span><span class="n">CookieJar</span><span class="si">}</span><span class="s2">, not </span><span class="si">{</span><span class="n">cookies</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||||
</span><span id="__span-0-354"><a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">cookies</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cookies</span><span class="p">)</span>
|
||||
</span><span id="__span-0-355"><a id="__codelineno-0-355" name="__codelineno-0-355"></a>
|
||||
</span><span id="__span-0-356"><a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="c1"># Store credential for cache key generation</span>
|
||||
</span><span id="__span-0-357"><a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="bp">self</span><span class="o">.</span><span class="n">credential</span> <span class="o">=</span> <span class="n">credential</span>
|
||||
<span class="normal"><a href="#__codelineno-0-357">357</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-358">358</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-338"><a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cookies</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">CookieJar</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">credential</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Credential</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-339"><a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-340"><a id="__codelineno-0-340" name="__codelineno-0-340"></a><span class="sd"> Authenticate the Service with Cookies and/or Credentials (Email/Username and Password).</span>
|
||||
</span><span id="__span-0-341"><a id="__codelineno-0-341" name="__codelineno-0-341"></a>
|
||||
</span><span id="__span-0-342"><a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="sd"> This is effectively a login() function. Any API calls or object initializations</span>
|
||||
</span><span id="__span-0-343"><a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="sd"> needing to be made, should be made here. This will be run before any of the</span>
|
||||
</span><span id="__span-0-344"><a id="__codelineno-0-344" name="__codelineno-0-344"></a><span class="sd"> following abstract functions.</span>
|
||||
</span><span id="__span-0-345"><a id="__codelineno-0-345" name="__codelineno-0-345"></a>
|
||||
</span><span id="__span-0-346"><a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="sd"> You should avoid storing or using the Credential outside this function.</span>
|
||||
</span><span id="__span-0-347"><a id="__codelineno-0-347" name="__codelineno-0-347"></a><span class="sd"> Make any calls you need for any Cookies, Tokens, or such, then use those.</span>
|
||||
</span><span id="__span-0-348"><a id="__codelineno-0-348" name="__codelineno-0-348"></a>
|
||||
</span><span id="__span-0-349"><a id="__codelineno-0-349" name="__codelineno-0-349"></a><span class="sd"> The Cookie jar should also not be stored outside this function. However, you may load</span>
|
||||
</span><span id="__span-0-350"><a id="__codelineno-0-350" name="__codelineno-0-350"></a><span class="sd"> the Cookie jar into the service session.</span>
|
||||
</span><span id="__span-0-351"><a id="__codelineno-0-351" name="__codelineno-0-351"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-352"><a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="k">if</span> <span class="n">cookies</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-353"><a id="__codelineno-0-353" name="__codelineno-0-353"></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cookies</span><span class="p">,</span> <span class="n">CookieJar</span><span class="p">):</span>
|
||||
</span><span id="__span-0-354"><a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Expected cookies to be a </span><span class="si">{</span><span class="n">CookieJar</span><span class="si">}</span><span class="s2">, not </span><span class="si">{</span><span class="n">cookies</span><span class="si">!r}</span><span class="s2">."</span><span class="p">)</span>
|
||||
</span><span id="__span-0-355"><a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">cookies</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cookies</span><span class="p">)</span>
|
||||
</span><span id="__span-0-356"><a id="__codelineno-0-356" name="__codelineno-0-356"></a>
|
||||
</span><span id="__span-0-357"><a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="c1"># Store credential for cache key generation</span>
|
||||
</span><span id="__span-0-358"><a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="bp">self</span><span class="o">.</span><span class="n">credential</span> <span class="o">=</span> <span class="n">credential</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -2766,8 +2768,7 @@ delegates to the bridge which relays the prompt to the remote client.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-359">359</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-360">360</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-360">360</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-361">361</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-362">362</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-363">363</a></span>
|
||||
@@ -2778,19 +2779,20 @@ delegates to the bridge which relays the prompt to the remote client.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-368">368</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-369">369</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-370">370</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-371">371</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-359"><a id="__codelineno-0-359" name="__codelineno-0-359"></a><span class="k">def</span><span class="w"> </span><span class="nf">request_input</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
</span><span id="__span-0-360"><a id="__codelineno-0-360" name="__codelineno-0-360"></a><span class="w"> </span><span class="sd">"""Request interactive input from the user.</span>
|
||||
</span><span id="__span-0-361"><a id="__codelineno-0-361" name="__codelineno-0-361"></a>
|
||||
</span><span id="__span-0-362"><a id="__codelineno-0-362" name="__codelineno-0-362"></a><span class="sd"> When running locally (CLI), prompts via the shared rich console so the</span>
|
||||
</span><span id="__span-0-363"><a id="__codelineno-0-363" name="__codelineno-0-363"></a><span class="sd"> prompt renders correctly alongside Live progress / log handlers.</span>
|
||||
</span><span id="__span-0-364"><a id="__codelineno-0-364" name="__codelineno-0-364"></a><span class="sd"> When running in serve mode with an :class:`InputBridge` attached,</span>
|
||||
</span><span id="__span-0-365"><a id="__codelineno-0-365" name="__codelineno-0-365"></a><span class="sd"> delegates to the bridge which relays the prompt to the remote client.</span>
|
||||
</span><span id="__span-0-366"><a id="__codelineno-0-366" name="__codelineno-0-366"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-367"><a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_bridge</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-368"><a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_bridge</span><span class="o">.</span><span class="n">request_input</span><span class="p">(</span><span class="n">prompt</span><span class="p">)</span>
|
||||
</span><span id="__span-0-369"><a id="__codelineno-0-369" name="__codelineno-0-369"></a> <span class="n">indent</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="mi">5</span>
|
||||
</span><span id="__span-0-370"><a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="n">padded</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">+</span> <span class="n">prompt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">indent</span><span class="p">)</span>
|
||||
</span><span id="__span-0-371"><a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="k">return</span> <span class="n">console</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">Text</span><span class="p">(</span><span class="n">padded</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="s2">"text"</span><span class="p">))</span>
|
||||
<span class="normal"><a href="#__codelineno-0-371">371</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-372">372</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-360"><a id="__codelineno-0-360" name="__codelineno-0-360"></a><span class="k">def</span><span class="w"> </span><span class="nf">request_input</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
</span><span id="__span-0-361"><a id="__codelineno-0-361" name="__codelineno-0-361"></a><span class="w"> </span><span class="sd">"""Request interactive input from the user.</span>
|
||||
</span><span id="__span-0-362"><a id="__codelineno-0-362" name="__codelineno-0-362"></a>
|
||||
</span><span id="__span-0-363"><a id="__codelineno-0-363" name="__codelineno-0-363"></a><span class="sd"> When running locally (CLI), prompts via the shared rich console so the</span>
|
||||
</span><span id="__span-0-364"><a id="__codelineno-0-364" name="__codelineno-0-364"></a><span class="sd"> prompt renders correctly alongside Live progress / log handlers.</span>
|
||||
</span><span id="__span-0-365"><a id="__codelineno-0-365" name="__codelineno-0-365"></a><span class="sd"> When running in serve mode with an :class:`InputBridge` attached,</span>
|
||||
</span><span id="__span-0-366"><a id="__codelineno-0-366" name="__codelineno-0-366"></a><span class="sd"> delegates to the bridge which relays the prompt to the remote client.</span>
|
||||
</span><span id="__span-0-367"><a id="__codelineno-0-367" name="__codelineno-0-367"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-368"><a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_bridge</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-369"><a id="__codelineno-0-369" name="__codelineno-0-369"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_bridge</span><span class="o">.</span><span class="n">request_input</span><span class="p">(</span><span class="n">prompt</span><span class="p">)</span>
|
||||
</span><span id="__span-0-370"><a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="n">indent</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="mi">5</span>
|
||||
</span><span id="__span-0-371"><a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="n">padded</span> <span class="o">=</span> <span class="n">indent</span> <span class="o">+</span> <span class="n">prompt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">indent</span><span class="p">)</span>
|
||||
</span><span id="__span-0-372"><a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="k">return</span> <span class="n">console</span><span class="o">.</span><span class="n">input</span><span class="p">(</span><span class="n">Text</span><span class="p">(</span><span class="n">padded</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="s2">"text"</span><span class="p">))</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -2818,8 +2820,7 @@ Ideally just re-use the title ID argument (i.e. self.title).</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-373">373</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-374">374</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-374">374</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-375">375</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-376">376</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-377">377</a></span>
|
||||
@@ -2827,16 +2828,17 @@ Ideally just re-use the title ID argument (i.e. self.title).</p>
|
||||
<span class="normal"><a href="#__codelineno-0-379">379</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-380">380</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-381">381</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-382">382</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-373"><a id="__codelineno-0-373" name="__codelineno-0-373"></a><span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Generator</span><span class="p">[</span><span class="n">SearchResult</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||
</span><span id="__span-0-374"><a id="__codelineno-0-374" name="__codelineno-0-374"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-375"><a id="__codelineno-0-375" name="__codelineno-0-375"></a><span class="sd"> Search by query for titles from the Service.</span>
|
||||
</span><span id="__span-0-376"><a id="__codelineno-0-376" name="__codelineno-0-376"></a>
|
||||
</span><span id="__span-0-377"><a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="sd"> The query must be taken as a CLI argument by the Service class.</span>
|
||||
</span><span id="__span-0-378"><a id="__codelineno-0-378" name="__codelineno-0-378"></a><span class="sd"> Ideally just re-use the title ID argument (i.e. self.title).</span>
|
||||
</span><span id="__span-0-379"><a id="__codelineno-0-379" name="__codelineno-0-379"></a>
|
||||
</span><span id="__span-0-380"><a id="__codelineno-0-380" name="__codelineno-0-380"></a><span class="sd"> Search results will be displayed in the order yielded.</span>
|
||||
</span><span id="__span-0-381"><a id="__codelineno-0-381" name="__codelineno-0-381"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-382"><a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Search functionality has not been implemented by </span><span class="si">{</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="si">}</span><span class="s2">"</span><span class="p">)</span>
|
||||
<span class="normal"><a href="#__codelineno-0-382">382</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-383">383</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-374"><a id="__codelineno-0-374" name="__codelineno-0-374"></a><span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Generator</span><span class="p">[</span><span class="n">SearchResult</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||
</span><span id="__span-0-375"><a id="__codelineno-0-375" name="__codelineno-0-375"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-376"><a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="sd"> Search by query for titles from the Service.</span>
|
||||
</span><span id="__span-0-377"><a id="__codelineno-0-377" name="__codelineno-0-377"></a>
|
||||
</span><span id="__span-0-378"><a id="__codelineno-0-378" name="__codelineno-0-378"></a><span class="sd"> The query must be taken as a CLI argument by the Service class.</span>
|
||||
</span><span id="__span-0-379"><a id="__codelineno-0-379" name="__codelineno-0-379"></a><span class="sd"> Ideally just re-use the title ID argument (i.e. self.title).</span>
|
||||
</span><span id="__span-0-380"><a id="__codelineno-0-380" name="__codelineno-0-380"></a>
|
||||
</span><span id="__span-0-381"><a id="__codelineno-0-381" name="__codelineno-0-381"></a><span class="sd"> Search results will be displayed in the order yielded.</span>
|
||||
</span><span id="__span-0-382"><a id="__codelineno-0-382" name="__codelineno-0-382"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-383"><a id="__codelineno-0-383" name="__codelineno-0-383"></a> <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Search functionality has not been implemented by </span><span class="si">{</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="si">}</span><span class="s2">"</span><span class="p">)</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -2870,8 +2872,7 @@ Ideally just re-use the title ID argument (i.e. self.title).</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-384">384</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-385">385</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-385">385</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-386">386</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-387">387</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-388">388</a></span>
|
||||
@@ -2883,20 +2884,21 @@ Ideally just re-use the title ID argument (i.e. self.title).</p>
|
||||
<span class="normal"><a href="#__codelineno-0-394">394</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-395">395</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-396">396</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-397">397</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-384"><a id="__codelineno-0-384" name="__codelineno-0-384"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_widevine_service_certificate</span><span class="p">(</span>
|
||||
</span><span id="__span-0-385"><a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span>
|
||||
</span><span id="__span-0-386"><a id="__codelineno-0-386" name="__codelineno-0-386"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
||||
</span><span id="__span-0-387"><a id="__codelineno-0-387" name="__codelineno-0-387"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-388"><a id="__codelineno-0-388" name="__codelineno-0-388"></a><span class="sd"> Get the Widevine Service Certificate used for Privacy Mode.</span>
|
||||
</span><span id="__span-0-389"><a id="__codelineno-0-389" name="__codelineno-0-389"></a>
|
||||
</span><span id="__span-0-390"><a id="__codelineno-0-390" name="__codelineno-0-390"></a><span class="sd"> :param challenge: The service challenge, providing this to a License endpoint should return the</span>
|
||||
</span><span id="__span-0-391"><a id="__codelineno-0-391" name="__codelineno-0-391"></a><span class="sd"> privacy certificate that the service uses.</span>
|
||||
</span><span id="__span-0-392"><a id="__codelineno-0-392" name="__codelineno-0-392"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-393"><a id="__codelineno-0-393" name="__codelineno-0-393"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-394"><a id="__codelineno-0-394" name="__codelineno-0-394"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-395"><a id="__codelineno-0-395" name="__codelineno-0-395"></a><span class="sd"> :return: The Service Privacy Certificate as Bytes or a Base64 string. Don't Base64 Encode or</span>
|
||||
</span><span id="__span-0-396"><a id="__codelineno-0-396" name="__codelineno-0-396"></a><span class="sd"> Decode the data, return as is to reduce unnecessary computations.</span>
|
||||
</span><span id="__span-0-397"><a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-397">397</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-398">398</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-385"><a id="__codelineno-0-385" name="__codelineno-0-385"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_widevine_service_certificate</span><span class="p">(</span>
|
||||
</span><span id="__span-0-386"><a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span>
|
||||
</span><span id="__span-0-387"><a id="__codelineno-0-387" name="__codelineno-0-387"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
|
||||
</span><span id="__span-0-388"><a id="__codelineno-0-388" name="__codelineno-0-388"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-389"><a id="__codelineno-0-389" name="__codelineno-0-389"></a><span class="sd"> Get the Widevine Service Certificate used for Privacy Mode.</span>
|
||||
</span><span id="__span-0-390"><a id="__codelineno-0-390" name="__codelineno-0-390"></a>
|
||||
</span><span id="__span-0-391"><a id="__codelineno-0-391" name="__codelineno-0-391"></a><span class="sd"> :param challenge: The service challenge, providing this to a License endpoint should return the</span>
|
||||
</span><span id="__span-0-392"><a id="__codelineno-0-392" name="__codelineno-0-392"></a><span class="sd"> privacy certificate that the service uses.</span>
|
||||
</span><span id="__span-0-393"><a id="__codelineno-0-393" name="__codelineno-0-393"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-394"><a id="__codelineno-0-394" name="__codelineno-0-394"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-395"><a id="__codelineno-0-395" name="__codelineno-0-395"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-396"><a id="__codelineno-0-396" name="__codelineno-0-396"></a><span class="sd"> :return: The Service Privacy Certificate as Bytes or a Base64 string. Don't Base64 Encode or</span>
|
||||
</span><span id="__span-0-397"><a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="sd"> Decode the data, return as is to reduce unnecessary computations.</span>
|
||||
</span><span id="__span-0-398"><a id="__codelineno-0-398" name="__codelineno-0-398"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -2932,8 +2934,7 @@ revoked, disabled, or downgraded.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-399">399</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-400">400</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-400">400</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-401">401</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-402">402</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-403">403</a></span>
|
||||
@@ -2949,24 +2950,25 @@ revoked, disabled, or downgraded.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-413">413</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-414">414</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-415">415</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-416">416</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-399"><a id="__codelineno-0-399" name="__codelineno-0-399"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_widevine_license</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]:</span>
|
||||
</span><span id="__span-0-400"><a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-401"><a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="sd"> Get a Widevine License message by sending a License Request (challenge).</span>
|
||||
</span><span id="__span-0-402"><a id="__codelineno-0-402" name="__codelineno-0-402"></a>
|
||||
</span><span id="__span-0-403"><a id="__codelineno-0-403" name="__codelineno-0-403"></a><span class="sd"> This License message contains the encrypted Content Decryption Keys and will be</span>
|
||||
</span><span id="__span-0-404"><a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="sd"> read by the Cdm and decrypted.</span>
|
||||
</span><span id="__span-0-405"><a id="__codelineno-0-405" name="__codelineno-0-405"></a>
|
||||
</span><span id="__span-0-406"><a id="__codelineno-0-406" name="__codelineno-0-406"></a><span class="sd"> This is a very important request to get correct. A bad, unexpected, or missing</span>
|
||||
</span><span id="__span-0-407"><a id="__codelineno-0-407" name="__codelineno-0-407"></a><span class="sd"> value in the request can cause your key to be detected and promptly banned,</span>
|
||||
</span><span id="__span-0-408"><a id="__codelineno-0-408" name="__codelineno-0-408"></a><span class="sd"> revoked, disabled, or downgraded.</span>
|
||||
</span><span id="__span-0-409"><a id="__codelineno-0-409" name="__codelineno-0-409"></a>
|
||||
</span><span id="__span-0-410"><a id="__codelineno-0-410" name="__codelineno-0-410"></a><span class="sd"> :param challenge: The license challenge from the Widevine CDM.</span>
|
||||
</span><span id="__span-0-411"><a id="__codelineno-0-411" name="__codelineno-0-411"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-412"><a id="__codelineno-0-412" name="__codelineno-0-412"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-413"><a id="__codelineno-0-413" name="__codelineno-0-413"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-414"><a id="__codelineno-0-414" name="__codelineno-0-414"></a><span class="sd"> :return: The License response as Bytes or a Base64 string. Don't Base64 Encode or</span>
|
||||
</span><span id="__span-0-415"><a id="__codelineno-0-415" name="__codelineno-0-415"></a><span class="sd"> Decode the data, return as is to reduce unnecessary computations.</span>
|
||||
</span><span id="__span-0-416"><a id="__codelineno-0-416" name="__codelineno-0-416"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-416">416</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-417">417</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-400"><a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_widevine_license</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]:</span>
|
||||
</span><span id="__span-0-401"><a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-402"><a id="__codelineno-0-402" name="__codelineno-0-402"></a><span class="sd"> Get a Widevine License message by sending a License Request (challenge).</span>
|
||||
</span><span id="__span-0-403"><a id="__codelineno-0-403" name="__codelineno-0-403"></a>
|
||||
</span><span id="__span-0-404"><a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="sd"> This License message contains the encrypted Content Decryption Keys and will be</span>
|
||||
</span><span id="__span-0-405"><a id="__codelineno-0-405" name="__codelineno-0-405"></a><span class="sd"> read by the Cdm and decrypted.</span>
|
||||
</span><span id="__span-0-406"><a id="__codelineno-0-406" name="__codelineno-0-406"></a>
|
||||
</span><span id="__span-0-407"><a id="__codelineno-0-407" name="__codelineno-0-407"></a><span class="sd"> This is a very important request to get correct. A bad, unexpected, or missing</span>
|
||||
</span><span id="__span-0-408"><a id="__codelineno-0-408" name="__codelineno-0-408"></a><span class="sd"> value in the request can cause your key to be detected and promptly banned,</span>
|
||||
</span><span id="__span-0-409"><a id="__codelineno-0-409" name="__codelineno-0-409"></a><span class="sd"> revoked, disabled, or downgraded.</span>
|
||||
</span><span id="__span-0-410"><a id="__codelineno-0-410" name="__codelineno-0-410"></a>
|
||||
</span><span id="__span-0-411"><a id="__codelineno-0-411" name="__codelineno-0-411"></a><span class="sd"> :param challenge: The license challenge from the Widevine CDM.</span>
|
||||
</span><span id="__span-0-412"><a id="__codelineno-0-412" name="__codelineno-0-412"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-413"><a id="__codelineno-0-413" name="__codelineno-0-413"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-414"><a id="__codelineno-0-414" name="__codelineno-0-414"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-415"><a id="__codelineno-0-415" name="__codelineno-0-415"></a><span class="sd"> :return: The License response as Bytes or a Base64 string. Don't Base64 Encode or</span>
|
||||
</span><span id="__span-0-416"><a id="__codelineno-0-416" name="__codelineno-0-416"></a><span class="sd"> Decode the data, return as is to reduce unnecessary computations.</span>
|
||||
</span><span id="__span-0-417"><a id="__codelineno-0-417" name="__codelineno-0-417"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3002,8 +3004,7 @@ revoked, disabled, or downgraded.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-418">418</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-419">419</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-419">419</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-420">420</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-421">421</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-422">422</a></span>
|
||||
@@ -3023,28 +3024,29 @@ revoked, disabled, or downgraded.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-436">436</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-437">437</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-438">438</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-439">439</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-418"><a id="__codelineno-0-418" name="__codelineno-0-418"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_playready_license</span><span class="p">(</span>
|
||||
</span><span id="__span-0-419"><a id="__codelineno-0-419" name="__codelineno-0-419"></a> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span>
|
||||
</span><span id="__span-0-420"><a id="__codelineno-0-420" name="__codelineno-0-420"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]:</span>
|
||||
</span><span id="__span-0-421"><a id="__codelineno-0-421" name="__codelineno-0-421"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-422"><a id="__codelineno-0-422" name="__codelineno-0-422"></a><span class="sd"> Get a PlayReady License message by sending a License Request (challenge).</span>
|
||||
</span><span id="__span-0-423"><a id="__codelineno-0-423" name="__codelineno-0-423"></a>
|
||||
</span><span id="__span-0-424"><a id="__codelineno-0-424" name="__codelineno-0-424"></a><span class="sd"> This License message contains the encrypted Content Decryption Keys and will be</span>
|
||||
</span><span id="__span-0-425"><a id="__codelineno-0-425" name="__codelineno-0-425"></a><span class="sd"> read by the CDM and decrypted.</span>
|
||||
</span><span id="__span-0-426"><a id="__codelineno-0-426" name="__codelineno-0-426"></a>
|
||||
</span><span id="__span-0-427"><a id="__codelineno-0-427" name="__codelineno-0-427"></a><span class="sd"> This is a very important request to get correct. A bad, unexpected, or missing</span>
|
||||
</span><span id="__span-0-428"><a id="__codelineno-0-428" name="__codelineno-0-428"></a><span class="sd"> value in the request can cause your key to be detected and promptly banned,</span>
|
||||
</span><span id="__span-0-429"><a id="__codelineno-0-429" name="__codelineno-0-429"></a><span class="sd"> revoked, disabled, or downgraded.</span>
|
||||
</span><span id="__span-0-430"><a id="__codelineno-0-430" name="__codelineno-0-430"></a>
|
||||
</span><span id="__span-0-431"><a id="__codelineno-0-431" name="__codelineno-0-431"></a><span class="sd"> :param challenge: The license challenge from the PlayReady CDM.</span>
|
||||
</span><span id="__span-0-432"><a id="__codelineno-0-432" name="__codelineno-0-432"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-433"><a id="__codelineno-0-433" name="__codelineno-0-433"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-434"><a id="__codelineno-0-434" name="__codelineno-0-434"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-435"><a id="__codelineno-0-435" name="__codelineno-0-435"></a><span class="sd"> :return: The License response as Bytes or a Base64 string. Don't Base64 Encode or</span>
|
||||
</span><span id="__span-0-436"><a id="__codelineno-0-436" name="__codelineno-0-436"></a><span class="sd"> Decode the data, return as is to reduce unnecessary computations.</span>
|
||||
</span><span id="__span-0-437"><a id="__codelineno-0-437" name="__codelineno-0-437"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-438"><a id="__codelineno-0-438" name="__codelineno-0-438"></a> <span class="c1"># Delegates license handling to the Widevine license method by default if a service-specific PlayReady implementation is not provided.</span>
|
||||
</span><span id="__span-0-439"><a id="__codelineno-0-439" name="__codelineno-0-439"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_widevine_license</span><span class="p">(</span><span class="n">challenge</span><span class="o">=</span><span class="n">challenge</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span> <span class="n">track</span><span class="o">=</span><span class="n">track</span><span class="p">)</span>
|
||||
<span class="normal"><a href="#__codelineno-0-439">439</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-440">440</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-419"><a id="__codelineno-0-419" name="__codelineno-0-419"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_playready_license</span><span class="p">(</span>
|
||||
</span><span id="__span-0-420"><a id="__codelineno-0-420" name="__codelineno-0-420"></a> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span>
|
||||
</span><span id="__span-0-421"><a id="__codelineno-0-421" name="__codelineno-0-421"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]:</span>
|
||||
</span><span id="__span-0-422"><a id="__codelineno-0-422" name="__codelineno-0-422"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-423"><a id="__codelineno-0-423" name="__codelineno-0-423"></a><span class="sd"> Get a PlayReady License message by sending a License Request (challenge).</span>
|
||||
</span><span id="__span-0-424"><a id="__codelineno-0-424" name="__codelineno-0-424"></a>
|
||||
</span><span id="__span-0-425"><a id="__codelineno-0-425" name="__codelineno-0-425"></a><span class="sd"> This License message contains the encrypted Content Decryption Keys and will be</span>
|
||||
</span><span id="__span-0-426"><a id="__codelineno-0-426" name="__codelineno-0-426"></a><span class="sd"> read by the CDM and decrypted.</span>
|
||||
</span><span id="__span-0-427"><a id="__codelineno-0-427" name="__codelineno-0-427"></a>
|
||||
</span><span id="__span-0-428"><a id="__codelineno-0-428" name="__codelineno-0-428"></a><span class="sd"> This is a very important request to get correct. A bad, unexpected, or missing</span>
|
||||
</span><span id="__span-0-429"><a id="__codelineno-0-429" name="__codelineno-0-429"></a><span class="sd"> value in the request can cause your key to be detected and promptly banned,</span>
|
||||
</span><span id="__span-0-430"><a id="__codelineno-0-430" name="__codelineno-0-430"></a><span class="sd"> revoked, disabled, or downgraded.</span>
|
||||
</span><span id="__span-0-431"><a id="__codelineno-0-431" name="__codelineno-0-431"></a>
|
||||
</span><span id="__span-0-432"><a id="__codelineno-0-432" name="__codelineno-0-432"></a><span class="sd"> :param challenge: The license challenge from the PlayReady CDM.</span>
|
||||
</span><span id="__span-0-433"><a id="__codelineno-0-433" name="__codelineno-0-433"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-434"><a id="__codelineno-0-434" name="__codelineno-0-434"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-435"><a id="__codelineno-0-435" name="__codelineno-0-435"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-436"><a id="__codelineno-0-436" name="__codelineno-0-436"></a><span class="sd"> :return: The License response as Bytes or a Base64 string. Don't Base64 Encode or</span>
|
||||
</span><span id="__span-0-437"><a id="__codelineno-0-437" name="__codelineno-0-437"></a><span class="sd"> Decode the data, return as is to reduce unnecessary computations.</span>
|
||||
</span><span id="__span-0-438"><a id="__codelineno-0-438" name="__codelineno-0-438"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-439"><a id="__codelineno-0-439" name="__codelineno-0-439"></a> <span class="c1"># Delegates license handling to the Widevine license method by default if a service-specific PlayReady implementation is not provided.</span>
|
||||
</span><span id="__span-0-440"><a id="__codelineno-0-440" name="__codelineno-0-440"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_widevine_license</span><span class="p">(</span><span class="n">challenge</span><span class="o">=</span><span class="n">challenge</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="n">title</span><span class="p">,</span> <span class="n">track</span><span class="o">=</span><span class="n">track</span><span class="p">)</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3080,8 +3082,7 @@ and the license is a JWK Set, e.g. <code>{"keys": [{"kty": "oct", "k": "...", "k
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-441">441</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-442">442</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-442">442</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-443">443</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-444">444</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-445">445</a></span>
|
||||
@@ -3099,26 +3100,27 @@ and the license is a JWK Set, e.g. <code>{"keys": [{"kty": "oct", "k": "...", "k
|
||||
<span class="normal"><a href="#__codelineno-0-457">457</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-458">458</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-459">459</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-460">460</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-441"><a id="__codelineno-0-441" name="__codelineno-0-441"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_clearkey_license</span><span class="p">(</span>
|
||||
</span><span id="__span-0-442"><a id="__codelineno-0-442" name="__codelineno-0-442"></a> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span>
|
||||
</span><span id="__span-0-443"><a id="__codelineno-0-443" name="__codelineno-0-443"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">dict</span><span class="p">]]:</span>
|
||||
</span><span id="__span-0-444"><a id="__codelineno-0-444" name="__codelineno-0-444"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-445"><a id="__codelineno-0-445" name="__codelineno-0-445"></a><span class="sd"> Get a W3C ClearKey License (JWK Set) by sending a License Request (challenge).</span>
|
||||
</span><span id="__span-0-446"><a id="__codelineno-0-446" name="__codelineno-0-446"></a>
|
||||
</span><span id="__span-0-447"><a id="__codelineno-0-447" name="__codelineno-0-447"></a><span class="sd"> Used for DASH `org.w3.clearkey` content. No CDM is involved: the challenge is</span>
|
||||
</span><span id="__span-0-448"><a id="__codelineno-0-448" name="__codelineno-0-448"></a><span class="sd"> the W3C EME JSON license request, e.g. ``{"kids": ["<base64url>"], "type": "temporary"}``,</span>
|
||||
</span><span id="__span-0-449"><a id="__codelineno-0-449" name="__codelineno-0-449"></a><span class="sd"> and the license is a JWK Set, e.g. ``{"keys": [{"kty": "oct", "k": "...", "kid": "..."}]}``.</span>
|
||||
</span><span id="__span-0-450"><a id="__codelineno-0-450" name="__codelineno-0-450"></a>
|
||||
</span><span id="__span-0-451"><a id="__codelineno-0-451" name="__codelineno-0-451"></a><span class="sd"> :param challenge: The JSON license request bytes to POST to the license server.</span>
|
||||
</span><span id="__span-0-452"><a id="__codelineno-0-452" name="__codelineno-0-452"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-453"><a id="__codelineno-0-453" name="__codelineno-0-453"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-454"><a id="__codelineno-0-454" name="__codelineno-0-454"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-455"><a id="__codelineno-0-455" name="__codelineno-0-455"></a><span class="sd"> :return: The JWK Set license as a dict, JSON str, or raw bytes. Return None (the default)</span>
|
||||
</span><span id="__span-0-456"><a id="__codelineno-0-456" name="__codelineno-0-456"></a><span class="sd"> to let the framework POST the challenge to the manifest-provided Laurl, if any.</span>
|
||||
</span><span id="__span-0-457"><a id="__codelineno-0-457" name="__codelineno-0-457"></a><span class="sd"> Services with no license server can instead pre-populate the DRM object's</span>
|
||||
</span><span id="__span-0-458"><a id="__codelineno-0-458" name="__codelineno-0-458"></a><span class="sd"> `content_keys` in get_tracks.</span>
|
||||
</span><span id="__span-0-459"><a id="__codelineno-0-459" name="__codelineno-0-459"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-460"><a id="__codelineno-0-460" name="__codelineno-0-460"></a> <span class="k">return</span> <span class="kc">None</span>
|
||||
<span class="normal"><a href="#__codelineno-0-460">460</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-461">461</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-442"><a id="__codelineno-0-442" name="__codelineno-0-442"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_clearkey_license</span><span class="p">(</span>
|
||||
</span><span id="__span-0-443"><a id="__codelineno-0-443" name="__codelineno-0-443"></a> <span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">challenge</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span>
|
||||
</span><span id="__span-0-444"><a id="__codelineno-0-444" name="__codelineno-0-444"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">dict</span><span class="p">]]:</span>
|
||||
</span><span id="__span-0-445"><a id="__codelineno-0-445" name="__codelineno-0-445"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-446"><a id="__codelineno-0-446" name="__codelineno-0-446"></a><span class="sd"> Get a W3C ClearKey License (JWK Set) by sending a License Request (challenge).</span>
|
||||
</span><span id="__span-0-447"><a id="__codelineno-0-447" name="__codelineno-0-447"></a>
|
||||
</span><span id="__span-0-448"><a id="__codelineno-0-448" name="__codelineno-0-448"></a><span class="sd"> Used for DASH `org.w3.clearkey` content. No CDM is involved: the challenge is</span>
|
||||
</span><span id="__span-0-449"><a id="__codelineno-0-449" name="__codelineno-0-449"></a><span class="sd"> the W3C EME JSON license request, e.g. ``{"kids": ["<base64url>"], "type": "temporary"}``,</span>
|
||||
</span><span id="__span-0-450"><a id="__codelineno-0-450" name="__codelineno-0-450"></a><span class="sd"> and the license is a JWK Set, e.g. ``{"keys": [{"kty": "oct", "k": "...", "kid": "..."}]}``.</span>
|
||||
</span><span id="__span-0-451"><a id="__codelineno-0-451" name="__codelineno-0-451"></a>
|
||||
</span><span id="__span-0-452"><a id="__codelineno-0-452" name="__codelineno-0-452"></a><span class="sd"> :param challenge: The JSON license request bytes to POST to the license server.</span>
|
||||
</span><span id="__span-0-453"><a id="__codelineno-0-453" name="__codelineno-0-453"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed. This is provided in</span>
|
||||
</span><span id="__span-0-454"><a id="__codelineno-0-454" name="__codelineno-0-454"></a><span class="sd"> case it has data needed to be used, e.g. for a HTTP request.</span>
|
||||
</span><span id="__span-0-455"><a id="__codelineno-0-455" name="__codelineno-0-455"></a><span class="sd"> :param track: The current `Track` needing decryption. Provided for same reason as `title`.</span>
|
||||
</span><span id="__span-0-456"><a id="__codelineno-0-456" name="__codelineno-0-456"></a><span class="sd"> :return: The JWK Set license as a dict, JSON str, or raw bytes. Return None (the default)</span>
|
||||
</span><span id="__span-0-457"><a id="__codelineno-0-457" name="__codelineno-0-457"></a><span class="sd"> to let the framework POST the challenge to the manifest-provided Laurl, if any.</span>
|
||||
</span><span id="__span-0-458"><a id="__codelineno-0-458" name="__codelineno-0-458"></a><span class="sd"> Services with no license server can instead pre-populate the DRM object's</span>
|
||||
</span><span id="__span-0-459"><a id="__codelineno-0-459" name="__codelineno-0-459"></a><span class="sd"> `content_keys` in get_tracks.</span>
|
||||
</span><span id="__span-0-460"><a id="__codelineno-0-460" name="__codelineno-0-460"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-461"><a id="__codelineno-0-461" name="__codelineno-0-461"></a> <span class="k">return</span> <span class="kc">None</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3153,8 +3155,7 @@ This can be useful to store information on each title that will be required like
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-466">466</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-467">467</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-467">467</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-468">468</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-469">469</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-470">470</a></span>
|
||||
@@ -3166,20 +3167,21 @@ This can be useful to store information on each title that will be required like
|
||||
<span class="normal"><a href="#__codelineno-0-476">476</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-477">477</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-478">478</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-479">479</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-466"><a id="__codelineno-0-466" name="__codelineno-0-466"></a><span class="nd">@abstractmethod</span>
|
||||
</span><span id="__span-0-467"><a id="__codelineno-0-467" name="__codelineno-0-467"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_titles</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Titles_T</span><span class="p">:</span>
|
||||
</span><span id="__span-0-468"><a id="__codelineno-0-468" name="__codelineno-0-468"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-469"><a id="__codelineno-0-469" name="__codelineno-0-469"></a><span class="sd"> Get Titles for the provided title ID.</span>
|
||||
</span><span id="__span-0-470"><a id="__codelineno-0-470" name="__codelineno-0-470"></a>
|
||||
</span><span id="__span-0-471"><a id="__codelineno-0-471" name="__codelineno-0-471"></a><span class="sd"> Return a Movies, Series, or Album objects containing Movie, Episode, or Song title objects respectively.</span>
|
||||
</span><span id="__span-0-472"><a id="__codelineno-0-472" name="__codelineno-0-472"></a><span class="sd"> The returned data must be for the given title ID, or a spawn of the title ID.</span>
|
||||
</span><span id="__span-0-473"><a id="__codelineno-0-473" name="__codelineno-0-473"></a>
|
||||
</span><span id="__span-0-474"><a id="__codelineno-0-474" name="__codelineno-0-474"></a><span class="sd"> At least one object is expected to be returned, or it will presume an invalid Title ID was</span>
|
||||
</span><span id="__span-0-475"><a id="__codelineno-0-475" name="__codelineno-0-475"></a><span class="sd"> provided.</span>
|
||||
</span><span id="__span-0-476"><a id="__codelineno-0-476" name="__codelineno-0-476"></a>
|
||||
</span><span id="__span-0-477"><a id="__codelineno-0-477" name="__codelineno-0-477"></a><span class="sd"> You can use the `data` dictionary class instance attribute of each Title to store data you may need later on.</span>
|
||||
</span><span id="__span-0-478"><a id="__codelineno-0-478" name="__codelineno-0-478"></a><span class="sd"> This can be useful to store information on each title that will be required like any sub-asset IDs, or such.</span>
|
||||
</span><span id="__span-0-479"><a id="__codelineno-0-479" name="__codelineno-0-479"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-479">479</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-480">480</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-467"><a id="__codelineno-0-467" name="__codelineno-0-467"></a><span class="nd">@abstractmethod</span>
|
||||
</span><span id="__span-0-468"><a id="__codelineno-0-468" name="__codelineno-0-468"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_titles</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Titles_T</span><span class="p">:</span>
|
||||
</span><span id="__span-0-469"><a id="__codelineno-0-469" name="__codelineno-0-469"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-470"><a id="__codelineno-0-470" name="__codelineno-0-470"></a><span class="sd"> Get Titles for the provided title ID.</span>
|
||||
</span><span id="__span-0-471"><a id="__codelineno-0-471" name="__codelineno-0-471"></a>
|
||||
</span><span id="__span-0-472"><a id="__codelineno-0-472" name="__codelineno-0-472"></a><span class="sd"> Return a Movies, Series, or Album objects containing Movie, Episode, or Song title objects respectively.</span>
|
||||
</span><span id="__span-0-473"><a id="__codelineno-0-473" name="__codelineno-0-473"></a><span class="sd"> The returned data must be for the given title ID, or a spawn of the title ID.</span>
|
||||
</span><span id="__span-0-474"><a id="__codelineno-0-474" name="__codelineno-0-474"></a>
|
||||
</span><span id="__span-0-475"><a id="__codelineno-0-475" name="__codelineno-0-475"></a><span class="sd"> At least one object is expected to be returned, or it will presume an invalid Title ID was</span>
|
||||
</span><span id="__span-0-476"><a id="__codelineno-0-476" name="__codelineno-0-476"></a><span class="sd"> provided.</span>
|
||||
</span><span id="__span-0-477"><a id="__codelineno-0-477" name="__codelineno-0-477"></a>
|
||||
</span><span id="__span-0-478"><a id="__codelineno-0-478" name="__codelineno-0-478"></a><span class="sd"> You can use the `data` dictionary class instance attribute of each Title to store data you may need later on.</span>
|
||||
</span><span id="__span-0-479"><a id="__codelineno-0-479" name="__codelineno-0-479"></a><span class="sd"> This can be useful to store information on each title that will be required like any sub-asset IDs, or such.</span>
|
||||
</span><span id="__span-0-480"><a id="__codelineno-0-480" name="__codelineno-0-480"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3261,8 +3263,7 @@ fallback to cached data when API calls fail.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-481">481</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-482">482</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-482">482</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-483">483</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-484">484</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-485">485</a></span>
|
||||
@@ -3306,52 +3307,53 @@ fallback to cached data when API calls fail.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-523">523</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-524">524</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-525">525</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-526">526</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-481"><a id="__codelineno-0-481" name="__codelineno-0-481"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_titles_cached</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">Titles_T</span><span class="p">:</span>
|
||||
</span><span id="__span-0-482"><a id="__codelineno-0-482" name="__codelineno-0-482"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-483"><a id="__codelineno-0-483" name="__codelineno-0-483"></a><span class="sd"> Cached wrapper around get_titles() to reduce redundant API calls.</span>
|
||||
</span><span id="__span-0-484"><a id="__codelineno-0-484" name="__codelineno-0-484"></a>
|
||||
</span><span id="__span-0-485"><a id="__codelineno-0-485" name="__codelineno-0-485"></a><span class="sd"> This method checks the cache before calling get_titles() and handles</span>
|
||||
</span><span id="__span-0-486"><a id="__codelineno-0-486" name="__codelineno-0-486"></a><span class="sd"> fallback to cached data when API calls fail.</span>
|
||||
</span><span id="__span-0-487"><a id="__codelineno-0-487" name="__codelineno-0-487"></a>
|
||||
</span><span id="__span-0-488"><a id="__codelineno-0-488" name="__codelineno-0-488"></a><span class="sd"> Args:</span>
|
||||
</span><span id="__span-0-489"><a id="__codelineno-0-489" name="__codelineno-0-489"></a><span class="sd"> title_id: Optional title ID for cache key generation.</span>
|
||||
</span><span id="__span-0-490"><a id="__codelineno-0-490" name="__codelineno-0-490"></a><span class="sd"> If not provided, will try to extract from service instance.</span>
|
||||
</span><span id="__span-0-491"><a id="__codelineno-0-491" name="__codelineno-0-491"></a>
|
||||
</span><span id="__span-0-492"><a id="__codelineno-0-492" name="__codelineno-0-492"></a><span class="sd"> Returns:</span>
|
||||
</span><span id="__span-0-493"><a id="__codelineno-0-493" name="__codelineno-0-493"></a><span class="sd"> Titles object (Movies, Series, or Album)</span>
|
||||
</span><span id="__span-0-494"><a id="__codelineno-0-494" name="__codelineno-0-494"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-495"><a id="__codelineno-0-495" name="__codelineno-0-495"></a> <span class="c1"># Try to get title_id from service instance if not provided</span>
|
||||
</span><span id="__span-0-496"><a id="__codelineno-0-496" name="__codelineno-0-496"></a> <span class="k">if</span> <span class="n">title_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-497"><a id="__codelineno-0-497" name="__codelineno-0-497"></a> <span class="c1"># Different services store the title ID in different attributes</span>
|
||||
</span><span id="__span-0-498"><a id="__codelineno-0-498" name="__codelineno-0-498"></a> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"title"</span><span class="p">):</span>
|
||||
</span><span id="__span-0-499"><a id="__codelineno-0-499" name="__codelineno-0-499"></a> <span class="n">title_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">title</span>
|
||||
</span><span id="__span-0-500"><a id="__codelineno-0-500" name="__codelineno-0-500"></a> <span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"title_id"</span><span class="p">):</span>
|
||||
</span><span id="__span-0-501"><a id="__codelineno-0-501" name="__codelineno-0-501"></a> <span class="n">title_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">title_id</span>
|
||||
</span><span id="__span-0-502"><a id="__codelineno-0-502" name="__codelineno-0-502"></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="__span-0-503"><a id="__codelineno-0-503" name="__codelineno-0-503"></a> <span class="c1"># If we can't determine title_id, just call get_titles directly</span>
|
||||
</span><span id="__span-0-504"><a id="__codelineno-0-504" name="__codelineno-0-504"></a> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Cannot determine title_id for caching, bypassing cache"</span><span class="p">)</span>
|
||||
</span><span id="__span-0-505"><a id="__codelineno-0-505" name="__codelineno-0-505"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_title_map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_titles</span><span class="p">())</span>
|
||||
</span><span id="__span-0-506"><a id="__codelineno-0-506" name="__codelineno-0-506"></a>
|
||||
</span><span id="__span-0-507"><a id="__codelineno-0-507" name="__codelineno-0-507"></a> <span class="c1"># Get cache control flags from context</span>
|
||||
</span><span id="__span-0-508"><a id="__codelineno-0-508" name="__codelineno-0-508"></a> <span class="n">no_cache</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
</span><span id="__span-0-509"><a id="__codelineno-0-509" name="__codelineno-0-509"></a> <span class="n">reset_cache</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
</span><span id="__span-0-510"><a id="__codelineno-0-510" name="__codelineno-0-510"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="o">.</span><span class="n">parent</span><span class="p">:</span>
|
||||
</span><span id="__span-0-511"><a id="__codelineno-0-511" name="__codelineno-0-511"></a> <span class="n">no_cache</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"no_cache"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||
</span><span id="__span-0-512"><a id="__codelineno-0-512" name="__codelineno-0-512"></a> <span class="n">reset_cache</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"reset_cache"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||
</span><span id="__span-0-513"><a id="__codelineno-0-513" name="__codelineno-0-513"></a>
|
||||
</span><span id="__span-0-514"><a id="__codelineno-0-514" name="__codelineno-0-514"></a> <span class="c1"># Get account hash for cache key</span>
|
||||
</span><span id="__span-0-515"><a id="__codelineno-0-515" name="__codelineno-0-515"></a> <span class="n">account_hash</span> <span class="o">=</span> <span class="n">get_account_hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">credential</span><span class="p">)</span>
|
||||
</span><span id="__span-0-516"><a id="__codelineno-0-516" name="__codelineno-0-516"></a>
|
||||
</span><span id="__span-0-517"><a id="__codelineno-0-517" name="__codelineno-0-517"></a> <span class="c1"># Use title cache to get titles with fallback support</span>
|
||||
</span><span id="__span-0-518"><a id="__codelineno-0-518" name="__codelineno-0-518"></a> <span class="n">titles</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">title_cache</span><span class="o">.</span><span class="n">get_cached_titles</span><span class="p">(</span>
|
||||
</span><span id="__span-0-519"><a id="__codelineno-0-519" name="__codelineno-0-519"></a> <span class="n">title_id</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">title_id</span><span class="p">),</span>
|
||||
</span><span id="__span-0-520"><a id="__codelineno-0-520" name="__codelineno-0-520"></a> <span class="n">fetch_function</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_titles</span><span class="p">,</span>
|
||||
</span><span id="__span-0-521"><a id="__codelineno-0-521" name="__codelineno-0-521"></a> <span class="n">region</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">current_region</span><span class="p">,</span>
|
||||
</span><span id="__span-0-522"><a id="__codelineno-0-522" name="__codelineno-0-522"></a> <span class="n">account_hash</span><span class="o">=</span><span class="n">account_hash</span><span class="p">,</span>
|
||||
</span><span id="__span-0-523"><a id="__codelineno-0-523" name="__codelineno-0-523"></a> <span class="n">no_cache</span><span class="o">=</span><span class="n">no_cache</span><span class="p">,</span>
|
||||
</span><span id="__span-0-524"><a id="__codelineno-0-524" name="__codelineno-0-524"></a> <span class="n">reset_cache</span><span class="o">=</span><span class="n">reset_cache</span><span class="p">,</span>
|
||||
</span><span id="__span-0-525"><a id="__codelineno-0-525" name="__codelineno-0-525"></a> <span class="p">)</span>
|
||||
</span><span id="__span-0-526"><a id="__codelineno-0-526" name="__codelineno-0-526"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_title_map</span><span class="p">(</span><span class="n">titles</span><span class="p">)</span>
|
||||
<span class="normal"><a href="#__codelineno-0-526">526</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-527">527</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-482"><a id="__codelineno-0-482" name="__codelineno-0-482"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_titles_cached</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">Titles_T</span><span class="p">:</span>
|
||||
</span><span id="__span-0-483"><a id="__codelineno-0-483" name="__codelineno-0-483"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-484"><a id="__codelineno-0-484" name="__codelineno-0-484"></a><span class="sd"> Cached wrapper around get_titles() to reduce redundant API calls.</span>
|
||||
</span><span id="__span-0-485"><a id="__codelineno-0-485" name="__codelineno-0-485"></a>
|
||||
</span><span id="__span-0-486"><a id="__codelineno-0-486" name="__codelineno-0-486"></a><span class="sd"> This method checks the cache before calling get_titles() and handles</span>
|
||||
</span><span id="__span-0-487"><a id="__codelineno-0-487" name="__codelineno-0-487"></a><span class="sd"> fallback to cached data when API calls fail.</span>
|
||||
</span><span id="__span-0-488"><a id="__codelineno-0-488" name="__codelineno-0-488"></a>
|
||||
</span><span id="__span-0-489"><a id="__codelineno-0-489" name="__codelineno-0-489"></a><span class="sd"> Args:</span>
|
||||
</span><span id="__span-0-490"><a id="__codelineno-0-490" name="__codelineno-0-490"></a><span class="sd"> title_id: Optional title ID for cache key generation.</span>
|
||||
</span><span id="__span-0-491"><a id="__codelineno-0-491" name="__codelineno-0-491"></a><span class="sd"> If not provided, will try to extract from service instance.</span>
|
||||
</span><span id="__span-0-492"><a id="__codelineno-0-492" name="__codelineno-0-492"></a>
|
||||
</span><span id="__span-0-493"><a id="__codelineno-0-493" name="__codelineno-0-493"></a><span class="sd"> Returns:</span>
|
||||
</span><span id="__span-0-494"><a id="__codelineno-0-494" name="__codelineno-0-494"></a><span class="sd"> Titles object (Movies, Series, or Album)</span>
|
||||
</span><span id="__span-0-495"><a id="__codelineno-0-495" name="__codelineno-0-495"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-496"><a id="__codelineno-0-496" name="__codelineno-0-496"></a> <span class="c1"># Try to get title_id from service instance if not provided</span>
|
||||
</span><span id="__span-0-497"><a id="__codelineno-0-497" name="__codelineno-0-497"></a> <span class="k">if</span> <span class="n">title_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-498"><a id="__codelineno-0-498" name="__codelineno-0-498"></a> <span class="c1"># Different services store the title ID in different attributes</span>
|
||||
</span><span id="__span-0-499"><a id="__codelineno-0-499" name="__codelineno-0-499"></a> <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"title"</span><span class="p">):</span>
|
||||
</span><span id="__span-0-500"><a id="__codelineno-0-500" name="__codelineno-0-500"></a> <span class="n">title_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">title</span>
|
||||
</span><span id="__span-0-501"><a id="__codelineno-0-501" name="__codelineno-0-501"></a> <span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"title_id"</span><span class="p">):</span>
|
||||
</span><span id="__span-0-502"><a id="__codelineno-0-502" name="__codelineno-0-502"></a> <span class="n">title_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">title_id</span>
|
||||
</span><span id="__span-0-503"><a id="__codelineno-0-503" name="__codelineno-0-503"></a> <span class="k">else</span><span class="p">:</span>
|
||||
</span><span id="__span-0-504"><a id="__codelineno-0-504" name="__codelineno-0-504"></a> <span class="c1"># If we can't determine title_id, just call get_titles directly</span>
|
||||
</span><span id="__span-0-505"><a id="__codelineno-0-505" name="__codelineno-0-505"></a> <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Cannot determine title_id for caching, bypassing cache"</span><span class="p">)</span>
|
||||
</span><span id="__span-0-506"><a id="__codelineno-0-506" name="__codelineno-0-506"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_title_map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_titles</span><span class="p">())</span>
|
||||
</span><span id="__span-0-507"><a id="__codelineno-0-507" name="__codelineno-0-507"></a>
|
||||
</span><span id="__span-0-508"><a id="__codelineno-0-508" name="__codelineno-0-508"></a> <span class="c1"># Get cache control flags from context</span>
|
||||
</span><span id="__span-0-509"><a id="__codelineno-0-509" name="__codelineno-0-509"></a> <span class="n">no_cache</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
</span><span id="__span-0-510"><a id="__codelineno-0-510" name="__codelineno-0-510"></a> <span class="n">reset_cache</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
</span><span id="__span-0-511"><a id="__codelineno-0-511" name="__codelineno-0-511"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="o">.</span><span class="n">parent</span><span class="p">:</span>
|
||||
</span><span id="__span-0-512"><a id="__codelineno-0-512" name="__codelineno-0-512"></a> <span class="n">no_cache</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"no_cache"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||
</span><span id="__span-0-513"><a id="__codelineno-0-513" name="__codelineno-0-513"></a> <span class="n">reset_cache</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ctx</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"reset_cache"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||
</span><span id="__span-0-514"><a id="__codelineno-0-514" name="__codelineno-0-514"></a>
|
||||
</span><span id="__span-0-515"><a id="__codelineno-0-515" name="__codelineno-0-515"></a> <span class="c1"># Get account hash for cache key</span>
|
||||
</span><span id="__span-0-516"><a id="__codelineno-0-516" name="__codelineno-0-516"></a> <span class="n">account_hash</span> <span class="o">=</span> <span class="n">get_account_hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">credential</span><span class="p">)</span>
|
||||
</span><span id="__span-0-517"><a id="__codelineno-0-517" name="__codelineno-0-517"></a>
|
||||
</span><span id="__span-0-518"><a id="__codelineno-0-518" name="__codelineno-0-518"></a> <span class="c1"># Use title cache to get titles with fallback support</span>
|
||||
</span><span id="__span-0-519"><a id="__codelineno-0-519" name="__codelineno-0-519"></a> <span class="n">titles</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">title_cache</span><span class="o">.</span><span class="n">get_cached_titles</span><span class="p">(</span>
|
||||
</span><span id="__span-0-520"><a id="__codelineno-0-520" name="__codelineno-0-520"></a> <span class="n">title_id</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">title_id</span><span class="p">),</span>
|
||||
</span><span id="__span-0-521"><a id="__codelineno-0-521" name="__codelineno-0-521"></a> <span class="n">fetch_function</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_titles</span><span class="p">,</span>
|
||||
</span><span id="__span-0-522"><a id="__codelineno-0-522" name="__codelineno-0-522"></a> <span class="n">region</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">current_region</span><span class="p">,</span>
|
||||
</span><span id="__span-0-523"><a id="__codelineno-0-523" name="__codelineno-0-523"></a> <span class="n">account_hash</span><span class="o">=</span><span class="n">account_hash</span><span class="p">,</span>
|
||||
</span><span id="__span-0-524"><a id="__codelineno-0-524" name="__codelineno-0-524"></a> <span class="n">no_cache</span><span class="o">=</span><span class="n">no_cache</span><span class="p">,</span>
|
||||
</span><span id="__span-0-525"><a id="__codelineno-0-525" name="__codelineno-0-525"></a> <span class="n">reset_cache</span><span class="o">=</span><span class="n">reset_cache</span><span class="p">,</span>
|
||||
</span><span id="__span-0-526"><a id="__codelineno-0-526" name="__codelineno-0-526"></a> <span class="p">)</span>
|
||||
</span><span id="__span-0-527"><a id="__codelineno-0-527" name="__codelineno-0-527"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">apply_title_map</span><span class="p">(</span><span class="n">titles</span><span class="p">)</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3379,23 +3381,23 @@ title cache so config edits take effect without a cache reset, and before any
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-528">528</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-529">529</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-529">529</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-530">530</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-531">531</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-532">532</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-533">533</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-534">534</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-535">535</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-536">536</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-528"><a id="__codelineno-0-528" name="__codelineno-0-528"></a><span class="k">def</span><span class="w"> </span><span class="nf">apply_title_map</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">titles</span><span class="p">:</span> <span class="n">Titles_T</span><span class="p">)</span> <span class="o">-></span> <span class="n">Titles_T</span><span class="p">:</span>
|
||||
</span><span id="__span-0-529"><a id="__codelineno-0-529" name="__codelineno-0-529"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-530"><a id="__codelineno-0-530" name="__codelineno-0-530"></a><span class="sd"> Rewrite service-provided titles using the per-service ``title_map`` config.</span>
|
||||
</span><span id="__span-0-531"><a id="__codelineno-0-531" name="__codelineno-0-531"></a>
|
||||
</span><span id="__span-0-532"><a id="__codelineno-0-532" name="__codelineno-0-532"></a><span class="sd"> ``title_map`` lives under ``services.<TAG>`` in unshackle.yaml. Applied after the</span>
|
||||
</span><span id="__span-0-533"><a id="__codelineno-0-533" name="__codelineno-0-533"></a><span class="sd"> title cache so config edits take effect without a cache reset, and before any</span>
|
||||
</span><span id="__span-0-534"><a id="__codelineno-0-534" name="__codelineno-0-534"></a><span class="sd"> ``--enrich`` override so enrich wins. See ``remap_titles`` for the match rules.</span>
|
||||
</span><span id="__span-0-535"><a id="__codelineno-0-535" name="__codelineno-0-535"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-536"><a id="__codelineno-0-536" name="__codelineno-0-536"></a> <span class="k">return</span> <span class="n">remap_titles</span><span class="p">(</span><span class="n">titles</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="ow">or</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"title_map"</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{})</span>
|
||||
<span class="normal"><a href="#__codelineno-0-536">536</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-537">537</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-529"><a id="__codelineno-0-529" name="__codelineno-0-529"></a><span class="k">def</span><span class="w"> </span><span class="nf">apply_title_map</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">titles</span><span class="p">:</span> <span class="n">Titles_T</span><span class="p">)</span> <span class="o">-></span> <span class="n">Titles_T</span><span class="p">:</span>
|
||||
</span><span id="__span-0-530"><a id="__codelineno-0-530" name="__codelineno-0-530"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-531"><a id="__codelineno-0-531" name="__codelineno-0-531"></a><span class="sd"> Rewrite service-provided titles using the per-service ``title_map`` config.</span>
|
||||
</span><span id="__span-0-532"><a id="__codelineno-0-532" name="__codelineno-0-532"></a>
|
||||
</span><span id="__span-0-533"><a id="__codelineno-0-533" name="__codelineno-0-533"></a><span class="sd"> ``title_map`` lives under ``services.<TAG>`` in unshackle.yaml. Applied after the</span>
|
||||
</span><span id="__span-0-534"><a id="__codelineno-0-534" name="__codelineno-0-534"></a><span class="sd"> title cache so config edits take effect without a cache reset, and before any</span>
|
||||
</span><span id="__span-0-535"><a id="__codelineno-0-535" name="__codelineno-0-535"></a><span class="sd"> ``--enrich`` override so enrich wins. See ``remap_titles`` for the match rules.</span>
|
||||
</span><span id="__span-0-536"><a id="__codelineno-0-536" name="__codelineno-0-536"></a><span class="sd"> """</span>
|
||||
</span><span id="__span-0-537"><a id="__codelineno-0-537" name="__codelineno-0-537"></a> <span class="k">return</span> <span class="n">remap_titles</span><span class="p">(</span><span class="n">titles</span><span class="p">,</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="ow">or</span> <span class="p">{})</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"title_map"</span><span class="p">)</span> <span class="ow">or</span> <span class="p">{})</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3442,8 +3444,7 @@ downloading any of the Track's stream data, then do.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-538">538</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-539">539</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-539">539</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-540">540</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-541">541</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-542">542</a></span>
|
||||
@@ -3471,36 +3472,37 @@ downloading any of the Track's stream data, then do.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-564">564</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-565">565</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-566">566</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-567">567</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-538"><a id="__codelineno-0-538" name="__codelineno-0-538"></a><span class="nd">@abstractmethod</span>
|
||||
</span><span id="__span-0-539"><a id="__codelineno-0-539" name="__codelineno-0-539"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_tracks</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tracks</span><span class="p">:</span>
|
||||
</span><span id="__span-0-540"><a id="__codelineno-0-540" name="__codelineno-0-540"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-541"><a id="__codelineno-0-541" name="__codelineno-0-541"></a><span class="sd"> Get Track objects of the Title.</span>
|
||||
</span><span id="__span-0-542"><a id="__codelineno-0-542" name="__codelineno-0-542"></a>
|
||||
</span><span id="__span-0-543"><a id="__codelineno-0-543" name="__codelineno-0-543"></a><span class="sd"> Return a Tracks object, which itself can contain Video, Audio, Subtitle or even Chapters.</span>
|
||||
</span><span id="__span-0-544"><a id="__codelineno-0-544" name="__codelineno-0-544"></a><span class="sd"> Tracks.videos, Tracks.audio, Tracks.subtitles, and Track.chapters should be a List of Track objects.</span>
|
||||
</span><span id="__span-0-545"><a id="__codelineno-0-545" name="__codelineno-0-545"></a>
|
||||
</span><span id="__span-0-546"><a id="__codelineno-0-546" name="__codelineno-0-546"></a><span class="sd"> Each Track in the Tracks should represent a Video/Audio Stream/Representation/Adaptation or</span>
|
||||
</span><span id="__span-0-547"><a id="__codelineno-0-547" name="__codelineno-0-547"></a><span class="sd"> a Subtitle file.</span>
|
||||
</span><span id="__span-0-548"><a id="__codelineno-0-548" name="__codelineno-0-548"></a>
|
||||
</span><span id="__span-0-549"><a id="__codelineno-0-549" name="__codelineno-0-549"></a><span class="sd"> While one Track should only hold information for one stream/downloadable, try to get as many</span>
|
||||
</span><span id="__span-0-550"><a id="__codelineno-0-550" name="__codelineno-0-550"></a><span class="sd"> unique Track objects per stream type so Stream selection by the root code can give you more</span>
|
||||
</span><span id="__span-0-551"><a id="__codelineno-0-551" name="__codelineno-0-551"></a><span class="sd"> options in terms of Resolution, Bitrate, Codecs, Language, e.t.c.</span>
|
||||
</span><span id="__span-0-552"><a id="__codelineno-0-552" name="__codelineno-0-552"></a>
|
||||
</span><span id="__span-0-553"><a id="__codelineno-0-553" name="__codelineno-0-553"></a><span class="sd"> No decision making or filtering of which Tracks get returned should happen here. It can be</span>
|
||||
</span><span id="__span-0-554"><a id="__codelineno-0-554" name="__codelineno-0-554"></a><span class="sd"> considered an error to filter for e.g. resolution, codec, and such. All filtering based on</span>
|
||||
</span><span id="__span-0-555"><a id="__codelineno-0-555" name="__codelineno-0-555"></a><span class="sd"> arguments will be done by the root code automatically when needed.</span>
|
||||
</span><span id="__span-0-556"><a id="__codelineno-0-556" name="__codelineno-0-556"></a>
|
||||
</span><span id="__span-0-557"><a id="__codelineno-0-557" name="__codelineno-0-557"></a><span class="sd"> Make sure you correctly mark which Tracks are encrypted or not, and by which DRM System</span>
|
||||
</span><span id="__span-0-558"><a id="__codelineno-0-558" name="__codelineno-0-558"></a><span class="sd"> via its `drm` property.</span>
|
||||
</span><span id="__span-0-559"><a id="__codelineno-0-559" name="__codelineno-0-559"></a>
|
||||
</span><span id="__span-0-560"><a id="__codelineno-0-560" name="__codelineno-0-560"></a><span class="sd"> If you are able to obtain the Track's KID (Key ID) as a 32 char (16 bit) HEX string, provide</span>
|
||||
</span><span id="__span-0-561"><a id="__codelineno-0-561" name="__codelineno-0-561"></a><span class="sd"> it to the Track's `kid` variable as it will speed up the decryption process later on. It may</span>
|
||||
</span><span id="__span-0-562"><a id="__codelineno-0-562" name="__codelineno-0-562"></a><span class="sd"> or may not be needed, that depends on the service. Generally if you can provide it, without</span>
|
||||
</span><span id="__span-0-563"><a id="__codelineno-0-563" name="__codelineno-0-563"></a><span class="sd"> downloading any of the Track's stream data, then do.</span>
|
||||
</span><span id="__span-0-564"><a id="__codelineno-0-564" name="__codelineno-0-564"></a>
|
||||
</span><span id="__span-0-565"><a id="__codelineno-0-565" name="__codelineno-0-565"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed.</span>
|
||||
</span><span id="__span-0-566"><a id="__codelineno-0-566" name="__codelineno-0-566"></a><span class="sd"> :return: Tracks object containing Video, Audio, Subtitles, and Chapters, if available.</span>
|
||||
</span><span id="__span-0-567"><a id="__codelineno-0-567" name="__codelineno-0-567"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-567">567</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-568">568</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-539"><a id="__codelineno-0-539" name="__codelineno-0-539"></a><span class="nd">@abstractmethod</span>
|
||||
</span><span id="__span-0-540"><a id="__codelineno-0-540" name="__codelineno-0-540"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_tracks</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tracks</span><span class="p">:</span>
|
||||
</span><span id="__span-0-541"><a id="__codelineno-0-541" name="__codelineno-0-541"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-542"><a id="__codelineno-0-542" name="__codelineno-0-542"></a><span class="sd"> Get Track objects of the Title.</span>
|
||||
</span><span id="__span-0-543"><a id="__codelineno-0-543" name="__codelineno-0-543"></a>
|
||||
</span><span id="__span-0-544"><a id="__codelineno-0-544" name="__codelineno-0-544"></a><span class="sd"> Return a Tracks object, which itself can contain Video, Audio, Subtitle or even Chapters.</span>
|
||||
</span><span id="__span-0-545"><a id="__codelineno-0-545" name="__codelineno-0-545"></a><span class="sd"> Tracks.videos, Tracks.audio, Tracks.subtitles, and Track.chapters should be a List of Track objects.</span>
|
||||
</span><span id="__span-0-546"><a id="__codelineno-0-546" name="__codelineno-0-546"></a>
|
||||
</span><span id="__span-0-547"><a id="__codelineno-0-547" name="__codelineno-0-547"></a><span class="sd"> Each Track in the Tracks should represent a Video/Audio Stream/Representation/Adaptation or</span>
|
||||
</span><span id="__span-0-548"><a id="__codelineno-0-548" name="__codelineno-0-548"></a><span class="sd"> a Subtitle file.</span>
|
||||
</span><span id="__span-0-549"><a id="__codelineno-0-549" name="__codelineno-0-549"></a>
|
||||
</span><span id="__span-0-550"><a id="__codelineno-0-550" name="__codelineno-0-550"></a><span class="sd"> While one Track should only hold information for one stream/downloadable, try to get as many</span>
|
||||
</span><span id="__span-0-551"><a id="__codelineno-0-551" name="__codelineno-0-551"></a><span class="sd"> unique Track objects per stream type so Stream selection by the root code can give you more</span>
|
||||
</span><span id="__span-0-552"><a id="__codelineno-0-552" name="__codelineno-0-552"></a><span class="sd"> options in terms of Resolution, Bitrate, Codecs, Language, e.t.c.</span>
|
||||
</span><span id="__span-0-553"><a id="__codelineno-0-553" name="__codelineno-0-553"></a>
|
||||
</span><span id="__span-0-554"><a id="__codelineno-0-554" name="__codelineno-0-554"></a><span class="sd"> No decision making or filtering of which Tracks get returned should happen here. It can be</span>
|
||||
</span><span id="__span-0-555"><a id="__codelineno-0-555" name="__codelineno-0-555"></a><span class="sd"> considered an error to filter for e.g. resolution, codec, and such. All filtering based on</span>
|
||||
</span><span id="__span-0-556"><a id="__codelineno-0-556" name="__codelineno-0-556"></a><span class="sd"> arguments will be done by the root code automatically when needed.</span>
|
||||
</span><span id="__span-0-557"><a id="__codelineno-0-557" name="__codelineno-0-557"></a>
|
||||
</span><span id="__span-0-558"><a id="__codelineno-0-558" name="__codelineno-0-558"></a><span class="sd"> Make sure you correctly mark which Tracks are encrypted or not, and by which DRM System</span>
|
||||
</span><span id="__span-0-559"><a id="__codelineno-0-559" name="__codelineno-0-559"></a><span class="sd"> via its `drm` property.</span>
|
||||
</span><span id="__span-0-560"><a id="__codelineno-0-560" name="__codelineno-0-560"></a>
|
||||
</span><span id="__span-0-561"><a id="__codelineno-0-561" name="__codelineno-0-561"></a><span class="sd"> If you are able to obtain the Track's KID (Key ID) as a 32 char (16 bit) HEX string, provide</span>
|
||||
</span><span id="__span-0-562"><a id="__codelineno-0-562" name="__codelineno-0-562"></a><span class="sd"> it to the Track's `kid` variable as it will speed up the decryption process later on. It may</span>
|
||||
</span><span id="__span-0-563"><a id="__codelineno-0-563" name="__codelineno-0-563"></a><span class="sd"> or may not be needed, that depends on the service. Generally if you can provide it, without</span>
|
||||
</span><span id="__span-0-564"><a id="__codelineno-0-564" name="__codelineno-0-564"></a><span class="sd"> downloading any of the Track's stream data, then do.</span>
|
||||
</span><span id="__span-0-565"><a id="__codelineno-0-565" name="__codelineno-0-565"></a>
|
||||
</span><span id="__span-0-566"><a id="__codelineno-0-566" name="__codelineno-0-566"></a><span class="sd"> :param title: The current `Title` from get_titles that is being executed.</span>
|
||||
</span><span id="__span-0-567"><a id="__codelineno-0-567" name="__codelineno-0-567"></a><span class="sd"> :return: Tracks object containing Video, Audio, Subtitles, and Chapters, if available.</span>
|
||||
</span><span id="__span-0-568"><a id="__codelineno-0-568" name="__codelineno-0-568"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3567,8 +3569,7 @@ option <code>chapter_fallback_name</code>. For example, <code>"Chapter {i:02}"</
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-569">569</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-570">570</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-570">570</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-571">571</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-572">572</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-573">573</a></span>
|
||||
@@ -3584,24 +3585,25 @@ option <code>chapter_fallback_name</code>. For example, <code>"Chapter {i:02}"</
|
||||
<span class="normal"><a href="#__codelineno-0-583">583</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-584">584</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-585">585</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-586">586</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-569"><a id="__codelineno-0-569" name="__codelineno-0-569"></a><span class="nd">@abstractmethod</span>
|
||||
</span><span id="__span-0-570"><a id="__codelineno-0-570" name="__codelineno-0-570"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_chapters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">)</span> <span class="o">-></span> <span class="n">Chapters</span><span class="p">:</span>
|
||||
</span><span id="__span-0-571"><a id="__codelineno-0-571" name="__codelineno-0-571"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-572"><a id="__codelineno-0-572" name="__codelineno-0-572"></a><span class="sd"> Get Chapters for the Title.</span>
|
||||
</span><span id="__span-0-573"><a id="__codelineno-0-573" name="__codelineno-0-573"></a>
|
||||
</span><span id="__span-0-574"><a id="__codelineno-0-574" name="__codelineno-0-574"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-575"><a id="__codelineno-0-575" name="__codelineno-0-575"></a><span class="sd"> title: The current Title from `get_titles` that is being processed.</span>
|
||||
</span><span id="__span-0-576"><a id="__codelineno-0-576" name="__codelineno-0-576"></a>
|
||||
</span><span id="__span-0-577"><a id="__codelineno-0-577" name="__codelineno-0-577"></a><span class="sd"> You must return a Chapters object containing 0 or more Chapter objects.</span>
|
||||
</span><span id="__span-0-578"><a id="__codelineno-0-578" name="__codelineno-0-578"></a>
|
||||
</span><span id="__span-0-579"><a id="__codelineno-0-579" name="__codelineno-0-579"></a><span class="sd"> You do not need to set a Chapter number or sort/order the chapters in any way as</span>
|
||||
</span><span id="__span-0-580"><a id="__codelineno-0-580" name="__codelineno-0-580"></a><span class="sd"> the Chapters class automatically handles all of that for you. If there's no</span>
|
||||
</span><span id="__span-0-581"><a id="__codelineno-0-581" name="__codelineno-0-581"></a><span class="sd"> descriptive name for a Chapter then do not set a name at all.</span>
|
||||
</span><span id="__span-0-582"><a id="__codelineno-0-582" name="__codelineno-0-582"></a>
|
||||
</span><span id="__span-0-583"><a id="__codelineno-0-583" name="__codelineno-0-583"></a><span class="sd"> You must not set Chapter names to "Chapter {n}" or such. If you (or the user)</span>
|
||||
</span><span id="__span-0-584"><a id="__codelineno-0-584" name="__codelineno-0-584"></a><span class="sd"> wants "Chapter {n}" style Chapter names (or similar) then they can use the config</span>
|
||||
</span><span id="__span-0-585"><a id="__codelineno-0-585" name="__codelineno-0-585"></a><span class="sd"> option `chapter_fallback_name`. For example, `"Chapter {i:02}"` for "Chapter 01".</span>
|
||||
</span><span id="__span-0-586"><a id="__codelineno-0-586" name="__codelineno-0-586"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-586">586</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-587">587</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-570"><a id="__codelineno-0-570" name="__codelineno-0-570"></a><span class="nd">@abstractmethod</span>
|
||||
</span><span id="__span-0-571"><a id="__codelineno-0-571" name="__codelineno-0-571"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_chapters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">title</span><span class="p">:</span> <span class="n">Title_T</span><span class="p">)</span> <span class="o">-></span> <span class="n">Chapters</span><span class="p">:</span>
|
||||
</span><span id="__span-0-572"><a id="__codelineno-0-572" name="__codelineno-0-572"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-573"><a id="__codelineno-0-573" name="__codelineno-0-573"></a><span class="sd"> Get Chapters for the Title.</span>
|
||||
</span><span id="__span-0-574"><a id="__codelineno-0-574" name="__codelineno-0-574"></a>
|
||||
</span><span id="__span-0-575"><a id="__codelineno-0-575" name="__codelineno-0-575"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-576"><a id="__codelineno-0-576" name="__codelineno-0-576"></a><span class="sd"> title: The current Title from `get_titles` that is being processed.</span>
|
||||
</span><span id="__span-0-577"><a id="__codelineno-0-577" name="__codelineno-0-577"></a>
|
||||
</span><span id="__span-0-578"><a id="__codelineno-0-578" name="__codelineno-0-578"></a><span class="sd"> You must return a Chapters object containing 0 or more Chapter objects.</span>
|
||||
</span><span id="__span-0-579"><a id="__codelineno-0-579" name="__codelineno-0-579"></a>
|
||||
</span><span id="__span-0-580"><a id="__codelineno-0-580" name="__codelineno-0-580"></a><span class="sd"> You do not need to set a Chapter number or sort/order the chapters in any way as</span>
|
||||
</span><span id="__span-0-581"><a id="__codelineno-0-581" name="__codelineno-0-581"></a><span class="sd"> the Chapters class automatically handles all of that for you. If there's no</span>
|
||||
</span><span id="__span-0-582"><a id="__codelineno-0-582" name="__codelineno-0-582"></a><span class="sd"> descriptive name for a Chapter then do not set a name at all.</span>
|
||||
</span><span id="__span-0-583"><a id="__codelineno-0-583" name="__codelineno-0-583"></a>
|
||||
</span><span id="__span-0-584"><a id="__codelineno-0-584" name="__codelineno-0-584"></a><span class="sd"> You must not set Chapter names to "Chapter {n}" or such. If you (or the user)</span>
|
||||
</span><span id="__span-0-585"><a id="__codelineno-0-585" name="__codelineno-0-585"></a><span class="sd"> wants "Chapter {n}" style Chapter names (or similar) then they can use the config</span>
|
||||
</span><span id="__span-0-586"><a id="__codelineno-0-586" name="__codelineno-0-586"></a><span class="sd"> option `chapter_fallback_name`. For example, `"Chapter {i:02}"` for "Chapter 01".</span>
|
||||
</span><span id="__span-0-587"><a id="__codelineno-0-587" name="__codelineno-0-587"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3673,21 +3675,21 @@ option <code>chapter_fallback_name</code>. For example, <code>"Chapter {i:02}"</
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-590">590</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-591">591</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-591">591</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-592">592</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-593">593</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-594">594</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-595">595</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-596">596</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-597">597</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-590"><a id="__codelineno-0-590" name="__codelineno-0-590"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_segment_downloaded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">,</span> <span class="n">segment</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-591"><a id="__codelineno-0-591" name="__codelineno-0-591"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-592"><a id="__codelineno-0-592" name="__codelineno-0-592"></a><span class="sd"> Called when one of a Track's Segments has finished downloading.</span>
|
||||
</span><span id="__span-0-593"><a id="__codelineno-0-593" name="__codelineno-0-593"></a>
|
||||
</span><span id="__span-0-594"><a id="__codelineno-0-594" name="__codelineno-0-594"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-595"><a id="__codelineno-0-595" name="__codelineno-0-595"></a><span class="sd"> track: The Track object that had a Segment downloaded.</span>
|
||||
</span><span id="__span-0-596"><a id="__codelineno-0-596" name="__codelineno-0-596"></a><span class="sd"> segment: The Path to the Segment that was downloaded.</span>
|
||||
</span><span id="__span-0-597"><a id="__codelineno-0-597" name="__codelineno-0-597"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-597">597</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-598">598</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-591"><a id="__codelineno-0-591" name="__codelineno-0-591"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_segment_downloaded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">,</span> <span class="n">segment</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-592"><a id="__codelineno-0-592" name="__codelineno-0-592"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-593"><a id="__codelineno-0-593" name="__codelineno-0-593"></a><span class="sd"> Called when one of a Track's Segments has finished downloading.</span>
|
||||
</span><span id="__span-0-594"><a id="__codelineno-0-594" name="__codelineno-0-594"></a>
|
||||
</span><span id="__span-0-595"><a id="__codelineno-0-595" name="__codelineno-0-595"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-596"><a id="__codelineno-0-596" name="__codelineno-0-596"></a><span class="sd"> track: The Track object that had a Segment downloaded.</span>
|
||||
</span><span id="__span-0-597"><a id="__codelineno-0-597" name="__codelineno-0-597"></a><span class="sd"> segment: The Path to the Segment that was downloaded.</span>
|
||||
</span><span id="__span-0-598"><a id="__codelineno-0-598" name="__codelineno-0-598"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3743,19 +3745,19 @@ option <code>chapter_fallback_name</code>. For example, <code>"Chapter {i:02}"</
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-599">599</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-600">600</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-600">600</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-601">601</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-602">602</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-603">603</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-604">604</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-605">605</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-599"><a id="__codelineno-0-599" name="__codelineno-0-599"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_downloaded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-600"><a id="__codelineno-0-600" name="__codelineno-0-600"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-601"><a id="__codelineno-0-601" name="__codelineno-0-601"></a><span class="sd"> Called when a Track has finished downloading.</span>
|
||||
</span><span id="__span-0-602"><a id="__codelineno-0-602" name="__codelineno-0-602"></a>
|
||||
</span><span id="__span-0-603"><a id="__codelineno-0-603" name="__codelineno-0-603"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-604"><a id="__codelineno-0-604" name="__codelineno-0-604"></a><span class="sd"> track: The Track object that was downloaded.</span>
|
||||
</span><span id="__span-0-605"><a id="__codelineno-0-605" name="__codelineno-0-605"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-605">605</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-606">606</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-600"><a id="__codelineno-0-600" name="__codelineno-0-600"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_downloaded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-601"><a id="__codelineno-0-601" name="__codelineno-0-601"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-602"><a id="__codelineno-0-602" name="__codelineno-0-602"></a><span class="sd"> Called when a Track has finished downloading.</span>
|
||||
</span><span id="__span-0-603"><a id="__codelineno-0-603" name="__codelineno-0-603"></a>
|
||||
</span><span id="__span-0-604"><a id="__codelineno-0-604" name="__codelineno-0-604"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-605"><a id="__codelineno-0-605" name="__codelineno-0-605"></a><span class="sd"> track: The Track object that was downloaded.</span>
|
||||
</span><span id="__span-0-606"><a id="__codelineno-0-606" name="__codelineno-0-606"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3843,23 +3845,23 @@ option <code>chapter_fallback_name</code>. For example, <code>"Chapter {i:02}"</
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-607">607</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-608">608</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-608">608</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-609">609</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-610">610</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-611">611</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-612">612</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-613">613</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-614">614</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-615">615</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-607"><a id="__codelineno-0-607" name="__codelineno-0-607"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_decrypted</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">,</span> <span class="n">drm</span><span class="p">:</span> <span class="n">DRM_T</span><span class="p">,</span> <span class="n">segment</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">m3u8</span><span class="o">.</span><span class="n">Segment</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-608"><a id="__codelineno-0-608" name="__codelineno-0-608"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-609"><a id="__codelineno-0-609" name="__codelineno-0-609"></a><span class="sd"> Called when a Track has finished decrypting.</span>
|
||||
</span><span id="__span-0-610"><a id="__codelineno-0-610" name="__codelineno-0-610"></a>
|
||||
</span><span id="__span-0-611"><a id="__codelineno-0-611" name="__codelineno-0-611"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-612"><a id="__codelineno-0-612" name="__codelineno-0-612"></a><span class="sd"> track: The Track object that was decrypted.</span>
|
||||
</span><span id="__span-0-613"><a id="__codelineno-0-613" name="__codelineno-0-613"></a><span class="sd"> drm: The DRM object it decrypted with.</span>
|
||||
</span><span id="__span-0-614"><a id="__codelineno-0-614" name="__codelineno-0-614"></a><span class="sd"> segment: The HLS segment information that was decrypted.</span>
|
||||
</span><span id="__span-0-615"><a id="__codelineno-0-615" name="__codelineno-0-615"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-615">615</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-616">616</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-608"><a id="__codelineno-0-608" name="__codelineno-0-608"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_decrypted</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">,</span> <span class="n">drm</span><span class="p">:</span> <span class="n">DRM_T</span><span class="p">,</span> <span class="n">segment</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">m3u8</span><span class="o">.</span><span class="n">Segment</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-609"><a id="__codelineno-0-609" name="__codelineno-0-609"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-610"><a id="__codelineno-0-610" name="__codelineno-0-610"></a><span class="sd"> Called when a Track has finished decrypting.</span>
|
||||
</span><span id="__span-0-611"><a id="__codelineno-0-611" name="__codelineno-0-611"></a>
|
||||
</span><span id="__span-0-612"><a id="__codelineno-0-612" name="__codelineno-0-612"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-613"><a id="__codelineno-0-613" name="__codelineno-0-613"></a><span class="sd"> track: The Track object that was decrypted.</span>
|
||||
</span><span id="__span-0-614"><a id="__codelineno-0-614" name="__codelineno-0-614"></a><span class="sd"> drm: The DRM object it decrypted with.</span>
|
||||
</span><span id="__span-0-615"><a id="__codelineno-0-615" name="__codelineno-0-615"></a><span class="sd"> segment: The HLS segment information that was decrypted.</span>
|
||||
</span><span id="__span-0-616"><a id="__codelineno-0-616" name="__codelineno-0-616"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3915,19 +3917,19 @@ option <code>chapter_fallback_name</code>. For example, <code>"Chapter {i:02}"</
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-617">617</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-618">618</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-618">618</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-619">619</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-620">620</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-621">621</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-622">622</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-623">623</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-617"><a id="__codelineno-0-617" name="__codelineno-0-617"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_repacked</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-618"><a id="__codelineno-0-618" name="__codelineno-0-618"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-619"><a id="__codelineno-0-619" name="__codelineno-0-619"></a><span class="sd"> Called when a Track has finished repacking.</span>
|
||||
</span><span id="__span-0-620"><a id="__codelineno-0-620" name="__codelineno-0-620"></a>
|
||||
</span><span id="__span-0-621"><a id="__codelineno-0-621" name="__codelineno-0-621"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-622"><a id="__codelineno-0-622" name="__codelineno-0-622"></a><span class="sd"> track: The Track object that was repacked.</span>
|
||||
</span><span id="__span-0-623"><a id="__codelineno-0-623" name="__codelineno-0-623"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-623">623</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-624">624</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-618"><a id="__codelineno-0-618" name="__codelineno-0-618"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_repacked</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-619"><a id="__codelineno-0-619" name="__codelineno-0-619"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-620"><a id="__codelineno-0-620" name="__codelineno-0-620"></a><span class="sd"> Called when a Track has finished repacking.</span>
|
||||
</span><span id="__span-0-621"><a id="__codelineno-0-621" name="__codelineno-0-621"></a>
|
||||
</span><span id="__span-0-622"><a id="__codelineno-0-622" name="__codelineno-0-622"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-623"><a id="__codelineno-0-623" name="__codelineno-0-623"></a><span class="sd"> track: The Track object that was repacked.</span>
|
||||
</span><span id="__span-0-624"><a id="__codelineno-0-624" name="__codelineno-0-624"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -3986,8 +3988,7 @@ MP4 via ffmpeg/mp4box.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>unshackle/core/service.py</code></summary>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-625">625</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-626">626</a></span>
|
||||
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-626">626</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-627">627</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-628">628</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-629">629</a></span>
|
||||
@@ -3996,17 +3997,18 @@ MP4 via ffmpeg/mp4box.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-632">632</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-633">633</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-634">634</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-635">635</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-625"><a id="__codelineno-0-625" name="__codelineno-0-625"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_multiplex</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-626"><a id="__codelineno-0-626" name="__codelineno-0-626"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-627"><a id="__codelineno-0-627" name="__codelineno-0-627"></a><span class="sd"> Called when a Track is about to be Multiplexed into a Container.</span>
|
||||
</span><span id="__span-0-628"><a id="__codelineno-0-628" name="__codelineno-0-628"></a>
|
||||
</span><span id="__span-0-629"><a id="__codelineno-0-629" name="__codelineno-0-629"></a><span class="sd"> Note: Right now only MKV containers are multiplexed but in the future</span>
|
||||
</span><span id="__span-0-630"><a id="__codelineno-0-630" name="__codelineno-0-630"></a><span class="sd"> this may also be called when multiplexing to other containers like</span>
|
||||
</span><span id="__span-0-631"><a id="__codelineno-0-631" name="__codelineno-0-631"></a><span class="sd"> MP4 via ffmpeg/mp4box.</span>
|
||||
</span><span id="__span-0-632"><a id="__codelineno-0-632" name="__codelineno-0-632"></a>
|
||||
</span><span id="__span-0-633"><a id="__codelineno-0-633" name="__codelineno-0-633"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-634"><a id="__codelineno-0-634" name="__codelineno-0-634"></a><span class="sd"> track: The Track object that was repacked.</span>
|
||||
</span><span id="__span-0-635"><a id="__codelineno-0-635" name="__codelineno-0-635"></a><span class="sd"> """</span>
|
||||
<span class="normal"><a href="#__codelineno-0-635">635</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-636">636</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-626"><a id="__codelineno-0-626" name="__codelineno-0-626"></a><span class="k">def</span><span class="w"> </span><span class="nf">on_track_multiplex</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">track</span><span class="p">:</span> <span class="n">AnyTrack</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
</span><span id="__span-0-627"><a id="__codelineno-0-627" name="__codelineno-0-627"></a><span class="w"> </span><span class="sd">"""</span>
|
||||
</span><span id="__span-0-628"><a id="__codelineno-0-628" name="__codelineno-0-628"></a><span class="sd"> Called when a Track is about to be Multiplexed into a Container.</span>
|
||||
</span><span id="__span-0-629"><a id="__codelineno-0-629" name="__codelineno-0-629"></a>
|
||||
</span><span id="__span-0-630"><a id="__codelineno-0-630" name="__codelineno-0-630"></a><span class="sd"> Note: Right now only MKV containers are multiplexed but in the future</span>
|
||||
</span><span id="__span-0-631"><a id="__codelineno-0-631" name="__codelineno-0-631"></a><span class="sd"> this may also be called when multiplexing to other containers like</span>
|
||||
</span><span id="__span-0-632"><a id="__codelineno-0-632" name="__codelineno-0-632"></a><span class="sd"> MP4 via ffmpeg/mp4box.</span>
|
||||
</span><span id="__span-0-633"><a id="__codelineno-0-633" name="__codelineno-0-633"></a>
|
||||
</span><span id="__span-0-634"><a id="__codelineno-0-634" name="__codelineno-0-634"></a><span class="sd"> Parameters:</span>
|
||||
</span><span id="__span-0-635"><a id="__codelineno-0-635" name="__codelineno-0-635"></a><span class="sd"> track: The Track object that was repacked.</span>
|
||||
</span><span id="__span-0-636"><a id="__codelineno-0-636" name="__codelineno-0-636"></a><span class="sd"> """</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user