deploy: c2cf0656dd
This commit is contained in:
dceoy
+96
-96
@@ -250,7 +250,12 @@ 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-432">432</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-427">427</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-428">428</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-429">429</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-430">430</a></span>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-435">435</a></span>
|
||||
@@ -280,47 +285,42 @@ responsibility of downstream applications.</p>
|
||||
<span class="normal"><a href="#__codelineno-0-459">459</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-460">460</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-461">461</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-462">462</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-463">463</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-464">464</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-465">465</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-466">466</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-467">467</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-432" name="__codelineno-0-432"></a><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-433" name="__codelineno-0-433"></a> <span class="bp">self</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-434" name="__codelineno-0-434"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-435" name="__codelineno-0-435"></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-436" name="__codelineno-0-436"></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-437" name="__codelineno-0-437"></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-438" name="__codelineno-0-438"></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-439" name="__codelineno-0-439"></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-440" name="__codelineno-0-440"></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-441" name="__codelineno-0-441"></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-442" name="__codelineno-0-442"></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-443" name="__codelineno-0-443"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-444" name="__codelineno-0-444"></a><span class="w"> </span><span class="sd">"""Initialize the SDK client.</span>
|
||||
<a id="__codelineno-0-445" name="__codelineno-0-445"></a>
|
||||
<a id="__codelineno-0-446" name="__codelineno-0-446"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-447" name="__codelineno-0-447"></a><span class="sd"> path: Path to MetaTrader5 terminal EXE file.</span>
|
||||
<a id="__codelineno-0-448" name="__codelineno-0-448"></a><span class="sd"> login: Trading account login.</span>
|
||||
<a id="__codelineno-0-449" name="__codelineno-0-449"></a><span class="sd"> password: Trading account password.</span>
|
||||
<a id="__codelineno-0-450" name="__codelineno-0-450"></a><span class="sd"> server: Trading server name.</span>
|
||||
<a id="__codelineno-0-451" name="__codelineno-0-451"></a><span class="sd"> timeout: Connection timeout in milliseconds.</span>
|
||||
<a id="__codelineno-0-452" name="__codelineno-0-452"></a><span class="sd"> retry_count: Number of MT5 initialization retries for sessions</span>
|
||||
<a id="__codelineno-0-453" name="__codelineno-0-453"></a><span class="sd"> opened by this client.</span>
|
||||
<a id="__codelineno-0-454" name="__codelineno-0-454"></a><span class="sd"> config: Optional pre-built ``Mt5Config`` (overrides other args).</span>
|
||||
<a id="__codelineno-0-455" name="__codelineno-0-455"></a><span class="sd"> client: Optional already-connected ``Mt5DataClient``. Injected</span>
|
||||
<a id="__codelineno-0-456" name="__codelineno-0-456"></a><span class="sd"> clients are reused as-is and are not initialized or shut down.</span>
|
||||
<a id="__codelineno-0-457" name="__codelineno-0-457"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-458" name="__codelineno-0-458"></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-459" name="__codelineno-0-459"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-460" name="__codelineno-0-460"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-461" name="__codelineno-0-461"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-462" name="__codelineno-0-462"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-463" name="__codelineno-0-463"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-464" name="__codelineno-0-464"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-465" name="__codelineno-0-465"></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-466" name="__codelineno-0-466"></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-467" name="__codelineno-0-467"></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-462">462</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-427" name="__codelineno-0-427"></a><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-428" name="__codelineno-0-428"></a> <span class="bp">self</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-429" name="__codelineno-0-429"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-430" name="__codelineno-0-430"></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-431" name="__codelineno-0-431"></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-432" name="__codelineno-0-432"></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-433" name="__codelineno-0-433"></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-434" name="__codelineno-0-434"></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-435" name="__codelineno-0-435"></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-436" name="__codelineno-0-436"></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-437" name="__codelineno-0-437"></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-438" name="__codelineno-0-438"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-439" name="__codelineno-0-439"></a><span class="w"> </span><span class="sd">"""Initialize the SDK client.</span>
|
||||
<a id="__codelineno-0-440" name="__codelineno-0-440"></a>
|
||||
<a id="__codelineno-0-441" name="__codelineno-0-441"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-442" name="__codelineno-0-442"></a><span class="sd"> path: Path to MetaTrader5 terminal EXE file.</span>
|
||||
<a id="__codelineno-0-443" name="__codelineno-0-443"></a><span class="sd"> login: Trading account login.</span>
|
||||
<a id="__codelineno-0-444" name="__codelineno-0-444"></a><span class="sd"> password: Trading account password.</span>
|
||||
<a id="__codelineno-0-445" name="__codelineno-0-445"></a><span class="sd"> server: Trading server name.</span>
|
||||
<a id="__codelineno-0-446" name="__codelineno-0-446"></a><span class="sd"> timeout: Connection timeout in milliseconds.</span>
|
||||
<a id="__codelineno-0-447" name="__codelineno-0-447"></a><span class="sd"> retry_count: Number of MT5 initialization retries for sessions</span>
|
||||
<a id="__codelineno-0-448" name="__codelineno-0-448"></a><span class="sd"> opened by this client.</span>
|
||||
<a id="__codelineno-0-449" name="__codelineno-0-449"></a><span class="sd"> config: Optional pre-built ``Mt5Config`` (overrides other args).</span>
|
||||
<a id="__codelineno-0-450" name="__codelineno-0-450"></a><span class="sd"> client: Optional already-connected ``Mt5DataClient``. Injected</span>
|
||||
<a id="__codelineno-0-451" name="__codelineno-0-451"></a><span class="sd"> clients are reused as-is and are not initialized or shut down.</span>
|
||||
<a id="__codelineno-0-452" name="__codelineno-0-452"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-453" name="__codelineno-0-453"></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-454" name="__codelineno-0-454"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-455" name="__codelineno-0-455"></a> <span class="n">login</span><span class="o">=</span><span class="n">login</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-456" name="__codelineno-0-456"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-457" name="__codelineno-0-457"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-458" name="__codelineno-0-458"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-459" name="__codelineno-0-459"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-460" name="__codelineno-0-460"></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-461" name="__codelineno-0-461"></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-462" name="__codelineno-0-462"></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>
|
||||
|
||||
@@ -797,7 +797,12 @@ to <code>path</code>, <code>login</code>, <code>password</code>, and <code>serve
|
||||
|
||||
<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-324">324</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-319">319</a></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>
|
||||
<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>
|
||||
<span class="normal"><a href="#__codelineno-0-327">327</a></span>
|
||||
@@ -839,59 +844,54 @@ to <code>path</code>, <code>login</code>, <code>password</code>, and <code>serve
|
||||
<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>
|
||||
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-324" name="__codelineno-0-324"></a><span class="k">def</span><span class="w"> </span><span class="nf">build_config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-325" name="__codelineno-0-325"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-326" name="__codelineno-0-326"></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-327" name="__codelineno-0-327"></a> <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="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-328" name="__codelineno-0-328"></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-329" name="__codelineno-0-329"></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-330" name="__codelineno-0-330"></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-331" name="__codelineno-0-331"></a> <span class="n">allow_whole_dollar_env</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-332" name="__codelineno-0-332"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5Config</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-333" name="__codelineno-0-333"></a><span class="w"> </span><span class="sd">"""Build an ``Mt5Config`` from optional connection parameters.</span>
|
||||
<a id="__codelineno-0-334" name="__codelineno-0-334"></a>
|
||||
<a id="__codelineno-0-335" name="__codelineno-0-335"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-336" name="__codelineno-0-336"></a><span class="sd"> path: Optional terminal executable path.</span>
|
||||
<a id="__codelineno-0-337" name="__codelineno-0-337"></a><span class="sd"> login: Optional trading account login. Integers are preserved. String</span>
|
||||
<a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="sd"> values are coerced: empty or whitespace-only strings become</span>
|
||||
<a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="sd"> ``None``; numeric strings such as ``"12345"`` are converted to</span>
|
||||
<a id="__codelineno-0-340" name="__codelineno-0-340"></a><span class="sd"> ``int``; non-numeric strings raise ``ValueError``. When</span>
|
||||
<a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> ``allow_whole_dollar_env=True``, ``$ENV_NAME`` and</span>
|
||||
<a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="sd"> ``${ENV_NAME}`` placeholders are expanded before coercion.</span>
|
||||
<a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="sd"> password: Optional trading account password.</span>
|
||||
<a id="__codelineno-0-344" name="__codelineno-0-344"></a><span class="sd"> server: Optional trading server name.</span>
|
||||
<a id="__codelineno-0-345" name="__codelineno-0-345"></a><span class="sd"> timeout: Optional connection timeout in milliseconds.</span>
|
||||
<a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="sd"> allow_whole_dollar_env: When ``True``, string parameters that are</span>
|
||||
<a id="__codelineno-0-347" name="__codelineno-0-347"></a><span class="sd"> exactly ``$ENV_NAME`` are expanded from the environment. Applies</span>
|
||||
<a id="__codelineno-0-348" name="__codelineno-0-348"></a><span class="sd"> to ``path``, ``login``, ``password``, and ``server``. Default</span>
|
||||
<a id="__codelineno-0-349" name="__codelineno-0-349"></a><span class="sd"> ``False`` preserves existing behavior.</span>
|
||||
<a id="__codelineno-0-350" name="__codelineno-0-350"></a>
|
||||
<a id="__codelineno-0-351" name="__codelineno-0-351"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-352" name="__codelineno-0-352"></a><span class="sd"> Configured ``Mt5Config`` instance.</span>
|
||||
<a id="__codelineno-0-353" name="__codelineno-0-353"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="k">if</span> <span class="n">allow_whole_dollar_env</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="k">if</span> <span class="n">path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="n">path</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">login</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="n">login</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span><span class="n">login</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="k">if</span> <span class="n">password</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="n">password</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="n">password</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span>
|
||||
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="k">if</span> <span class="n">server</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="n">server</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span><span class="n">server</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="k">return</span> <span class="n">Mt5Config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="n">login</span><span class="o">=</span><span class="n">_coerce_login</span><span class="p">(</span><span class="n">login</span><span class="p">),</span>
|
||||
<a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-369" name="__codelineno-0-369"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="p">)</span>
|
||||
<span class="normal"><a href="#__codelineno-0-366">366</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-319" name="__codelineno-0-319"></a><span class="k">def</span><span class="w"> </span><span class="nf">build_config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="o">*</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-321" name="__codelineno-0-321"></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-322" name="__codelineno-0-322"></a> <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="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-323" name="__codelineno-0-323"></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-324" name="__codelineno-0-324"></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-325" name="__codelineno-0-325"></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-326" name="__codelineno-0-326"></a> <span class="n">allow_whole_dollar_env</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-327" name="__codelineno-0-327"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5Config</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-328" name="__codelineno-0-328"></a><span class="w"> </span><span class="sd">"""Build an ``Mt5Config`` from optional connection parameters.</span>
|
||||
<a id="__codelineno-0-329" name="__codelineno-0-329"></a>
|
||||
<a id="__codelineno-0-330" name="__codelineno-0-330"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-331" name="__codelineno-0-331"></a><span class="sd"> path: Optional terminal executable path.</span>
|
||||
<a id="__codelineno-0-332" name="__codelineno-0-332"></a><span class="sd"> login: Optional trading account login. Integers are preserved. String</span>
|
||||
<a id="__codelineno-0-333" name="__codelineno-0-333"></a><span class="sd"> values are coerced: empty or whitespace-only strings become</span>
|
||||
<a id="__codelineno-0-334" name="__codelineno-0-334"></a><span class="sd"> ``None``; numeric strings such as ``"12345"`` are converted to</span>
|
||||
<a id="__codelineno-0-335" name="__codelineno-0-335"></a><span class="sd"> ``int``; non-numeric strings raise ``ValueError``. When</span>
|
||||
<a id="__codelineno-0-336" name="__codelineno-0-336"></a><span class="sd"> ``allow_whole_dollar_env=True``, ``$ENV_NAME`` and</span>
|
||||
<a id="__codelineno-0-337" name="__codelineno-0-337"></a><span class="sd"> ``${ENV_NAME}`` placeholders are expanded before coercion.</span>
|
||||
<a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="sd"> password: Optional trading account password.</span>
|
||||
<a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="sd"> server: Optional trading server name.</span>
|
||||
<a id="__codelineno-0-340" name="__codelineno-0-340"></a><span class="sd"> timeout: Optional connection timeout in milliseconds.</span>
|
||||
<a id="__codelineno-0-341" name="__codelineno-0-341"></a><span class="sd"> allow_whole_dollar_env: When ``True``, string parameters that are</span>
|
||||
<a id="__codelineno-0-342" name="__codelineno-0-342"></a><span class="sd"> exactly ``$ENV_NAME`` are expanded from the environment. Applies</span>
|
||||
<a id="__codelineno-0-343" name="__codelineno-0-343"></a><span class="sd"> to ``path``, ``login``, ``password``, and ``server``. Default</span>
|
||||
<a id="__codelineno-0-344" name="__codelineno-0-344"></a><span class="sd"> ``False`` preserves existing behavior.</span>
|
||||
<a id="__codelineno-0-345" name="__codelineno-0-345"></a>
|
||||
<a id="__codelineno-0-346" name="__codelineno-0-346"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-347" name="__codelineno-0-347"></a><span class="sd"> Configured ``Mt5Config`` instance.</span>
|
||||
<a id="__codelineno-0-348" name="__codelineno-0-348"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="k">if</span> <span class="n">allow_whole_dollar_env</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-350" name="__codelineno-0-350"></a> <span class="k">if</span> <span class="n">path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-351" name="__codelineno-0-351"></a> <span class="n">path</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">login</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-353" name="__codelineno-0-353"></a> <span class="n">login</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span><span class="n">login</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="k">if</span> <span class="n">password</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="n">password</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-356" name="__codelineno-0-356"></a> <span class="n">password</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span>
|
||||
<a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="p">)</span>
|
||||
<a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="k">if</span> <span class="n">server</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="n">server</span> <span class="o">=</span> <span class="n">substitute_env_placeholders</span><span class="p">(</span><span class="n">server</span><span class="p">,</span> <span class="n">allow_whole_dollar_env</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="k">return</span> <span class="n">Mt5Config</span><span class="p">(</span>
|
||||
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="n">login</span><span class="o">=</span><span class="n">_coerce_login</span><span class="p">(</span><span class="n">login</span><span class="p">),</span>
|
||||
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="n">server</span><span class="o">=</span><span class="n">server</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
||||
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="p">)</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
+71
-75
@@ -453,33 +453,33 @@
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/exceptions.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-82">82</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-72">72</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-74">74</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-75">75</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-76">76</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-77">77</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-78">78</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-79">79</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-80">80</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-81">81</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-82">82</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-83">83</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-84">84</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-85">85</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-86">86</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-87">87</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-88">88</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-89">89</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-90">90</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-91">91</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-92">92</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-93">93</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-94">94</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-95">95</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-82" name="__codelineno-0-82"></a><span class="k">def</span><span class="w"> </span><span class="nf">call_with_normalized_errors</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[],</span> <span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-83" name="__codelineno-0-83"></a><span class="w"> </span><span class="sd">"""Run ``fn`` and map recoverable MT5 errors to mt5cli types.</span>
|
||||
<a id="__codelineno-0-84" name="__codelineno-0-84"></a>
|
||||
<a id="__codelineno-0-85" name="__codelineno-0-85"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-86" name="__codelineno-0-86"></a><span class="sd"> fn: Callable performing MT5 work.</span>
|
||||
<a id="__codelineno-0-87" name="__codelineno-0-87"></a>
|
||||
<a id="__codelineno-0-88" name="__codelineno-0-88"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-89" name="__codelineno-0-89"></a><span class="sd"> Value returned by ``fn``.</span>
|
||||
<a id="__codelineno-0-90" name="__codelineno-0-90"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="k">return</span> <span class="n">fn</span><span class="p">()</span>
|
||||
<a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="k">except</span> <span class="n">_RECOVERABLE_MT5_ERRORS</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-94" name="__codelineno-0-94"></a> <span class="n">normalized</span> <span class="o">=</span> <span class="n">normalize_mt5_exception</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="k">raise</span> <span class="n">normalized</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
|
||||
<span class="normal"><a href="#__codelineno-0-85">85</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-72" name="__codelineno-0-72"></a><span class="k">def</span><span class="w"> </span><span class="nf">call_with_normalized_errors</span><span class="p">(</span><span class="n">fn</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[],</span> <span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-73" name="__codelineno-0-73"></a><span class="w"> </span><span class="sd">"""Run ``fn`` and map recoverable MT5 errors to mt5cli types.</span>
|
||||
<a id="__codelineno-0-74" name="__codelineno-0-74"></a>
|
||||
<a id="__codelineno-0-75" name="__codelineno-0-75"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-76" name="__codelineno-0-76"></a><span class="sd"> fn: Callable performing MT5 work.</span>
|
||||
<a id="__codelineno-0-77" name="__codelineno-0-77"></a>
|
||||
<a id="__codelineno-0-78" name="__codelineno-0-78"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-79" name="__codelineno-0-79"></a><span class="sd"> Value returned by ``fn``.</span>
|
||||
<a id="__codelineno-0-80" name="__codelineno-0-80"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="k">try</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="k">return</span> <span class="n">fn</span><span class="p">()</span>
|
||||
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="k">except</span> <span class="n">_RECOVERABLE_MT5_ERRORS</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-84" name="__codelineno-0-84"></a> <span class="n">normalized</span> <span class="o">=</span> <span class="n">normalize_mt5_exception</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span>
|
||||
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="k">raise</span> <span class="n">normalized</span> <span class="kn">from</span><span class="w"> </span><span class="nn">exc</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -548,7 +548,7 @@
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>True for <code>Mt5RuntimeError</code> and <code>Mt5TradingError</code> (if available).</p>
|
||||
<p>True for <code>Mt5RuntimeError</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -558,25 +558,25 @@
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/exceptions.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-51">51</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-52">52</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-53">53</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-54">54</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-55">55</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-60">60</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="k">def</span><span class="w"> </span><span class="nf">is_recoverable_mt5_error</span><span class="p">(</span><span class="n">exc</span><span class="p">:</span> <span class="ne">BaseException</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="w"> </span><span class="sd">"""Return whether an exception is a transient MT5 failure worth retrying.</span>
|
||||
<a id="__codelineno-0-53" name="__codelineno-0-53"></a>
|
||||
<a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="sd"> exc: Exception raised by MT5 or pdmt5.</span>
|
||||
<a id="__codelineno-0-56" name="__codelineno-0-56"></a>
|
||||
<a id="__codelineno-0-57" name="__codelineno-0-57"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="sd"> True for ``Mt5RuntimeError`` and ``Mt5TradingError`` (if available).</span>
|
||||
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-60" name="__codelineno-0-60"></a> <span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">_RECOVERABLE_MT5_ERRORS</span><span class="p">)</span>
|
||||
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-48">48</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-51">51</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-52">52</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-43" name="__codelineno-0-43"></a><span class="k">def</span><span class="w"> </span><span class="nf">is_recoverable_mt5_error</span><span class="p">(</span><span class="n">exc</span><span class="p">:</span> <span class="ne">BaseException</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="w"> </span><span class="sd">"""Return whether an exception is a transient MT5 failure worth retrying.</span>
|
||||
<a id="__codelineno-0-45" name="__codelineno-0-45"></a>
|
||||
<a id="__codelineno-0-46" name="__codelineno-0-46"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-47" name="__codelineno-0-47"></a><span class="sd"> exc: Exception raised by MT5 or pdmt5.</span>
|
||||
<a id="__codelineno-0-48" name="__codelineno-0-48"></a>
|
||||
<a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="sd"> True for ``Mt5RuntimeError``.</span>
|
||||
<a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">_RECOVERABLE_MT5_ERRORS</span><span class="p">)</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
@@ -645,7 +645,7 @@
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p><code>Mt5ConnectionError</code> for runtime failures, <code>Mt5OperationError</code> for</p>
|
||||
<p><code>Mt5ConnectionError</code> for runtime failures, or the original exception</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -655,7 +655,7 @@
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>trading failures, or the original exception when it is not recognized.</p>
|
||||
<p>when it is not recognized.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -665,39 +665,35 @@
|
||||
|
||||
<details class="mkdocstrings-source">
|
||||
<summary>Source code in <code>mt5cli/exceptions.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-63">63</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-55">55</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-60">60</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-61">61</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-62">62</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-63">63</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-64">64</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-65">65</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-66">66</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-67">67</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-68">68</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-69">69</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-70">70</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-71">71</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-72">72</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-74">74</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-75">75</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-76">76</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-77">77</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-78">78</a></span>
|
||||
<span class="normal"><a href="#__codelineno-0-79">79</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="k">def</span><span class="w"> </span><span class="nf">normalize_mt5_exception</span><span class="p">(</span><span class="n">exc</span><span class="p">:</span> <span class="ne">BaseException</span><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5CliError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="w"> </span><span class="sd">"""Map pdmt5/MT5 exceptions to stable mt5cli exception types.</span>
|
||||
<a id="__codelineno-0-65" name="__codelineno-0-65"></a>
|
||||
<a id="__codelineno-0-66" name="__codelineno-0-66"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-67" name="__codelineno-0-67"></a><span class="sd"> exc: Original exception from MT5 or pdmt5.</span>
|
||||
<a id="__codelineno-0-68" name="__codelineno-0-68"></a>
|
||||
<a id="__codelineno-0-69" name="__codelineno-0-69"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-70" name="__codelineno-0-70"></a><span class="sd"> ``Mt5ConnectionError`` for runtime failures, ``Mt5OperationError`` for</span>
|
||||
<a id="__codelineno-0-71" name="__codelineno-0-71"></a><span class="sd"> trading failures, or the original exception when it is not recognized.</span>
|
||||
<a id="__codelineno-0-72" name="__codelineno-0-72"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="k">if</span> <span class="n">Mt5TradingError</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">Mt5TradingError</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="k">return</span> <span class="n">Mt5OperationError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
|
||||
<a id="__codelineno-0-75" name="__codelineno-0-75"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">Mt5RuntimeError</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="k">return</span> <span class="n">Mt5ConnectionError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
|
||||
<a id="__codelineno-0-77" name="__codelineno-0-77"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">Mt5CliError</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="k">return</span> <span class="n">exc</span>
|
||||
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="k">return</span> <span class="n">Mt5CliError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
|
||||
<span class="normal"><a href="#__codelineno-0-69">69</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="k">def</span><span class="w"> </span><span class="nf">normalize_mt5_exception</span><span class="p">(</span><span class="n">exc</span><span class="p">:</span> <span class="ne">BaseException</span><span class="p">)</span> <span class="o">-></span> <span class="n">Mt5CliError</span><span class="p">:</span>
|
||||
<a id="__codelineno-0-56" name="__codelineno-0-56"></a><span class="w"> </span><span class="sd">"""Map pdmt5/MT5 exceptions to stable mt5cli exception types.</span>
|
||||
<a id="__codelineno-0-57" name="__codelineno-0-57"></a>
|
||||
<a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="sd"> Args:</span>
|
||||
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> exc: Original exception from MT5 or pdmt5.</span>
|
||||
<a id="__codelineno-0-60" name="__codelineno-0-60"></a>
|
||||
<a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="sd"> Returns:</span>
|
||||
<a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="sd"> ``Mt5ConnectionError`` for runtime failures, or the original exception</span>
|
||||
<a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="sd"> when it is not recognized.</span>
|
||||
<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="sd"> """</span>
|
||||
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">Mt5RuntimeError</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="k">return</span> <span class="n">Mt5ConnectionError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
|
||||
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exc</span><span class="p">,</span> <span class="n">Mt5CliError</span><span class="p">):</span>
|
||||
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="k">return</span> <span class="n">exc</span>
|
||||
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="k">return</span> <span class="n">Mt5CliError</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
@@ -205,8 +205,8 @@ The intended dependency direction is:</p>
|
||||
from <code>pdmt5</code> when needed. mt5cli does not serve as a pass-through compatibility
|
||||
namespace for pdmt5. mt5cli's trading helpers type their client parameter against
|
||||
an internal protocol backed by <code>pdmt5.Mt5DataClient</code>; <code>Mt5TradingClient</code> is no
|
||||
longer required. <code>Mt5TradingError</code> is conditionally imported where still present
|
||||
in pdmt5, but mt5cli raises <code>Mt5OperationError</code> for all trading-related failures.</p>
|
||||
longer required. <code>pdmt5.Mt5TradingError</code> was removed upstream in pdmt5 1.0.4;
|
||||
mt5cli raises <code>Mt5OperationError</code> for all trading-related failures.</p>
|
||||
<p>Note: the former <code>mt5cli</code> re-export <code>TICK_FLAG_MAP</code> corresponds to <code>COPY_TICKS_MAP</code>
|
||||
in pdmt5 — the name changed, it was not simply moved.</p>
|
||||
<p>Downstream packages should import from the package root (<code>from mt5cli import
|
||||
|
||||
+1911
-1910
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user