deploy: d156dd7176
This commit is contained in:
dceoy
+62
-62
@@ -244,9 +244,7 @@ responsibility of downstream applications.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/sdk.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-381">381</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-382">382</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-383">383</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-384">384</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-385">385</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-386">386</a></span>
|
||||
@@ -279,42 +277,44 @@ responsibility of downstream applications.</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><a id="__codelineno-0-381" name="__codelineno-0-381"></a><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="bp">self</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-383" name="__codelineno-0-383"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-384" name="__codelineno-0-384"></a> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="n">server</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="n">retry_count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="n">client</span><span class="p">:</span> <span class="n">Mt5DataClient</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-392" name="__codelineno-0-392"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-393" name="__codelineno-0-393"></a><span class="w"> </span><span class="sd">"""Initialize the SDK client.</span>
|
||||
<a id="__codelineno-0-394" name="__codelineno-0-394"></a>
|
||||
<a id="__codelineno-0-395" name="__codelineno-0-395"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-396" name="__codelineno-0-396"></a><span class="sd"> path: Path to MetaTrader5 terminal EXE file.</span>
|
||||
<a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="sd"> login: Trading account login.</span>
|
||||
<a id="__codelineno-0-398" name="__codelineno-0-398"></a><span class="sd"> password: Trading account password.</span>
|
||||
<a id="__codelineno-0-399" name="__codelineno-0-399"></a><span class="sd"> server: Trading server name.</span>
|
||||
<a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="sd"> timeout: Connection timeout in milliseconds.</span>
|
||||
<a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="sd"> retry_count: Number of MT5 initialization retries for sessions</span>
|
||||
<a id="__codelineno-0-402" name="__codelineno-0-402"></a><span class="sd"> opened by this client.</span>
|
||||
<a id="__codelineno-0-403" name="__codelineno-0-403"></a><span class="sd"> config: Optional pre-built ``Mt5Config`` (overrides other args).</span>
|
||||
<a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="sd"> client: Optional already-connected ``Mt5DataClient``. Injected</span>
|
||||
<a id="__codelineno-0-405" name="__codelineno-0-405"></a><span class="sd"> clients are reused as-is and are not initialized or shut down.</span>
|
||||
<a id="__codelineno-0-406" name="__codelineno-0-406"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">build_config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-408" name="__codelineno-0-408"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-409" name="__codelineno-0-409"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-410" name="__codelineno-0-410"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-411" name="__codelineno-0-411"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-412" name="__codelineno-0-412"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-413" name="__codelineno-0-413"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-414" name="__codelineno-0-414"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_retry_count</span> <span class="o">=</span> <span class="n">retry_count</span>
|
||||
<a id="__codelineno-0-415" name="__codelineno-0-415"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<a id="__codelineno-0-416" name="__codelineno-0-416"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_owns_client</span> <span class="o">=</span> <span class="n">client</span> <span class="ow">is</span> <span class="kc">None</span>
|
||||
<span class="normal"><a href="#__codelineno-0-416">416</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-417">417</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-418">418</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-383" name="__codelineno-0-383"></a><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-384" name="__codelineno-0-384"></a> <span class="bp">self</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="n">server</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="n">retry_count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="n">config</span><span class="p">:</span> <span class="n">Mt5Config</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="n">client</span><span class="p">:</span> <span class="n">Mt5DataClient</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-394" name="__codelineno-0-394"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-395" name="__codelineno-0-395"></a><span class="w"> </span><span class="sd">"""Initialize the SDK client.</span>
|
||||
<a id="__codelineno-0-396" name="__codelineno-0-396"></a>
|
||||
<a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-398" name="__codelineno-0-398"></a><span class="sd"> path: Path to MetaTrader5 terminal EXE file.</span>
|
||||
<a id="__codelineno-0-399" name="__codelineno-0-399"></a><span class="sd"> login: Trading account login.</span>
|
||||
<a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="sd"> password: Trading account password.</span>
|
||||
<a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="sd"> server: Trading server name.</span>
|
||||
<a id="__codelineno-0-402" name="__codelineno-0-402"></a><span class="sd"> timeout: Connection timeout in milliseconds.</span>
|
||||
<a id="__codelineno-0-403" name="__codelineno-0-403"></a><span class="sd"> retry_count: Number of MT5 initialization retries for sessions</span>
|
||||
<a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="sd"> opened by this client.</span>
|
||||
<a id="__codelineno-0-405" name="__codelineno-0-405"></a><span class="sd"> config: Optional pre-built ``Mt5Config`` (overrides other args).</span>
|
||||
<a id="__codelineno-0-406" name="__codelineno-0-406"></a><span class="sd"> client: Optional already-connected ``Mt5DataClient``. Injected</span>
|
||||
<a id="__codelineno-0-407" name="__codelineno-0-407"></a><span class="sd"> clients are reused as-is and are not initialized or shut down.</span>
|
||||
<a id="__codelineno-0-408" name="__codelineno-0-408"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-409" name="__codelineno-0-409"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_config</span> <span class="o">=</span> <span class="n">config</span> <span class="ow">or</span> <span class="n">build_config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-410" name="__codelineno-0-410"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-411" name="__codelineno-0-411"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-412" name="__codelineno-0-412"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-413" name="__codelineno-0-413"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-414" name="__codelineno-0-414"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-415" name="__codelineno-0-415"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-416" name="__codelineno-0-416"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_retry_count</span> <span class="o">=</span> <span class="n">retry_count</span>
|
||||
<a id="__codelineno-0-417" name="__codelineno-0-417"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
|
||||
<a id="__codelineno-0-418" name="__codelineno-0-418"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_owns_client</span> <span class="o">=</span> <span class="n">client</span> <span class="ow">is</span> <span class="kc">None</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -671,9 +671,7 @@ not implement strategy logic, signal generation, or trade sizing.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/sdk.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-301">301</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-302">302</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-303">303</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-303">303</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-304">304</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-305">305</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-306">306</a></span>
|
||||
@@ -690,26 +688,28 @@ not implement strategy logic, signal generation, or trade sizing.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-317">317</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-318">318</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-319">319</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-320">320</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-301" name="__codelineno-0-301"></a><span class="k">def</span><span class="w"> </span><span class="nf">build_config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-302" name="__codelineno-0-302"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-303" name="__codelineno-0-303"></a> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-304" name="__codelineno-0-304"></a> <span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">server</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-307" name="__codelineno-0-307"></a> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-308" name="__codelineno-0-308"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5Config</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-309" name="__codelineno-0-309"></a><span class="w"> </span><span class="sd">"""Build an ``Mt5Config`` from optional connection parameters.</span>
|
||||
<a id="__codelineno-0-310" name="__codelineno-0-310"></a>
|
||||
<a id="__codelineno-0-311" name="__codelineno-0-311"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-312" name="__codelineno-0-312"></a><span class="sd"> Configured ``Mt5Config`` instance.</span>
|
||||
<a id="__codelineno-0-313" name="__codelineno-0-313"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-314" name="__codelineno-0-314"></a> <span class="k">return</span> <span class="n">Mt5Config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-315" name="__codelineno-0-315"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="p">)</span>
|
||||
<span class="normal"><a href="#__codelineno-0-320">320</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-321">321</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-322">322</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-303" name="__codelineno-0-303"></a><span class="k">def</span><span class="w"> </span><span class="nf">build_config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-304" name="__codelineno-0-304"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-307" name="__codelineno-0-307"></a> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-308" name="__codelineno-0-308"></a> <span class="n">server</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-309" name="__codelineno-0-309"></a> <span class="n">timeout</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-310" name="__codelineno-0-310"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5Config</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-311" name="__codelineno-0-311"></a><span class="w"> </span><span class="sd">"""Build an ``Mt5Config`` from optional connection parameters.</span>
|
||||
<a id="__codelineno-0-312" name="__codelineno-0-312"></a>
|
||||
<a id="__codelineno-0-313" name="__codelineno-0-313"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-314" name="__codelineno-0-314"></a><span class="sd"> Configured ``Mt5Config`` instance.</span>
|
||||
<a id="__codelineno-0-315" name="__codelineno-0-315"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="k">return</span> <span class="n">Mt5Config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="p">)</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
+110
-110
@@ -938,47 +938,47 @@ suffixes (for example <code>XAUUSDm</code>, <code>US500.cash</code>, or <code>EU
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-329">329</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-330">330</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-331">331</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-336">336</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-337">337</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-342">342</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-343">343</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-343">343</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-344">344</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-345">345</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-346">346</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-347">347</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-348">348</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-349">349</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-329" name="__codelineno-0-329"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-330" name="__codelineno-0-330"></a><span class="w"> </span><span class="sd">"""Parse an ISO 8601 datetime string to a timezone-aware datetime.</span>
|
||||
<a id="__codelineno-0-331" name="__codelineno-0-331"></a>
|
||||
<a id="__codelineno-0-332" name="__codelineno-0-332"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-333" name="__codelineno-0-333"></a><span class="sd"> value: ISO 8601 datetime string (e.g., '2024-01-01' or</span>
|
||||
<a id="__codelineno-0-334" name="__codelineno-0-334"></a><span class="sd"> '2024-01-01T12:00:00+00:00').</span>
|
||||
<a id="__codelineno-0-335" name="__codelineno-0-335"></a>
|
||||
<a id="__codelineno-0-336" name="__codelineno-0-336"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-337" name="__codelineno-0-337"></a><span class="sd"> Parsed datetime with UTC timezone if no timezone is specified.</span>
|
||||
<a id="__codelineno-0-338" name="__codelineno-0-338"></a>
|
||||
<a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-340" name="__codelineno-0-340"></a><span class="sd"> ValueError: If the string cannot be parsed.</span>
|
||||
<a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-342" name="__codelineno-0-342"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-343" name="__codelineno-0-343"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid datetime format: '</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">'. Use ISO 8601 format."</span>
|
||||
<a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="k">if</span> <span class="n">dt</span><span class="o">.</span><span class="n">tzinfo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-348" name="__codelineno-0-348"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="k">return</span> <span class="n">dt</span>
|
||||
<span class="normal"><a href="#__codelineno-0-349">349</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-350">350</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-351">351</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-352">352</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-358">358</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-359">359</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-344" name="__codelineno-0-344"></a><span class="w"> </span><span class="sd">"""Parse an ISO 8601 datetime string to a timezone-aware datetime.</span>
|
||||
<a id="__codelineno-0-345" name="__codelineno-0-345"></a>
|
||||
<a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-347" name="__codelineno-0-347"></a><span class="sd"> value: ISO 8601 datetime string (e.g., '2024-01-01' or</span>
|
||||
<a id="__codelineno-0-348" name="__codelineno-0-348"></a><span class="sd"> '2024-01-01T12:00:00+00:00').</span>
|
||||
<a id="__codelineno-0-349" name="__codelineno-0-349"></a>
|
||||
<a id="__codelineno-0-350" name="__codelineno-0-350"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-351" name="__codelineno-0-351"></a><span class="sd"> Parsed datetime with UTC timezone if no timezone is specified.</span>
|
||||
<a id="__codelineno-0-352" name="__codelineno-0-352"></a>
|
||||
<a id="__codelineno-0-353" name="__codelineno-0-353"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-354" name="__codelineno-0-354"></a><span class="sd"> ValueError: If the string cannot be parsed.</span>
|
||||
<a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid datetime format: '</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">'. Use ISO 8601 format."</span>
|
||||
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="k">if</span> <span class="n">dt</span><span class="o">.</span><span class="n">tzinfo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="k">return</span> <span class="n">dt</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -1080,49 +1080,49 @@ suffixes (for example <code>XAUUSDm</code>, <code>US500.cash</code>, or <code>EU
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-376">376</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-377">377</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-378">378</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-384">384</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-389">389</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-390">390</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-390">390</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-391">391</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-392">392</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-393">393</a></span>
|
||||
<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><a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_tick_flags</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="w"> </span><span class="sd">"""Parse tick flags string or integer value.</span>
|
||||
<a id="__codelineno-0-378" name="__codelineno-0-378"></a>
|
||||
<a id="__codelineno-0-379" name="__codelineno-0-379"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-380" name="__codelineno-0-380"></a><span class="sd"> value: Tick flag name (ALL, INFO, TRADE, COPY_TICKS_*) or integer value.</span>
|
||||
<a id="__codelineno-0-381" name="__codelineno-0-381"></a>
|
||||
<a id="__codelineno-0-382" name="__codelineno-0-382"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-383" name="__codelineno-0-383"></a><span class="sd"> Integer tick flag value compatible with MetaTrader 5 ``COPY_TICKS_*``.</span>
|
||||
<a id="__codelineno-0-384" name="__codelineno-0-384"></a>
|
||||
<a id="__codelineno-0-385" name="__codelineno-0-385"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-386" name="__codelineno-0-386"></a><span class="sd"> ValueError: If the flag is invalid.</span>
|
||||
<a id="__codelineno-0-387" name="__codelineno-0-387"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="k">return</span> <span class="n">_parse_copy_ticks</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_TICK_FLAG_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-394" name="__codelineno-0-394"></a> <span class="sa">f</span><span class="s2">"Invalid tick flags: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-395" name="__codelineno-0-395"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-396" name="__codelineno-0-396"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-397" name="__codelineno-0-397"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<span class="normal"><a href="#__codelineno-0-397">397</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-398">398</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-399">399</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-404">404</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-405">405</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-406">406</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-407">407</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-408">408</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-409">409</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-410">410</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-411">411</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-390" name="__codelineno-0-390"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_tick_flags</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-391" name="__codelineno-0-391"></a><span class="w"> </span><span class="sd">"""Parse tick flags string or integer value.</span>
|
||||
<a id="__codelineno-0-392" name="__codelineno-0-392"></a>
|
||||
<a id="__codelineno-0-393" name="__codelineno-0-393"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-394" name="__codelineno-0-394"></a><span class="sd"> value: Tick flag name (ALL, INFO, TRADE, COPY_TICKS_*) or integer value.</span>
|
||||
<a id="__codelineno-0-395" name="__codelineno-0-395"></a>
|
||||
<a id="__codelineno-0-396" name="__codelineno-0-396"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="sd"> Integer tick flag value compatible with MetaTrader 5 ``COPY_TICKS_*``.</span>
|
||||
<a id="__codelineno-0-398" name="__codelineno-0-398"></a>
|
||||
<a id="__codelineno-0-399" name="__codelineno-0-399"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="sd"> ValueError: If the flag is invalid.</span>
|
||||
<a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-402" name="__codelineno-0-402"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-403" name="__codelineno-0-403"></a> <span class="k">return</span> <span class="n">_parse_copy_ticks</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-404" name="__codelineno-0-404"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-405" name="__codelineno-0-405"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-406" name="__codelineno-0-406"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_TICK_FLAG_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-408" name="__codelineno-0-408"></a> <span class="sa">f</span><span class="s2">"Invalid tick flags: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-409" name="__codelineno-0-409"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-410" name="__codelineno-0-410"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-411" name="__codelineno-0-411"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -1224,49 +1224,49 @@ suffixes (for example <code>XAUUSDm</code>, <code>US500.cash</code>, or <code>EU
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-352">352</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-358">358</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-359">359</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-364">364</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-365">365</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-366">366</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-366">366</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-367">367</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-372">372</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-373">373</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-352" name="__codelineno-0-352"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-353" name="__codelineno-0-353"></a><span class="w"> </span><span class="sd">"""Parse a timeframe string or integer value.</span>
|
||||
<a id="__codelineno-0-354" name="__codelineno-0-354"></a>
|
||||
<a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-356" name="__codelineno-0-356"></a><span class="sd"> value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</span>
|
||||
<a id="__codelineno-0-357" name="__codelineno-0-357"></a>
|
||||
<a id="__codelineno-0-358" name="__codelineno-0-358"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-359" name="__codelineno-0-359"></a><span class="sd"> Integer timeframe value.</span>
|
||||
<a id="__codelineno-0-360" name="__codelineno-0-360"></a>
|
||||
<a id="__codelineno-0-361" name="__codelineno-0-361"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-362" name="__codelineno-0-362"></a><span class="sd"> ValueError: If the timeframe is invalid.</span>
|
||||
<a id="__codelineno-0-363" name="__codelineno-0-363"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="k">return</span> <span class="n">_parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">TIMEFRAME_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-369" name="__codelineno-0-369"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="sa">f</span><span class="s2">"Invalid timeframe: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-373" name="__codelineno-0-373"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<span class="normal"><a href="#__codelineno-0-373">373</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-378">378</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-384">384</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-366" name="__codelineno-0-366"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-367" name="__codelineno-0-367"></a><span class="w"> </span><span class="sd">"""Parse a timeframe string or integer value.</span>
|
||||
<a id="__codelineno-0-368" name="__codelineno-0-368"></a>
|
||||
<a id="__codelineno-0-369" name="__codelineno-0-369"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-370" name="__codelineno-0-370"></a><span class="sd"> value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</span>
|
||||
<a id="__codelineno-0-371" name="__codelineno-0-371"></a>
|
||||
<a id="__codelineno-0-372" name="__codelineno-0-372"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-373" name="__codelineno-0-373"></a><span class="sd"> Integer timeframe value.</span>
|
||||
<a id="__codelineno-0-374" name="__codelineno-0-374"></a>
|
||||
<a id="__codelineno-0-375" name="__codelineno-0-375"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="sd"> ValueError: If the timeframe is invalid.</span>
|
||||
<a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-378" name="__codelineno-0-378"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="k">return</span> <span class="n">_parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">TIMEFRAME_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-383" name="__codelineno-0-383"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-384" name="__codelineno-0-384"></a> <span class="sa">f</span><span class="s2">"Invalid timeframe: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
+2401
-2175
File diff suppressed because it is too large
Load Diff
+1943
-1803
File diff suppressed because it is too large
Load Diff
+1183
-1091
File diff suppressed because it is too large
Load Diff
+1927
-345
File diff suppressed because it is too large
Load Diff
+337
-267
@@ -877,6 +877,76 @@
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h3 id="mt5cli.utils.coerce_login" class="doc doc-heading">
|
||||
<span class="doc doc-object-name doc-function-name">coerce_login</span>
|
||||
|
||||
|
||||
<a href="#mt5cli.utils.coerce_login" class="headerlink" title="Permanent link">¶</a></h3>
|
||||
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">coerce_login</span><span class="p">(</span><span class="n">login</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span>
|
||||
</code></pre></div>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Coerce a login value to int, treating empty strings as unset.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><span title="int">int</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Integer login, or None when unset or an empty string.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-244">244</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-245">245</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-246">246</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-247">247</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-248">248</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-249">249</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-250">250</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-251">251</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-252">252</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-253">253</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-254">254</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-255">255</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="k">def</span><span class="w"> </span><span class="nf">coerce_login</span><span class="p">(</span><span class="n">login</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</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="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-245" name="__codelineno-0-245"></a><span class="w"> </span><span class="sd">"""Coerce a login value to int, treating empty strings as unset.</span>
|
||||
<a id="__codelineno-0-246" name="__codelineno-0-246"></a>
|
||||
<a id="__codelineno-0-247" name="__codelineno-0-247"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-248" name="__codelineno-0-248"></a><span class="sd"> Integer login, or None when unset or an empty string.</span>
|
||||
<a id="__codelineno-0-249" name="__codelineno-0-249"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-250" name="__codelineno-0-250"></a> <span class="k">if</span> <span class="n">login</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">login</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-251" name="__codelineno-0-251"></a> <span class="k">return</span> <span class="n">login</span>
|
||||
<a id="__codelineno-0-252" name="__codelineno-0-252"></a> <span class="n">text</span> <span class="o">=</span> <span class="n">login</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
|
||||
<a id="__codelineno-0-253" name="__codelineno-0-253"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">text</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-254" name="__codelineno-0-254"></a> <span class="k">return</span> <span class="kc">None</span>
|
||||
<a id="__codelineno-0-255" name="__codelineno-0-255"></a> <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h3 id="mt5cli.utils.detect_format" class="doc doc-heading">
|
||||
<span class="doc doc-object-name doc-function-name">detect_format</span>
|
||||
|
||||
@@ -1169,21 +1239,7 @@
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-288">288</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-289">289</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-290">290</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-291">291</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-292">292</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-293">293</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-294">294</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-295">295</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-296">296</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-297">297</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-298">298</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-299">299</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-300">300</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-301">301</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-302">302</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-302">302</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-303">303</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-304">304</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-305">305</a></span>
|
||||
@@ -1207,45 +1263,59 @@
|
||||
<span class="normal"><a href="#__codelineno-0-323">323</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-324">324</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-325">325</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-326">326</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-288" name="__codelineno-0-288"></a><span class="k">def</span><span class="w"> </span><span class="nf">export_dataframe</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="n">df</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-290" name="__codelineno-0-290"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-291" name="__codelineno-0-291"></a> <span class="n">output_format</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-292" name="__codelineno-0-292"></a> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"data"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-293" name="__codelineno-0-293"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-294" name="__codelineno-0-294"></a><span class="w"> </span><span class="sd">"""Export a pandas DataFrame to the specified file format.</span>
|
||||
<a id="__codelineno-0-295" name="__codelineno-0-295"></a>
|
||||
<a id="__codelineno-0-296" name="__codelineno-0-296"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-297" name="__codelineno-0-297"></a><span class="sd"> df: DataFrame to export.</span>
|
||||
<a id="__codelineno-0-298" name="__codelineno-0-298"></a><span class="sd"> output_path: Path to the output file.</span>
|
||||
<a id="__codelineno-0-299" name="__codelineno-0-299"></a><span class="sd"> output_format: Output format (csv, json, parquet, or sqlite3).</span>
|
||||
<a id="__codelineno-0-300" name="__codelineno-0-300"></a><span class="sd"> table_name: Table name for SQLite3 output.</span>
|
||||
<a id="__codelineno-0-301" name="__codelineno-0-301"></a>
|
||||
<a id="__codelineno-0-302" name="__codelineno-0-302"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-303" name="__codelineno-0-303"></a><span class="sd"> ValueError: If the output format is not supported.</span>
|
||||
<a id="__codelineno-0-304" name="__codelineno-0-304"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="k">if</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"csv"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_csv</span><span class="p">(</span><span class="n">output_path</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-307" name="__codelineno-0-307"></a> <span class="k">elif</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"json"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-308" name="__codelineno-0-308"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_json</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-309" name="__codelineno-0-309"></a> <span class="n">output_path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-310" name="__codelineno-0-310"></a> <span class="n">orient</span><span class="o">=</span><span class="s2">"records"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-311" name="__codelineno-0-311"></a> <span class="n">date_format</span><span class="o">=</span><span class="s2">"iso"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-312" name="__codelineno-0-312"></a> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-313" name="__codelineno-0-313"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-314" name="__codelineno-0-314"></a> <span class="k">elif</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"parquet"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-315" name="__codelineno-0-315"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_parquet</span><span class="p">(</span><span class="n">output_path</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="k">elif</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"sqlite3"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="n">export_dataframe_to_sqlite</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="n">df</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="n">output_path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="n">table_name</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="n">if_exists</span><span class="o">=</span><span class="n">IfExists</span><span class="o">.</span><span class="n">REPLACE</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-323" name="__codelineno-0-323"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-324" name="__codelineno-0-324"></a> <span class="k">else</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-325" name="__codelineno-0-325"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Unsupported output format: </span><span class="si">{</span><span class="n">output_format</span><span class="si">}</span><span class="s2">"</span>
|
||||
<a id="__codelineno-0-326" name="__codelineno-0-326"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
||||
<span class="normal"><a href="#__codelineno-0-326">326</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-327">327</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-328">328</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-329">329</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-330">330</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-331">331</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-336">336</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-337">337</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-302" name="__codelineno-0-302"></a><span class="k">def</span><span class="w"> </span><span class="nf">export_dataframe</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-303" name="__codelineno-0-303"></a> <span class="n">df</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-304" name="__codelineno-0-304"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="n">output_format</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"data"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-307" name="__codelineno-0-307"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-308" name="__codelineno-0-308"></a><span class="w"> </span><span class="sd">"""Export a pandas DataFrame to the specified file format.</span>
|
||||
<a id="__codelineno-0-309" name="__codelineno-0-309"></a>
|
||||
<a id="__codelineno-0-310" name="__codelineno-0-310"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-311" name="__codelineno-0-311"></a><span class="sd"> df: DataFrame to export.</span>
|
||||
<a id="__codelineno-0-312" name="__codelineno-0-312"></a><span class="sd"> output_path: Path to the output file.</span>
|
||||
<a id="__codelineno-0-313" name="__codelineno-0-313"></a><span class="sd"> output_format: Output format (csv, json, parquet, or sqlite3).</span>
|
||||
<a id="__codelineno-0-314" name="__codelineno-0-314"></a><span class="sd"> table_name: Table name for SQLite3 output.</span>
|
||||
<a id="__codelineno-0-315" name="__codelineno-0-315"></a>
|
||||
<a id="__codelineno-0-316" name="__codelineno-0-316"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-317" name="__codelineno-0-317"></a><span class="sd"> ValueError: If the output format is not supported.</span>
|
||||
<a id="__codelineno-0-318" name="__codelineno-0-318"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="k">if</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"csv"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_csv</span><span class="p">(</span><span class="n">output_path</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="k">elif</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"json"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_json</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-323" name="__codelineno-0-323"></a> <span class="n">output_path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-324" name="__codelineno-0-324"></a> <span class="n">orient</span><span class="o">=</span><span class="s2">"records"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-325" name="__codelineno-0-325"></a> <span class="n">date_format</span><span class="o">=</span><span class="s2">"iso"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-326" name="__codelineno-0-326"></a> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-327" name="__codelineno-0-327"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-328" name="__codelineno-0-328"></a> <span class="k">elif</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"parquet"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-329" name="__codelineno-0-329"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_parquet</span><span class="p">(</span><span class="n">output_path</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-330" name="__codelineno-0-330"></a> <span class="k">elif</span> <span class="n">output_format</span> <span class="o">==</span> <span class="s2">"sqlite3"</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-331" name="__codelineno-0-331"></a> <span class="n">export_dataframe_to_sqlite</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-332" name="__codelineno-0-332"></a> <span class="n">df</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-333" name="__codelineno-0-333"></a> <span class="n">output_path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="n">table_name</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-335" name="__codelineno-0-335"></a> <span class="n">if_exists</span><span class="o">=</span><span class="n">IfExists</span><span class="o">.</span><span class="n">REPLACE</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-336" name="__codelineno-0-336"></a> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-337" name="__codelineno-0-337"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-338" name="__codelineno-0-338"></a> <span class="k">else</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-339" name="__codelineno-0-339"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Unsupported output format: </span><span class="si">{</span><span class="n">output_format</span><span class="si">}</span><span class="s2">"</span>
|
||||
<a id="__codelineno-0-340" name="__codelineno-0-340"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -1421,21 +1491,7 @@ columns when appending frequently.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-244">244</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-245">245</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-246">246</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-247">247</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-248">248</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-249">249</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-250">250</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-251">251</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-252">252</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-253">253</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-254">254</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-255">255</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-256">256</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-257">257</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-258">258</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-258">258</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-259">259</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-260">260</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-261">261</a></span>
|
||||
@@ -1462,48 +1518,62 @@ columns when appending frequently.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-282">282</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-283">283</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-284">284</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-285">285</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="k">def</span><span class="w"> </span><span class="nf">export_dataframe_to_sqlite</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-245" name="__codelineno-0-245"></a> <span class="n">df</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-246" name="__codelineno-0-246"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-247" name="__codelineno-0-247"></a> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"data"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-248" name="__codelineno-0-248"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-249" name="__codelineno-0-249"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n">IfExists</span> <span class="o">=</span> <span class="n">IfExists</span><span class="o">.</span><span class="n">APPEND</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-250" name="__codelineno-0-250"></a> <span class="n">index</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-251" name="__codelineno-0-251"></a> <span class="n">index_label</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-252" name="__codelineno-0-252"></a> <span class="n">deduplicate_on</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-253" name="__codelineno-0-253"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-254" name="__codelineno-0-254"></a><span class="w"> </span><span class="sd">"""Write a DataFrame to SQLite with configurable append and deduplication.</span>
|
||||
<a id="__codelineno-0-255" name="__codelineno-0-255"></a>
|
||||
<a id="__codelineno-0-256" name="__codelineno-0-256"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-257" name="__codelineno-0-257"></a><span class="sd"> df: DataFrame to export.</span>
|
||||
<a id="__codelineno-0-258" name="__codelineno-0-258"></a><span class="sd"> output_path: SQLite database path.</span>
|
||||
<a id="__codelineno-0-259" name="__codelineno-0-259"></a><span class="sd"> table_name: Target table name.</span>
|
||||
<a id="__codelineno-0-260" name="__codelineno-0-260"></a><span class="sd"> if_exists: Conflict behavior when the table already exists.</span>
|
||||
<a id="__codelineno-0-261" name="__codelineno-0-261"></a><span class="sd"> index: Whether to write the DataFrame index as a column.</span>
|
||||
<a id="__codelineno-0-262" name="__codelineno-0-262"></a><span class="sd"> index_label: Column name for the index when ``index=True``.</span>
|
||||
<a id="__codelineno-0-263" name="__codelineno-0-263"></a><span class="sd"> deduplicate_on: Optional key columns to deduplicate after writing,</span>
|
||||
<a id="__codelineno-0-264" name="__codelineno-0-264"></a><span class="sd"> keeping the latest ``ROWID`` per key group. Deduplication scans the</span>
|
||||
<a id="__codelineno-0-265" name="__codelineno-0-265"></a><span class="sd"> full table, so repeated appends cost O(table size); index the key</span>
|
||||
<a id="__codelineno-0-266" name="__codelineno-0-266"></a><span class="sd"> columns when appending frequently.</span>
|
||||
<a id="__codelineno-0-267" name="__codelineno-0-267"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-268" name="__codelineno-0-268"></a> <span class="k">with</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">output_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-269" name="__codelineno-0-269"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_sql</span><span class="p">(</span> <span class="c1"># type: ignore[reportUnknownMemberType]</span>
|
||||
<a id="__codelineno-0-270" name="__codelineno-0-270"></a> <span class="n">table_name</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-271" name="__codelineno-0-271"></a> <span class="n">conn</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-272" name="__codelineno-0-272"></a> <span class="n">if_exists</span><span class="o">=</span><span class="n">if_exists</span><span class="o">.</span><span class="n">value</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-273" name="__codelineno-0-273"></a> <span class="n">index</span><span class="o">=</span><span class="n">index</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-274" name="__codelineno-0-274"></a> <span class="n">index_label</span><span class="o">=</span><span class="n">index_label</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-275" name="__codelineno-0-275"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-276" name="__codelineno-0-276"></a> <span class="k">if</span> <span class="n">deduplicate_on</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-277" name="__codelineno-0-277"></a> <span class="kn">from</span><span class="w"> </span><span class="nn">.history</span><span class="w"> </span><span class="kn">import</span> <span class="n">drop_duplicates_in_table</span> <span class="c1"># noqa: PLC0415</span>
|
||||
<a id="__codelineno-0-278" name="__codelineno-0-278"></a>
|
||||
<a id="__codelineno-0-279" name="__codelineno-0-279"></a> <span class="n">drop_duplicates_in_table</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-280" name="__codelineno-0-280"></a> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">(),</span>
|
||||
<a id="__codelineno-0-281" name="__codelineno-0-281"></a> <span class="n">table_name</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="nb">list</span><span class="p">(</span><span class="n">deduplicate_on</span><span class="p">),</span>
|
||||
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="n">keep</span><span class="o">=</span><span class="s2">"last"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-284" name="__codelineno-0-284"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-285" name="__codelineno-0-285"></a> <span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
||||
<span class="normal"><a href="#__codelineno-0-285">285</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-286">286</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-287">287</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-288">288</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-289">289</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-290">290</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-291">291</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-292">292</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-293">293</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-294">294</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-295">295</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-296">296</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-297">297</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-298">298</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-299">299</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-258" name="__codelineno-0-258"></a><span class="k">def</span><span class="w"> </span><span class="nf">export_dataframe_to_sqlite</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-259" name="__codelineno-0-259"></a> <span class="n">df</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-261" name="__codelineno-0-261"></a> <span class="n">table_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"data"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-262" name="__codelineno-0-262"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-263" name="__codelineno-0-263"></a> <span class="n">if_exists</span><span class="p">:</span> <span class="n">IfExists</span> <span class="o">=</span> <span class="n">IfExists</span><span class="o">.</span><span class="n">APPEND</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-264" name="__codelineno-0-264"></a> <span class="n">index</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-265" name="__codelineno-0-265"></a> <span class="n">index_label</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-266" name="__codelineno-0-266"></a> <span class="n">deduplicate_on</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-267" name="__codelineno-0-267"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-268" name="__codelineno-0-268"></a><span class="w"> </span><span class="sd">"""Write a DataFrame to SQLite with configurable append and deduplication.</span>
|
||||
<a id="__codelineno-0-269" name="__codelineno-0-269"></a>
|
||||
<a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-271" name="__codelineno-0-271"></a><span class="sd"> df: DataFrame to export.</span>
|
||||
<a id="__codelineno-0-272" name="__codelineno-0-272"></a><span class="sd"> output_path: SQLite database path.</span>
|
||||
<a id="__codelineno-0-273" name="__codelineno-0-273"></a><span class="sd"> table_name: Target table name.</span>
|
||||
<a id="__codelineno-0-274" name="__codelineno-0-274"></a><span class="sd"> if_exists: Conflict behavior when the table already exists.</span>
|
||||
<a id="__codelineno-0-275" name="__codelineno-0-275"></a><span class="sd"> index: Whether to write the DataFrame index as a column.</span>
|
||||
<a id="__codelineno-0-276" name="__codelineno-0-276"></a><span class="sd"> index_label: Column name for the index when ``index=True``.</span>
|
||||
<a id="__codelineno-0-277" name="__codelineno-0-277"></a><span class="sd"> deduplicate_on: Optional key columns to deduplicate after writing,</span>
|
||||
<a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="sd"> keeping the latest ``ROWID`` per key group. Deduplication scans the</span>
|
||||
<a id="__codelineno-0-279" name="__codelineno-0-279"></a><span class="sd"> full table, so repeated appends cost O(table size); index the key</span>
|
||||
<a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="sd"> columns when appending frequently.</span>
|
||||
<a id="__codelineno-0-281" name="__codelineno-0-281"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="k">with</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">output_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_sql</span><span class="p">(</span> <span class="c1"># type: ignore[reportUnknownMemberType]</span>
|
||||
<a id="__codelineno-0-284" name="__codelineno-0-284"></a> <span class="n">table_name</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-285" name="__codelineno-0-285"></a> <span class="n">conn</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-286" name="__codelineno-0-286"></a> <span class="n">if_exists</span><span class="o">=</span><span class="n">if_exists</span><span class="o">.</span><span class="n">value</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-287" name="__codelineno-0-287"></a> <span class="n">index</span><span class="o">=</span><span class="n">index</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-288" name="__codelineno-0-288"></a> <span class="n">index_label</span><span class="o">=</span><span class="n">index_label</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-290" name="__codelineno-0-290"></a> <span class="k">if</span> <span class="n">deduplicate_on</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-291" name="__codelineno-0-291"></a> <span class="kn">from</span><span class="w"> </span><span class="nn">.history</span><span class="w"> </span><span class="kn">import</span> <span class="n">drop_duplicates_in_table</span> <span class="c1"># noqa: PLC0415</span>
|
||||
<a id="__codelineno-0-292" name="__codelineno-0-292"></a>
|
||||
<a id="__codelineno-0-293" name="__codelineno-0-293"></a> <span class="n">drop_duplicates_in_table</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-294" name="__codelineno-0-294"></a> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">(),</span>
|
||||
<a id="__codelineno-0-295" name="__codelineno-0-295"></a> <span class="n">table_name</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-296" name="__codelineno-0-296"></a> <span class="nb">list</span><span class="p">(</span><span class="n">deduplicate_on</span><span class="p">),</span>
|
||||
<a id="__codelineno-0-297" name="__codelineno-0-297"></a> <span class="n">keep</span><span class="o">=</span><span class="s2">"last"</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-298" name="__codelineno-0-298"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-299" name="__codelineno-0-299"></a> <span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -1606,47 +1676,47 @@ columns when appending frequently.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-329">329</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-330">330</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-331">331</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-336">336</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-337">337</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-342">342</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-343">343</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-343">343</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-344">344</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-345">345</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-346">346</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-347">347</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-348">348</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-349">349</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-329" name="__codelineno-0-329"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-330" name="__codelineno-0-330"></a><span class="w"> </span><span class="sd">"""Parse an ISO 8601 datetime string to a timezone-aware datetime.</span>
|
||||
<a id="__codelineno-0-331" name="__codelineno-0-331"></a>
|
||||
<a id="__codelineno-0-332" name="__codelineno-0-332"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-333" name="__codelineno-0-333"></a><span class="sd"> value: ISO 8601 datetime string (e.g., '2024-01-01' or</span>
|
||||
<a id="__codelineno-0-334" name="__codelineno-0-334"></a><span class="sd"> '2024-01-01T12:00:00+00:00').</span>
|
||||
<a id="__codelineno-0-335" name="__codelineno-0-335"></a>
|
||||
<a id="__codelineno-0-336" name="__codelineno-0-336"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-337" name="__codelineno-0-337"></a><span class="sd"> Parsed datetime with UTC timezone if no timezone is specified.</span>
|
||||
<a id="__codelineno-0-338" name="__codelineno-0-338"></a>
|
||||
<a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-340" name="__codelineno-0-340"></a><span class="sd"> ValueError: If the string cannot be parsed.</span>
|
||||
<a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-342" name="__codelineno-0-342"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-343" name="__codelineno-0-343"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid datetime format: '</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">'. Use ISO 8601 format."</span>
|
||||
<a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="k">if</span> <span class="n">dt</span><span class="o">.</span><span class="n">tzinfo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-348" name="__codelineno-0-348"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="k">return</span> <span class="n">dt</span>
|
||||
<span class="normal"><a href="#__codelineno-0-349">349</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-350">350</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-351">351</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-352">352</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-358">358</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-359">359</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">datetime</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-344" name="__codelineno-0-344"></a><span class="w"> </span><span class="sd">"""Parse an ISO 8601 datetime string to a timezone-aware datetime.</span>
|
||||
<a id="__codelineno-0-345" name="__codelineno-0-345"></a>
|
||||
<a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-347" name="__codelineno-0-347"></a><span class="sd"> value: ISO 8601 datetime string (e.g., '2024-01-01' or</span>
|
||||
<a id="__codelineno-0-348" name="__codelineno-0-348"></a><span class="sd"> '2024-01-01T12:00:00+00:00').</span>
|
||||
<a id="__codelineno-0-349" name="__codelineno-0-349"></a>
|
||||
<a id="__codelineno-0-350" name="__codelineno-0-350"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-351" name="__codelineno-0-351"></a><span class="sd"> Parsed datetime with UTC timezone if no timezone is specified.</span>
|
||||
<a id="__codelineno-0-352" name="__codelineno-0-352"></a>
|
||||
<a id="__codelineno-0-353" name="__codelineno-0-353"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-354" name="__codelineno-0-354"></a><span class="sd"> ValueError: If the string cannot be parsed.</span>
|
||||
<a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid datetime format: '</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">'. Use ISO 8601 format."</span>
|
||||
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="k">if</span> <span class="n">dt</span><span class="o">.</span><span class="n">tzinfo</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="n">dt</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="k">return</span> <span class="n">dt</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -1749,21 +1819,7 @@ JSON object.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-404">404</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-405">405</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-406">406</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-407">407</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-408">408</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-409">409</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-410">410</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-411">411</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-412">412</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-417">417</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-418">418</a></span>
|
||||
<div class="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>
|
||||
<span class="normal"><a href="#__codelineno-0-420">420</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-421">421</a></span>
|
||||
@@ -1779,37 +1835,51 @@ JSON object.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-431">431</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-432">432</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-433">433</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-434">434</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_request</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
|
||||
<a id="__codelineno-0-405" name="__codelineno-0-405"></a><span class="w"> </span><span class="sd">"""Parse a JSON-formatted order request string or file reference.</span>
|
||||
<a id="__codelineno-0-406" name="__codelineno-0-406"></a>
|
||||
<a id="__codelineno-0-407" name="__codelineno-0-407"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-408" name="__codelineno-0-408"></a><span class="sd"> value: JSON object string, or '@path' to read JSON from a file.</span>
|
||||
<a id="__codelineno-0-409" name="__codelineno-0-409"></a>
|
||||
<a id="__codelineno-0-410" name="__codelineno-0-410"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-411" name="__codelineno-0-411"></a><span class="sd"> Parsed request dictionary.</span>
|
||||
<a id="__codelineno-0-412" name="__codelineno-0-412"></a>
|
||||
<a id="__codelineno-0-413" name="__codelineno-0-413"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-414" name="__codelineno-0-414"></a><span class="sd"> ValueError: If the request file cannot be read or the value is not a</span>
|
||||
<a id="__codelineno-0-415" name="__codelineno-0-415"></a><span class="sd"> JSON object.</span>
|
||||
<a id="__codelineno-0-416" name="__codelineno-0-416"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-417" name="__codelineno-0-417"></a> <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"@"</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-418" name="__codelineno-0-418"></a> <span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
|
||||
<a id="__codelineno-0-419" name="__codelineno-0-419"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-420" name="__codelineno-0-420"></a> <span class="n">text</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">read_text</span><span class="p">(</span><span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-421" name="__codelineno-0-421"></a> <span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="ne">UnicodeDecodeError</span><span class="p">)</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-422" name="__codelineno-0-422"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Failed to read JSON request file '</span><span class="si">{</span><span class="n">path</span><span class="si">}</span><span class="s2">': </span><span class="si">{</span><span class="n">exc</span><span class="si">}</span><span class="s2">"</span>
|
||||
<a id="__codelineno-0-423" name="__codelineno-0-423"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
|
||||
<a id="__codelineno-0-424" name="__codelineno-0-424"></a> <span class="k">else</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-425" name="__codelineno-0-425"></a> <span class="n">text</span> <span class="o">=</span> <span class="n">value</span>
|
||||
<a id="__codelineno-0-426" name="__codelineno-0-426"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-427" name="__codelineno-0-427"></a> <span class="n">parsed</span><span class="p">:</span> <span class="nb">object</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-428" name="__codelineno-0-428"></a> <span class="k">except</span> <span class="n">json</span><span class="o">.</span><span class="n">JSONDecodeError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-429" name="__codelineno-0-429"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid JSON request: </span><span class="si">{</span><span class="n">exc</span><span class="si">}</span><span class="s2">"</span>
|
||||
<a id="__codelineno-0-430" name="__codelineno-0-430"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
|
||||
<a id="__codelineno-0-431" name="__codelineno-0-431"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">_is_request_dict</span><span class="p">(</span><span class="n">parsed</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-432" name="__codelineno-0-432"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">"Order request must be a JSON object."</span>
|
||||
<a id="__codelineno-0-433" name="__codelineno-0-433"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-434" name="__codelineno-0-434"></a> <span class="k">return</span> <span class="n">parsed</span>
|
||||
<span class="normal"><a href="#__codelineno-0-434">434</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-435">435</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-440">440</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-441">441</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-446">446</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-447">447</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-448">448</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-418" name="__codelineno-0-418"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_request</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
|
||||
<a id="__codelineno-0-419" name="__codelineno-0-419"></a><span class="w"> </span><span class="sd">"""Parse a JSON-formatted order request string or file reference.</span>
|
||||
<a id="__codelineno-0-420" name="__codelineno-0-420"></a>
|
||||
<a id="__codelineno-0-421" name="__codelineno-0-421"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-422" name="__codelineno-0-422"></a><span class="sd"> value: JSON object string, or '@path' to read JSON from a file.</span>
|
||||
<a id="__codelineno-0-423" name="__codelineno-0-423"></a>
|
||||
<a id="__codelineno-0-424" name="__codelineno-0-424"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-425" name="__codelineno-0-425"></a><span class="sd"> Parsed request dictionary.</span>
|
||||
<a id="__codelineno-0-426" name="__codelineno-0-426"></a>
|
||||
<a id="__codelineno-0-427" name="__codelineno-0-427"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-428" name="__codelineno-0-428"></a><span class="sd"> ValueError: If the request file cannot be read or the value is not a</span>
|
||||
<a id="__codelineno-0-429" name="__codelineno-0-429"></a><span class="sd"> JSON object.</span>
|
||||
<a id="__codelineno-0-430" name="__codelineno-0-430"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-431" name="__codelineno-0-431"></a> <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"@"</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-432" name="__codelineno-0-432"></a> <span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">value</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
|
||||
<a id="__codelineno-0-433" name="__codelineno-0-433"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-434" name="__codelineno-0-434"></a> <span class="n">text</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">read_text</span><span class="p">(</span><span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-435" name="__codelineno-0-435"></a> <span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="ne">UnicodeDecodeError</span><span class="p">)</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-436" name="__codelineno-0-436"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Failed to read JSON request file '</span><span class="si">{</span><span class="n">path</span><span class="si">}</span><span class="s2">': </span><span class="si">{</span><span class="n">exc</span><span class="si">}</span><span class="s2">"</span>
|
||||
<a id="__codelineno-0-437" name="__codelineno-0-437"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
|
||||
<a id="__codelineno-0-438" name="__codelineno-0-438"></a> <span class="k">else</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-439" name="__codelineno-0-439"></a> <span class="n">text</span> <span class="o">=</span> <span class="n">value</span>
|
||||
<a id="__codelineno-0-440" name="__codelineno-0-440"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-441" name="__codelineno-0-441"></a> <span class="n">parsed</span><span class="p">:</span> <span class="nb">object</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-442" name="__codelineno-0-442"></a> <span class="k">except</span> <span class="n">json</span><span class="o">.</span><span class="n">JSONDecodeError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-443" name="__codelineno-0-443"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid JSON request: </span><span class="si">{</span><span class="n">exc</span><span class="si">}</span><span class="s2">"</span>
|
||||
<a id="__codelineno-0-444" name="__codelineno-0-444"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
|
||||
<a id="__codelineno-0-445" name="__codelineno-0-445"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">_is_request_dict</span><span class="p">(</span><span class="n">parsed</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-446" name="__codelineno-0-446"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">"Order request must be a JSON object."</span>
|
||||
<a id="__codelineno-0-447" name="__codelineno-0-447"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-448" name="__codelineno-0-448"></a> <span class="k">return</span> <span class="n">parsed</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -1911,49 +1981,49 @@ JSON object.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-376">376</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-377">377</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-378">378</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-384">384</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-389">389</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-390">390</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-390">390</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-391">391</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-392">392</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-393">393</a></span>
|
||||
<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><a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_tick_flags</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="w"> </span><span class="sd">"""Parse tick flags string or integer value.</span>
|
||||
<a id="__codelineno-0-378" name="__codelineno-0-378"></a>
|
||||
<a id="__codelineno-0-379" name="__codelineno-0-379"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-380" name="__codelineno-0-380"></a><span class="sd"> value: Tick flag name (ALL, INFO, TRADE, COPY_TICKS_*) or integer value.</span>
|
||||
<a id="__codelineno-0-381" name="__codelineno-0-381"></a>
|
||||
<a id="__codelineno-0-382" name="__codelineno-0-382"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-383" name="__codelineno-0-383"></a><span class="sd"> Integer tick flag value compatible with MetaTrader 5 ``COPY_TICKS_*``.</span>
|
||||
<a id="__codelineno-0-384" name="__codelineno-0-384"></a>
|
||||
<a id="__codelineno-0-385" name="__codelineno-0-385"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-386" name="__codelineno-0-386"></a><span class="sd"> ValueError: If the flag is invalid.</span>
|
||||
<a id="__codelineno-0-387" name="__codelineno-0-387"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="k">return</span> <span class="n">_parse_copy_ticks</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_TICK_FLAG_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-394" name="__codelineno-0-394"></a> <span class="sa">f</span><span class="s2">"Invalid tick flags: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-395" name="__codelineno-0-395"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-396" name="__codelineno-0-396"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-397" name="__codelineno-0-397"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<span class="normal"><a href="#__codelineno-0-397">397</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-398">398</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-399">399</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-404">404</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-405">405</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-406">406</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-407">407</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-408">408</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-409">409</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-410">410</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-411">411</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-390" name="__codelineno-0-390"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_tick_flags</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-391" name="__codelineno-0-391"></a><span class="w"> </span><span class="sd">"""Parse tick flags string or integer value.</span>
|
||||
<a id="__codelineno-0-392" name="__codelineno-0-392"></a>
|
||||
<a id="__codelineno-0-393" name="__codelineno-0-393"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-394" name="__codelineno-0-394"></a><span class="sd"> value: Tick flag name (ALL, INFO, TRADE, COPY_TICKS_*) or integer value.</span>
|
||||
<a id="__codelineno-0-395" name="__codelineno-0-395"></a>
|
||||
<a id="__codelineno-0-396" name="__codelineno-0-396"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="sd"> Integer tick flag value compatible with MetaTrader 5 ``COPY_TICKS_*``.</span>
|
||||
<a id="__codelineno-0-398" name="__codelineno-0-398"></a>
|
||||
<a id="__codelineno-0-399" name="__codelineno-0-399"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-400" name="__codelineno-0-400"></a><span class="sd"> ValueError: If the flag is invalid.</span>
|
||||
<a id="__codelineno-0-401" name="__codelineno-0-401"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-402" name="__codelineno-0-402"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-403" name="__codelineno-0-403"></a> <span class="k">return</span> <span class="n">_parse_copy_ticks</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-404" name="__codelineno-0-404"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-405" name="__codelineno-0-405"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-406" name="__codelineno-0-406"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_TICK_FLAG_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-408" name="__codelineno-0-408"></a> <span class="sa">f</span><span class="s2">"Invalid tick flags: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-409" name="__codelineno-0-409"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-410" name="__codelineno-0-410"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-411" name="__codelineno-0-411"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -2055,49 +2125,49 @@ JSON object.</p>
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/utils.py</code></summary>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-352">352</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-358">358</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-359">359</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-364">364</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-365">365</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-366">366</a></span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-366">366</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-367">367</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-372">372</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-373">373</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-352" name="__codelineno-0-352"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-353" name="__codelineno-0-353"></a><span class="w"> </span><span class="sd">"""Parse a timeframe string or integer value.</span>
|
||||
<a id="__codelineno-0-354" name="__codelineno-0-354"></a>
|
||||
<a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-356" name="__codelineno-0-356"></a><span class="sd"> value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</span>
|
||||
<a id="__codelineno-0-357" name="__codelineno-0-357"></a>
|
||||
<a id="__codelineno-0-358" name="__codelineno-0-358"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-359" name="__codelineno-0-359"></a><span class="sd"> Integer timeframe value.</span>
|
||||
<a id="__codelineno-0-360" name="__codelineno-0-360"></a>
|
||||
<a id="__codelineno-0-361" name="__codelineno-0-361"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-362" name="__codelineno-0-362"></a><span class="sd"> ValueError: If the timeframe is invalid.</span>
|
||||
<a id="__codelineno-0-363" name="__codelineno-0-363"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="k">return</span> <span class="n">_parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">TIMEFRAME_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-369" name="__codelineno-0-369"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="sa">f</span><span class="s2">"Invalid timeframe: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-373" name="__codelineno-0-373"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
<span class="normal"><a href="#__codelineno-0-373">373</a></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>
|
||||
<span class="normal"><a href="#__codelineno-0-378">378</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-384">384</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-366" name="__codelineno-0-366"></a><span class="k">def</span><span class="w"> </span><span class="nf">parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">object</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-367" name="__codelineno-0-367"></a><span class="w"> </span><span class="sd">"""Parse a timeframe string or integer value.</span>
|
||||
<a id="__codelineno-0-368" name="__codelineno-0-368"></a>
|
||||
<a id="__codelineno-0-369" name="__codelineno-0-369"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-370" name="__codelineno-0-370"></a><span class="sd"> value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</span>
|
||||
<a id="__codelineno-0-371" name="__codelineno-0-371"></a>
|
||||
<a id="__codelineno-0-372" name="__codelineno-0-372"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-373" name="__codelineno-0-373"></a><span class="sd"> Integer timeframe value.</span>
|
||||
<a id="__codelineno-0-374" name="__codelineno-0-374"></a>
|
||||
<a id="__codelineno-0-375" name="__codelineno-0-375"></a><span class="sd"> Raises:</span>
|
||||
<a id="__codelineno-0-376" name="__codelineno-0-376"></a><span class="sd"> ValueError: If the timeframe is invalid.</span>
|
||||
<a id="__codelineno-0-377" name="__codelineno-0-377"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-378" name="__codelineno-0-378"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="k">return</span> <span class="n">_parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="n">display</span> <span class="o">=</span> <span class="n">value</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="n">valid</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">TIMEFRAME_NAMES</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-383" name="__codelineno-0-383"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
||||
<a id="__codelineno-0-384" name="__codelineno-0-384"></a> <span class="sa">f</span><span class="s2">"Invalid timeframe: '</span><span class="si">{</span><span class="n">display</span><span class="si">}</span><span class="s2">'. "</span>
|
||||
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="sa">f</span><span class="s2">"Use one of: </span><span class="si">{</span><span class="n">valid</span><span class="si">}</span><span class="s2">, or a supported integer."</span>
|
||||
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
+1
-1
@@ -649,5 +649,5 @@
|
||||
|
||||
<!--
|
||||
MkDocs version : 1.6.1
|
||||
Build Date UTC : 2026-06-14 14:09:16.316415+00:00
|
||||
Build Date UTC : 2026-06-14 17:47:47.514428+00:00
|
||||
-->
|
||||
|
||||
BIN
Binary file not shown.
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user