dceoy
3100 lines
244 KiB
HTML
3100 lines
244 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" data-bs-theme="light">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<meta name="author" content="dceoy">
|
|
<link rel="canonical" href="https://github.com/dceoy/mt5cli/api/cli/">
|
|
<link rel="shortcut icon" href="../../img/favicon.ico">
|
|
<title>CLI - mt5cli API Documentation</title>
|
|
<link href="../../css/bootstrap.min.css" rel="stylesheet">
|
|
<link href="../../css/fontawesome.min.css" rel="stylesheet">
|
|
<link href="../../css/brands.min.css" rel="stylesheet">
|
|
<link href="../../css/solid.min.css" rel="stylesheet">
|
|
<link href="../../css/v4-font-face.min.css" rel="stylesheet">
|
|
<link href="../../css/base.css" rel="stylesheet">
|
|
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
|
|
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
|
|
<link href="../../assets/_mkdocstrings.css" rel="stylesheet">
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
|
<script>hljs.highlightAll();</script>
|
|
</head>
|
|
|
|
<body>
|
|
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
|
|
<div class="container">
|
|
<a class="navbar-brand" href="../..">mt5cli API Documentation</a>
|
|
<!-- Expander button -->
|
|
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
|
|
<!-- Expanded navigation -->
|
|
<div id="navbar-collapse" class="navbar-collapse collapse">
|
|
<!-- Main navigation -->
|
|
<ul class="nav navbar-nav">
|
|
<li class="nav-item">
|
|
<a href="../.." class="nav-link">Home</a>
|
|
</li>
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">API Reference</a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li>
|
|
<a href="../" class="dropdown-item">Overview</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="./" class="dropdown-item active" aria-current="page">CLI</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<ul class="nav navbar-nav ms-md-auto">
|
|
<li class="nav-item">
|
|
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
|
|
<i class="fa fa-search"></i> Search
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a rel="prev" href="../" class="nav-link">
|
|
<i class="fa fa-arrow-left"></i> Previous
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a rel="next" class="nav-link disabled">
|
|
Next <i class="fa fa-arrow-right"></i>
|
|
</a>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a href="https://github.com/dceoy/mt5cli/edit/master/docs/api/cli.md" class="nav-link">Edit on dceoy/mt5cli
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
|
|
<span class="fa fa-angle-down"></span>
|
|
</button>
|
|
</div>
|
|
|
|
|
|
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
|
|
<ul class="nav flex-column">
|
|
|
|
<li class="nav-item" data-bs-level="1"><a href="#cli-module" class="nav-link">CLI Module</a>
|
|
<ul class="nav flex-column">
|
|
<li class="nav-item" data-bs-level="2"><a href="#mt5cli.cli" class="nav-link">cli</a>
|
|
<ul class="nav flex-column">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div></div>
|
|
<div class="col-md-9" role="main">
|
|
|
|
<h1 id="cli-module">CLI Module<a class="headerlink" href="#cli-module" title="Permanent link">¶</a></h1>
|
|
|
|
|
|
<div class="doc doc-object doc-module">
|
|
|
|
|
|
|
|
<h2 id="mt5cli.cli" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-module-name">mt5cli.cli</span>
|
|
|
|
|
|
<a href="#mt5cli.cli" class="headerlink" title="Permanent link">¶</a></h2>
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Command-line interface for MetaTrader 5 data export.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.DATETIME_TYPE" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">DATETIME_TYPE</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.DATETIME_TYPE" 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="n">DATETIME_TYPE</span> <span class="o">=</span> <span class="n"><span title="mt5cli.cli._DateTimeType">_DateTimeType</span></span><span class="p">()</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.REQUEST_TYPE" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">REQUEST_TYPE</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.REQUEST_TYPE" 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="n">REQUEST_TYPE</span> <span class="o">=</span> <span class="n"><span title="mt5cli.cli._RequestType">_RequestType</span></span><span class="p">()</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.TICK_FLAGS_TYPE" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TICK_FLAGS_TYPE</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.TICK_FLAGS_TYPE" 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="n">TICK_FLAGS_TYPE</span> <span class="o">=</span> <span class="n"><span title="mt5cli.cli._TickFlagsType">_TickFlagsType</span></span><span class="p">()</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.TICK_FLAG_MAP" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TICK_FLAG_MAP</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.TICK_FLAG_MAP" 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="n">TICK_FLAG_MAP</span><span class="p">:</span> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="int">int</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="s2">"ALL"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="s2">"INFO"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="s2">"TRADE"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="p">}</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.TIMEFRAME_MAP" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TIMEFRAME_MAP</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.TIMEFRAME_MAP" 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="n">TIMEFRAME_MAP</span><span class="p">:</span> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="int">int</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="s2">"M1"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="s2">"M2"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="s2">"M3"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="s2">"M4"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="s2">"M5"</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="s2">"M6"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="s2">"M10"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="s2">"M12"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="s2">"M15"</span><span class="p">:</span> <span class="mi">15</span><span class="p">,</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="s2">"M20"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="s2">"M30"</span><span class="p">:</span> <span class="mi">30</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="s2">"H1"</span><span class="p">:</span> <span class="mi">16385</span><span class="p">,</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="s2">"H2"</span><span class="p">:</span> <span class="mi">16386</span><span class="p">,</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="s2">"H3"</span><span class="p">:</span> <span class="mi">16387</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="s2">"H4"</span><span class="p">:</span> <span class="mi">16388</span><span class="p">,</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="s2">"H6"</span><span class="p">:</span> <span class="mi">16390</span><span class="p">,</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="s2">"H8"</span><span class="p">:</span> <span class="mi">16392</span><span class="p">,</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="s2">"H12"</span><span class="p">:</span> <span class="mi">16396</span><span class="p">,</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="s2">"D1"</span><span class="p">:</span> <span class="mi">16408</span><span class="p">,</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="s2">"W1"</span><span class="p">:</span> <span class="mi">32769</span><span class="p">,</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="s2">"MN1"</span><span class="p">:</span> <span class="mi">49153</span><span class="p">,</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="p">}</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.TIMEFRAME_TYPE" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">TIMEFRAME_TYPE</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.TIMEFRAME_TYPE" 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="n">TIMEFRAME_TYPE</span> <span class="o">=</span> <span class="n"><span title="mt5cli.cli._TimeframeType">_TimeframeType</span></span><span class="p">()</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.app" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">app</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.app" 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="n">app</span> <span class="o">=</span> <span class="n"><span title="typer.Typer">Typer</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n"><span title="typer.Typer(name)">name</span></span><span class="o">=</span><span class="s2">"mt5cli"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n"><span title="typer.Typer(help)">help</span></span><span class="o">=</span><span class="s2">"Export MetaTrader5 data to CSV, JSON, Parquet, or SQLite3."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.logger" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">logger</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-module-attribute"><code>module-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.logger" 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="n">logger</span> <span class="o">=</span> <span class="n"><span title="logging.getLogger">getLogger</span></span><span class="p">(</span><span class="n"><span title="__name__">__name__</span></span><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.LogLevel" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">LogLevel</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.LogLevel" class="headerlink" title="Permanent link">¶</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="enum.StrEnum">StrEnum</span></code></p>
|
|
|
|
|
|
|
|
<p>Logging verbosity levels.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.LogLevel.DEBUG" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">DEBUG</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.LogLevel.DEBUG" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">DEBUG</span> <span class="o">=</span> <span class="s1">'DEBUG'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.LogLevel.ERROR" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">ERROR</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.LogLevel.ERROR" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">ERROR</span> <span class="o">=</span> <span class="s1">'ERROR'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.LogLevel.INFO" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">INFO</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.LogLevel.INFO" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">INFO</span> <span class="o">=</span> <span class="s1">'INFO'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.LogLevel.WARNING" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">WARNING</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.LogLevel.WARNING" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">WARNING</span> <span class="o">=</span> <span class="s1">'WARNING'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="mt5cli.cli.OutputFormat" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-class-name">OutputFormat</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.OutputFormat" class="headerlink" title="Permanent link">¶</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="enum.StrEnum">StrEnum</span></code></p>
|
|
|
|
|
|
|
|
<p>Supported output file formats.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.OutputFormat.csv" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">csv</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.OutputFormat.csv" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">csv</span> <span class="o">=</span> <span class="s1">'csv'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.OutputFormat.json" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">json</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.OutputFormat.json" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">json</span> <span class="o">=</span> <span class="s1">'json'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.OutputFormat.parquet" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">parquet</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.OutputFormat.parquet" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">parquet</span> <span class="o">=</span> <span class="s1">'parquet'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-attribute">
|
|
|
|
|
|
|
|
<h4 id="mt5cli.cli.OutputFormat.sqlite3" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-attribute-name">sqlite3</span>
|
|
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
|
</span>
|
|
|
|
<a href="#mt5cli.cli.OutputFormat.sqlite3" class="headerlink" title="Permanent link">¶</a></h4>
|
|
<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="n">sqlite3</span> <span class="o">=</span> <span class="s1">'sqlite3'</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.account_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">account_info</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.account_info" 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">account_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export account information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-685">685</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-686">686</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-687">687</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-688">688</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-685" name="__codelineno-0-685"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-686" name="__codelineno-0-686"></a><span class="k">def</span><span class="w"> </span><span class="nf">account_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-687" name="__codelineno-0-687"></a><span class="w"> </span><span class="sd">"""Export account information."""</span>
|
|
<a id="__codelineno-0-688" name="__codelineno-0-688"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">account_info_as_df</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.cli.detect_format" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">detect_format</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.detect_format" 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">detect_format</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n"><span title="pathlib.Path">Path</span></span><span class="p">,</span> <span class="n">explicit_format</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="str">str</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Detect the output format from a file extension or explicit format string.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>output_path</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pathlib.Path">Path</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Path to the output file.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>explicit_format</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span> | None</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Explicitly specified format, if any.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<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="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>The detected format string.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="ValueError">ValueError</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If the format cannot be determined.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-236">236</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-237">237</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-238">238</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-239">239</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-240">240</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-241">241</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-242">242</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-243">243</a></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>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-236" name="__codelineno-0-236"></a><span class="k">def</span><span class="w"> </span><span class="nf">detect_format</span><span class="p">(</span>
|
|
<a id="__codelineno-0-237" name="__codelineno-0-237"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-238" name="__codelineno-0-238"></a> <span class="n">explicit_format</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-239" name="__codelineno-0-239"></a><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<a id="__codelineno-0-240" name="__codelineno-0-240"></a><span class="w"> </span><span class="sd">"""Detect the output format from a file extension or explicit format string.</span>
|
|
<a id="__codelineno-0-241" name="__codelineno-0-241"></a>
|
|
<a id="__codelineno-0-242" name="__codelineno-0-242"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-243" name="__codelineno-0-243"></a><span class="sd"> output_path: Path to the output file.</span>
|
|
<a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="sd"> explicit_format: Explicitly specified format, if any.</span>
|
|
<a id="__codelineno-0-245" name="__codelineno-0-245"></a>
|
|
<a id="__codelineno-0-246" name="__codelineno-0-246"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-247" name="__codelineno-0-247"></a><span class="sd"> The detected format string.</span>
|
|
<a id="__codelineno-0-248" name="__codelineno-0-248"></a>
|
|
<a id="__codelineno-0-249" name="__codelineno-0-249"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-250" name="__codelineno-0-250"></a><span class="sd"> ValueError: If the format cannot be determined.</span>
|
|
<a id="__codelineno-0-251" name="__codelineno-0-251"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-252" name="__codelineno-0-252"></a> <span class="k">if</span> <span class="n">explicit_format</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-253" name="__codelineno-0-253"></a> <span class="k">return</span> <span class="n">explicit_format</span>
|
|
<a id="__codelineno-0-254" name="__codelineno-0-254"></a> <span class="n">suffix</span> <span class="o">=</span> <span class="n">output_path</span><span class="o">.</span><span class="n">suffix</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
|
<a id="__codelineno-0-255" name="__codelineno-0-255"></a> <span class="k">if</span> <span class="n">suffix</span> <span class="ow">in</span> <span class="n">_FORMAT_EXTENSIONS</span><span class="p">:</span>
|
|
<a id="__codelineno-0-256" name="__codelineno-0-256"></a> <span class="k">return</span> <span class="n">_FORMAT_EXTENSIONS</span><span class="p">[</span><span class="n">suffix</span><span class="p">]</span>
|
|
<a id="__codelineno-0-257" name="__codelineno-0-257"></a> <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-258" name="__codelineno-0-258"></a> <span class="sa">f</span><span class="s2">"Cannot detect format from extension '</span><span class="si">{</span><span class="n">suffix</span><span class="si">}</span><span class="s2">'."</span>
|
|
<a id="__codelineno-0-259" name="__codelineno-0-259"></a> <span class="s2">" Use --format to specify the output format."</span>
|
|
<a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-261" name="__codelineno-0-261"></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>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.export_dataframe" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">export_dataframe</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.export_dataframe" 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">export_dataframe</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">df</span><span class="p">:</span> <span class="n"><span title="pandas.DataFrame">DataFrame</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n"><span title="pathlib.Path">Path</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">output_format</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">table_name</span><span class="p">:</span> <span class="n"><span title="str">str</span></span> <span class="o">=</span> <span class="s2">"data"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export a pandas DataFrame to the specified file format.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>df</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pandas.DataFrame">DataFrame</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>DataFrame to export.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>output_path</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="pathlib.Path">Path</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Path to the output file.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>output_format</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Output format (csv, json, parquet, or sqlite3).</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>table_name</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Table name for SQLite3 output.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<code>'data'</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="ValueError">ValueError</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If the output format is not supported.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-264">264</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-265">265</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-266">266</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-267">267</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-268">268</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-269">269</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-270">270</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-271">271</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-272">272</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-273">273</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-274">274</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-275">275</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-276">276</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-277">277</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-278">278</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-279">279</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-280">280</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-281">281</a></span>
|
|
<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>
|
|
<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>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-264" name="__codelineno-0-264"></a><span class="k">def</span><span class="w"> </span><span class="nf">export_dataframe</span><span class="p">(</span>
|
|
<a id="__codelineno-0-265" name="__codelineno-0-265"></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-266" name="__codelineno-0-266"></a> <span class="n">output_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-267" name="__codelineno-0-267"></a> <span class="n">output_format</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-268" name="__codelineno-0-268"></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-269" name="__codelineno-0-269"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="w"> </span><span class="sd">"""Export a pandas DataFrame to the specified file format.</span>
|
|
<a id="__codelineno-0-271" name="__codelineno-0-271"></a>
|
|
<a id="__codelineno-0-272" name="__codelineno-0-272"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-273" name="__codelineno-0-273"></a><span class="sd"> df: DataFrame to export.</span>
|
|
<a id="__codelineno-0-274" name="__codelineno-0-274"></a><span class="sd"> output_path: Path to the output file.</span>
|
|
<a id="__codelineno-0-275" name="__codelineno-0-275"></a><span class="sd"> output_format: Output format (csv, json, parquet, or sqlite3).</span>
|
|
<a id="__codelineno-0-276" name="__codelineno-0-276"></a><span class="sd"> table_name: Table name for SQLite3 output.</span>
|
|
<a id="__codelineno-0-277" name="__codelineno-0-277"></a>
|
|
<a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-279" name="__codelineno-0-279"></a><span class="sd"> ValueError: If the output format is not supported.</span>
|
|
<a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-281" name="__codelineno-0-281"></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-282" name="__codelineno-0-282"></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-283" name="__codelineno-0-283"></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-284" name="__codelineno-0-284"></a> <span class="n">df</span><span class="o">.</span><span class="n">to_json</span><span class="p">(</span>
|
|
<a id="__codelineno-0-285" name="__codelineno-0-285"></a> <span class="n">output_path</span><span class="p">,</span>
|
|
<a id="__codelineno-0-286" name="__codelineno-0-286"></a> <span class="n">orient</span><span class="o">=</span><span class="s2">"records"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-287" name="__codelineno-0-287"></a> <span class="n">date_format</span><span class="o">=</span><span class="s2">"iso"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-288" name="__codelineno-0-288"></a> <span class="n">indent</span><span class="o">=</span><span class="mi">2</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">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-291" name="__codelineno-0-291"></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-292" name="__codelineno-0-292"></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-293" name="__codelineno-0-293"></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-294" name="__codelineno-0-294"></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-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="n">conn</span><span class="p">,</span>
|
|
<a id="__codelineno-0-297" name="__codelineno-0-297"></a> <span class="n">if_exists</span><span class="o">=</span><span class="s2">"replace"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-298" name="__codelineno-0-298"></a> <span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-299" name="__codelineno-0-299"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-300" name="__codelineno-0-300"></a> <span class="k">else</span><span class="p">:</span>
|
|
<a id="__codelineno-0-301" name="__codelineno-0-301"></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-302" name="__codelineno-0-302"></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>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.history_deals" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_deals</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.history_deals" 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">history_deals</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start date."</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Order ticket."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n">position</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Position ticket."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export historical deals.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-790">790</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-791">791</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-792">792</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-793">793</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-794">794</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-795">795</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-796">796</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-797">797</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-798">798</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-799">799</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-800">800</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-801">801</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-802">802</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-803">803</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-804">804</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-805">805</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-806">806</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-807">807</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-808">808</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-809">809</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-810">810</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-811">811</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-812">812</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-813">813</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-814">814</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-815">815</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-816">816</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-817">817</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-790" name="__codelineno-0-790"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-791" name="__codelineno-0-791"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_deals</span><span class="p">(</span>
|
|
<a id="__codelineno-0-792" name="__codelineno-0-792"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-793" name="__codelineno-0-793"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-794" name="__codelineno-0-794"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-795" name="__codelineno-0-795"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-796" name="__codelineno-0-796"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-797" name="__codelineno-0-797"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-798" name="__codelineno-0-798"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-799" name="__codelineno-0-799"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-800" name="__codelineno-0-800"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-801" name="__codelineno-0-801"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-802" name="__codelineno-0-802"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-803" name="__codelineno-0-803"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Order ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-804" name="__codelineno-0-804"></a> <span class="n">position</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Position ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-805" name="__codelineno-0-805"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-806" name="__codelineno-0-806"></a><span class="w"> </span><span class="sd">"""Export historical deals."""</span>
|
|
<a id="__codelineno-0-807" name="__codelineno-0-807"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-808" name="__codelineno-0-808"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-809" name="__codelineno-0-809"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">history_deals_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-810" name="__codelineno-0-810"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-811" name="__codelineno-0-811"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
|
|
<a id="__codelineno-0-812" name="__codelineno-0-812"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-813" name="__codelineno-0-813"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-814" name="__codelineno-0-814"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-815" name="__codelineno-0-815"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-816" name="__codelineno-0-816"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-817" name="__codelineno-0-817"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.history_orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">history_orders</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.history_orders" 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">history_orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start date."</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="datetime.datetime">datetime</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Order ticket."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a> <span class="n">position</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Position ticket."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export historical orders.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-760">760</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-761">761</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-762">762</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-763">763</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-764">764</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-765">765</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-766">766</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-767">767</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-768">768</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-769">769</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-770">770</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-771">771</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-772">772</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-773">773</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-774">774</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-775">775</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-776">776</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-777">777</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-778">778</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-779">779</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-780">780</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-781">781</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-782">782</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-783">783</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-784">784</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-785">785</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-786">786</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-787">787</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-760" name="__codelineno-0-760"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-761" name="__codelineno-0-761"></a><span class="k">def</span><span class="w"> </span><span class="nf">history_orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-762" name="__codelineno-0-762"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-763" name="__codelineno-0-763"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-764" name="__codelineno-0-764"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-765" name="__codelineno-0-765"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-766" name="__codelineno-0-766"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-767" name="__codelineno-0-767"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-768" name="__codelineno-0-768"></a> <span class="n">datetime</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-769" name="__codelineno-0-769"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-770" name="__codelineno-0-770"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-771" name="__codelineno-0-771"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-772" name="__codelineno-0-772"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-773" name="__codelineno-0-773"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Order ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-774" name="__codelineno-0-774"></a> <span class="n">position</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Position ticket."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-775" name="__codelineno-0-775"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-776" name="__codelineno-0-776"></a><span class="w"> </span><span class="sd">"""Export historical orders."""</span>
|
|
<a id="__codelineno-0-777" name="__codelineno-0-777"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-778" name="__codelineno-0-778"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-779" name="__codelineno-0-779"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">history_orders_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-780" name="__codelineno-0-780"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-781" name="__codelineno-0-781"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
|
|
<a id="__codelineno-0-782" name="__codelineno-0-782"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-783" name="__codelineno-0-783"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-784" name="__codelineno-0-784"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-785" name="__codelineno-0-785"></a> <span class="n">position</span><span class="o">=</span><span class="n">position</span><span class="p">,</span>
|
|
<a id="__codelineno-0-786" name="__codelineno-0-786"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-787" name="__codelineno-0-787"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.last_error" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">last_error</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.last_error" 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">last_error</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export the last error information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-826">826</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-827">827</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-828">828</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-829">829</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-826" name="__codelineno-0-826"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-827" name="__codelineno-0-827"></a><span class="k">def</span><span class="w"> </span><span class="nf">last_error</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-828" name="__codelineno-0-828"></a><span class="w"> </span><span class="sd">"""Export the last error information."""</span>
|
|
<a id="__codelineno-0-829" name="__codelineno-0-829"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">last_error_as_df</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.cli.main" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">main</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.main" 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">main</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Run the mt5cli CLI.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-897">897</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-898">898</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-899">899</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-897" name="__codelineno-0-897"></a><span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-898" name="__codelineno-0-898"></a><span class="w"> </span><span class="sd">"""Run the mt5cli CLI."""</span>
|
|
<a id="__codelineno-0-899" name="__codelineno-0-899"></a> <span class="n">app</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.cli.market_book" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">market_book</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.market_book" 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">market_book</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export market depth (order book) for a symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-844">844</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-845">845</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-846">846</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-847">847</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-848">848</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-849">849</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-850">850</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-851">851</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-852">852</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-853">853</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-844" name="__codelineno-0-844"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-845" name="__codelineno-0-845"></a><span class="k">def</span><span class="w"> </span><span class="nf">market_book</span><span class="p">(</span>
|
|
<a id="__codelineno-0-846" name="__codelineno-0-846"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-847" name="__codelineno-0-847"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-848" name="__codelineno-0-848"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-849" name="__codelineno-0-849"></a><span class="w"> </span><span class="sd">"""Export market depth (order book) for a symbol."""</span>
|
|
<a id="__codelineno-0-850" name="__codelineno-0-850"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-851" name="__codelineno-0-851"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-852" name="__codelineno-0-852"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">market_book_get_as_df</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">),</span>
|
|
<a id="__codelineno-0-853" name="__codelineno-0-853"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.order_check" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">order_check</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.order_check" 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">order_check</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">request</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typing.Any">Any</span></span><span class="p">],</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="REQUEST_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.REQUEST_TYPE)" href="#mt5cli.cli.REQUEST_TYPE">REQUEST_TYPE</a></span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="n"><span title="mt5cli.cli._REQUEST_OPTION_HELP">_REQUEST_OPTION_HELP</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Check funds sufficiency for a trading operation.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-856">856</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-857">857</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-858">858</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-859">859</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-860">860</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-861">861</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-862">862</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-863">863</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-864">864</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-865">865</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-866">866</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-867">867</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-868">868</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-856" name="__codelineno-0-856"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-857" name="__codelineno-0-857"></a><span class="k">def</span><span class="w"> </span><span class="nf">order_check</span><span class="p">(</span>
|
|
<a id="__codelineno-0-858" name="__codelineno-0-858"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-859" name="__codelineno-0-859"></a> <span class="n">request</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-860" name="__codelineno-0-860"></a> <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-861" name="__codelineno-0-861"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">REQUEST_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="n">_REQUEST_OPTION_HELP</span><span class="p">),</span>
|
|
<a id="__codelineno-0-862" name="__codelineno-0-862"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-863" name="__codelineno-0-863"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-864" name="__codelineno-0-864"></a><span class="w"> </span><span class="sd">"""Check funds sufficiency for a trading operation."""</span>
|
|
<a id="__codelineno-0-865" name="__codelineno-0-865"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-866" name="__codelineno-0-866"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-867" name="__codelineno-0-867"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">order_check_as_df</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">),</span>
|
|
<a id="__codelineno-0-868" name="__codelineno-0-868"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.order_send" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">order_send</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.order_send" 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">order_send</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">request</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typing.Any">Any</span></span><span class="p">],</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="REQUEST_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.REQUEST_TYPE)" href="#mt5cli.cli.REQUEST_TYPE">REQUEST_TYPE</a></span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="n"><span title="mt5cli.cli._REQUEST_OPTION_HELP">_REQUEST_OPTION_HELP</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">yes</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="bool">bool</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="s2">"--yes"</span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Confirm the live trade request."</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Send a trading operation request to the trade server.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="typer.BadParameter">BadParameter</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If --yes is not provided.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-871">871</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-872">872</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-873">873</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-874">874</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-875">875</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-876">876</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-877">877</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-878">878</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-879">879</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-880">880</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-881">881</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-882">882</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-883">883</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-884">884</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-885">885</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-886">886</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-887">887</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-888">888</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-889">889</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-890">890</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-891">891</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-892">892</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-893">893</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-894">894</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-871" name="__codelineno-0-871"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-872" name="__codelineno-0-872"></a><span class="k">def</span><span class="w"> </span><span class="nf">order_send</span><span class="p">(</span>
|
|
<a id="__codelineno-0-873" name="__codelineno-0-873"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-874" name="__codelineno-0-874"></a> <span class="n">request</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-875" name="__codelineno-0-875"></a> <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-876" name="__codelineno-0-876"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">REQUEST_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="n">_REQUEST_OPTION_HELP</span><span class="p">),</span>
|
|
<a id="__codelineno-0-877" name="__codelineno-0-877"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-878" name="__codelineno-0-878"></a> <span class="n">yes</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-879" name="__codelineno-0-879"></a> <span class="nb">bool</span><span class="p">,</span>
|
|
<a id="__codelineno-0-880" name="__codelineno-0-880"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="s2">"--yes"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Confirm the live trade request."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-881" name="__codelineno-0-881"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-882" name="__codelineno-0-882"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-883" name="__codelineno-0-883"></a><span class="w"> </span><span class="sd">"""Send a trading operation request to the trade server.</span>
|
|
<a id="__codelineno-0-884" name="__codelineno-0-884"></a>
|
|
<a id="__codelineno-0-885" name="__codelineno-0-885"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-886" name="__codelineno-0-886"></a><span class="sd"> typer.BadParameter: If --yes is not provided.</span>
|
|
<a id="__codelineno-0-887" name="__codelineno-0-887"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-888" name="__codelineno-0-888"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">yes</span><span class="p">:</span>
|
|
<a id="__codelineno-0-889" name="__codelineno-0-889"></a> <span class="n">msg</span> <span class="o">=</span> <span class="s2">"Pass --yes to send a live trade request."</span>
|
|
<a id="__codelineno-0-890" name="__codelineno-0-890"></a> <span class="k">raise</span> <span class="n">typer</span><span class="o">.</span><span class="n">BadParameter</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">param_hint</span><span class="o">=</span><span class="s2">"--yes"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-891" name="__codelineno-0-891"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-892" name="__codelineno-0-892"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-893" name="__codelineno-0-893"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">order_send_as_df</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">),</span>
|
|
<a id="__codelineno-0-894" name="__codelineno-0-894"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.orders" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">orders</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.orders" 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">orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Ticket filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export active orders.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-724">724</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-725">725</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-726">726</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-727">727</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-728">728</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-729">729</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-730">730</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-731">731</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-732">732</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-733">733</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-734">734</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-735">735</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-736">736</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-737">737</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-738">738</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-739">739</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-724" name="__codelineno-0-724"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-725" name="__codelineno-0-725"></a><span class="k">def</span><span class="w"> </span><span class="nf">orders</span><span class="p">(</span>
|
|
<a id="__codelineno-0-726" name="__codelineno-0-726"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-727" name="__codelineno-0-727"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-728" name="__codelineno-0-728"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-729" name="__codelineno-0-729"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Ticket filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-730" name="__codelineno-0-730"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-731" name="__codelineno-0-731"></a><span class="w"> </span><span class="sd">"""Export active orders."""</span>
|
|
<a id="__codelineno-0-732" name="__codelineno-0-732"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-733" name="__codelineno-0-733"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-734" name="__codelineno-0-734"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">orders_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-735" name="__codelineno-0-735"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-736" name="__codelineno-0-736"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-737" name="__codelineno-0-737"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-738" name="__codelineno-0-738"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-739" name="__codelineno-0-739"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.parse_datetime" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">parse_datetime</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.parse_datetime" 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">parse_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="datetime.datetime">datetime</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Parse an ISO 8601 datetime string to a timezone-aware datetime.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>value</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>ISO 8601 datetime string (e.g., '2024-01-01' or
|
|
'2024-01-01T12:00:00+00:00').</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<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="datetime.datetime">datetime</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Parsed datetime with UTC timezone if no timezone is specified.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="ValueError">ValueError</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If the string cannot be parsed.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-305">305</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-306">306</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-307">307</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-308">308</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-309">309</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-310">310</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-311">311</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-312">312</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-313">313</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-314">314</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-315">315</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-316">316</a></span>
|
|
<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>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-305" name="__codelineno-0-305"></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-306" name="__codelineno-0-306"></a><span class="w"> </span><span class="sd">"""Parse an ISO 8601 datetime string to a timezone-aware datetime.</span>
|
|
<a id="__codelineno-0-307" name="__codelineno-0-307"></a>
|
|
<a id="__codelineno-0-308" name="__codelineno-0-308"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-309" name="__codelineno-0-309"></a><span class="sd"> value: ISO 8601 datetime string (e.g., '2024-01-01' or</span>
|
|
<a id="__codelineno-0-310" name="__codelineno-0-310"></a><span class="sd"> '2024-01-01T12:00:00+00:00').</span>
|
|
<a id="__codelineno-0-311" name="__codelineno-0-311"></a>
|
|
<a id="__codelineno-0-312" name="__codelineno-0-312"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-313" name="__codelineno-0-313"></a><span class="sd"> Parsed datetime with UTC timezone if no timezone is specified.</span>
|
|
<a id="__codelineno-0-314" name="__codelineno-0-314"></a>
|
|
<a id="__codelineno-0-315" name="__codelineno-0-315"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-316" name="__codelineno-0-316"></a><span class="sd"> ValueError: If the string cannot be parsed.</span>
|
|
<a id="__codelineno-0-317" name="__codelineno-0-317"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-319" name="__codelineno-0-319"></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-320" name="__codelineno-0-320"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
|
<a id="__codelineno-0-321" name="__codelineno-0-321"></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-322" name="__codelineno-0-322"></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-323" name="__codelineno-0-323"></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-324" name="__codelineno-0-324"></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-325" name="__codelineno-0-325"></a> <span class="k">return</span> <span class="n">dt</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.parse_request" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">parse_request</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.parse_request" 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">parse_request</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="dict">dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typing.Any">Any</span></span><span class="p">]</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Parse a JSON-formatted order request string or file reference.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>value</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>JSON object string, or '@path' to read JSON from a file.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<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="dict">dict</span>[<span title="str">str</span>, <span title="typing.Any">Any</span>]</code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Parsed request dictionary.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="ValueError">ValueError</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If the request file cannot be read or the value is not a
|
|
JSON object.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-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>
|
|
<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>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-378" name="__codelineno-0-378"></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-379" name="__codelineno-0-379"></a><span class="w"> </span><span class="sd">"""Parse a JSON-formatted order request string or file reference.</span>
|
|
<a id="__codelineno-0-380" name="__codelineno-0-380"></a>
|
|
<a id="__codelineno-0-381" name="__codelineno-0-381"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-382" name="__codelineno-0-382"></a><span class="sd"> value: JSON object string, or '@path' to read JSON from a file.</span>
|
|
<a id="__codelineno-0-383" name="__codelineno-0-383"></a>
|
|
<a id="__codelineno-0-384" name="__codelineno-0-384"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-385" name="__codelineno-0-385"></a><span class="sd"> Parsed request dictionary.</span>
|
|
<a id="__codelineno-0-386" name="__codelineno-0-386"></a>
|
|
<a id="__codelineno-0-387" name="__codelineno-0-387"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-388" name="__codelineno-0-388"></a><span class="sd"> ValueError: If the request file cannot be read or the value is not a</span>
|
|
<a id="__codelineno-0-389" name="__codelineno-0-389"></a><span class="sd"> JSON object.</span>
|
|
<a id="__codelineno-0-390" name="__codelineno-0-390"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-391" name="__codelineno-0-391"></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-392" name="__codelineno-0-392"></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-393" name="__codelineno-0-393"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-394" name="__codelineno-0-394"></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-395" name="__codelineno-0-395"></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-396" name="__codelineno-0-396"></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-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="nn">exc</span>
|
|
<a id="__codelineno-0-398" name="__codelineno-0-398"></a> <span class="k">else</span><span class="p">:</span>
|
|
<a id="__codelineno-0-399" name="__codelineno-0-399"></a> <span class="n">text</span> <span class="o">=</span> <span class="n">value</span>
|
|
<a id="__codelineno-0-400" name="__codelineno-0-400"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-401" name="__codelineno-0-401"></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-402" name="__codelineno-0-402"></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-403" name="__codelineno-0-403"></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-404" name="__codelineno-0-404"></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-405" name="__codelineno-0-405"></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-406" name="__codelineno-0-406"></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-407" name="__codelineno-0-407"></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-408" name="__codelineno-0-408"></a> <span class="k">return</span> <span class="n">parsed</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.parse_tick_flags" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">parse_tick_flags</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.parse_tick_flags" 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">parse_tick_flags</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="int">int</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Parse tick flags string or integer value.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>value</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Tick flag name (ALL, INFO, TRADE) or integer value.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<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></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Integer tick flag value.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="ValueError">ValueError</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If the flag is invalid.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-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>
|
|
<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-351" name="__codelineno-0-351"></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">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
|
<a id="__codelineno-0-352" name="__codelineno-0-352"></a><span class="w"> </span><span class="sd">"""Parse tick flags string or integer value.</span>
|
|
<a id="__codelineno-0-353" name="__codelineno-0-353"></a>
|
|
<a id="__codelineno-0-354" name="__codelineno-0-354"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-355" name="__codelineno-0-355"></a><span class="sd"> value: Tick flag name (ALL, INFO, TRADE) or integer value.</span>
|
|
<a id="__codelineno-0-356" name="__codelineno-0-356"></a>
|
|
<a id="__codelineno-0-357" name="__codelineno-0-357"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-358" name="__codelineno-0-358"></a><span class="sd"> Integer tick flag value.</span>
|
|
<a id="__codelineno-0-359" name="__codelineno-0-359"></a>
|
|
<a id="__codelineno-0-360" name="__codelineno-0-360"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-361" name="__codelineno-0-361"></a><span class="sd"> ValueError: If the flag is invalid.</span>
|
|
<a id="__codelineno-0-362" name="__codelineno-0-362"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="n">upper</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
|
|
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="k">if</span> <span class="n">upper</span> <span class="ow">in</span> <span class="n">TICK_FLAG_MAP</span><span class="p">:</span>
|
|
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="k">return</span> <span class="n">TICK_FLAG_MAP</span><span class="p">[</span><span class="n">upper</span><span class="p">]</span>
|
|
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="k">return</span> <span class="nb">int</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="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
|
<a id="__codelineno-0-369" name="__codelineno-0-369"></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_MAP</span><span class="p">)</span>
|
|
<a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid tick flags: '</span><span class="si">{</span><span class="n">value</span><span class="si">}</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 an integer."</span>
|
|
<a id="__codelineno-0-371" name="__codelineno-0-371"></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>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.parse_timeframe" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">parse_timeframe</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.parse_timeframe" 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">parse_timeframe</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n"><span title="str">str</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="int">int</span></span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Parse a timeframe string or integer value.</p>
|
|
|
|
|
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code>value</code>
|
|
</td>
|
|
<td>
|
|
<code><span title="str">str</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</p>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<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></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>Integer timeframe value.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<p><span class="doc-section-title">Raises:</span></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="doc-section-item">
|
|
<td>
|
|
<code><span title="ValueError">ValueError</span></code>
|
|
</td>
|
|
<td>
|
|
<div class="doc-md-description">
|
|
<p>If the timeframe is invalid.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-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>
|
|
<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>
|
|
<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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-328" name="__codelineno-0-328"></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">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
|
<a id="__codelineno-0-329" name="__codelineno-0-329"></a><span class="w"> </span><span class="sd">"""Parse a timeframe string or integer value.</span>
|
|
<a id="__codelineno-0-330" name="__codelineno-0-330"></a>
|
|
<a id="__codelineno-0-331" name="__codelineno-0-331"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-332" name="__codelineno-0-332"></a><span class="sd"> value: Timeframe name (e.g., 'M1', 'H1', 'D1') or integer value.</span>
|
|
<a id="__codelineno-0-333" name="__codelineno-0-333"></a>
|
|
<a id="__codelineno-0-334" name="__codelineno-0-334"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-335" name="__codelineno-0-335"></a><span class="sd"> Integer timeframe value.</span>
|
|
<a id="__codelineno-0-336" name="__codelineno-0-336"></a>
|
|
<a id="__codelineno-0-337" name="__codelineno-0-337"></a><span class="sd"> Raises:</span>
|
|
<a id="__codelineno-0-338" name="__codelineno-0-338"></a><span class="sd"> ValueError: If the timeframe is invalid.</span>
|
|
<a id="__codelineno-0-339" name="__codelineno-0-339"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-340" name="__codelineno-0-340"></a> <span class="n">upper</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
|
|
<a id="__codelineno-0-341" name="__codelineno-0-341"></a> <span class="k">if</span> <span class="n">upper</span> <span class="ow">in</span> <span class="n">TIMEFRAME_MAP</span><span class="p">:</span>
|
|
<a id="__codelineno-0-342" name="__codelineno-0-342"></a> <span class="k">return</span> <span class="n">TIMEFRAME_MAP</span><span class="p">[</span><span class="n">upper</span><span class="p">]</span>
|
|
<a id="__codelineno-0-343" name="__codelineno-0-343"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
|
<a id="__codelineno-0-346" name="__codelineno-0-346"></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_MAP</span><span class="p">)</span>
|
|
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Invalid timeframe: '</span><span class="si">{</span><span class="n">value</span><span class="si">}</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 an integer."</span>
|
|
<a id="__codelineno-0-348" name="__codelineno-0-348"></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>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.positions" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">positions</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.positions" 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">positions</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n"><span title="int">int</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Ticket filter."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export open positions.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-742">742</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-743">743</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-744">744</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-745">745</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-746">746</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-747">747</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-748">748</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-749">749</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-750">750</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-751">751</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-752">752</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-753">753</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-754">754</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-755">755</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-756">756</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-757">757</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-742" name="__codelineno-0-742"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-743" name="__codelineno-0-743"></a><span class="k">def</span><span class="w"> </span><span class="nf">positions</span><span class="p">(</span>
|
|
<a id="__codelineno-0-744" name="__codelineno-0-744"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-745" name="__codelineno-0-745"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-746" name="__codelineno-0-746"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Group filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-747" name="__codelineno-0-747"></a> <span class="n">ticket</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Ticket filter."</span><span class="p">)]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-748" name="__codelineno-0-748"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-749" name="__codelineno-0-749"></a><span class="w"> </span><span class="sd">"""Export open positions."""</span>
|
|
<a id="__codelineno-0-750" name="__codelineno-0-750"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-751" name="__codelineno-0-751"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-752" name="__codelineno-0-752"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">positions_get_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-753" name="__codelineno-0-753"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-754" name="__codelineno-0-754"></a> <span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
|
|
<a id="__codelineno-0-755" name="__codelineno-0-755"></a> <span class="n">ticket</span><span class="o">=</span><span class="n">ticket</span><span class="p">,</span>
|
|
<a id="__codelineno-0-756" name="__codelineno-0-756"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-757" name="__codelineno-0-757"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.rates_from" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">rates_from</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.rates_from" 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">rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.TIMEFRAME_TYPE)" href="#mt5cli.cli.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Timeframe (e.g., M1, H1, D1, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start date in ISO 8601 format."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Number of records."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export rates from a start date.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-537">537</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-538">538</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-539">539</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-540">540</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-541">541</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-542">542</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-543">543</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-544">544</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-545">545</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-546">546</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-547">547</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-548">548</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-549">549</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-550">550</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-551">551</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-552">552</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-553">553</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-554">554</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-555">555</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-556">556</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-557">557</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-558">558</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-559">559</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-560">560</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-561">561</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-562">562</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-563">563</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-564">564</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-565">565</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-566">566</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-537" name="__codelineno-0-537"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-538" name="__codelineno-0-538"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-539" name="__codelineno-0-539"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-540" name="__codelineno-0-540"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-541" name="__codelineno-0-541"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-542" name="__codelineno-0-542"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-543" name="__codelineno-0-543"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-544" name="__codelineno-0-544"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
|
|
<a id="__codelineno-0-545" name="__codelineno-0-545"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Timeframe (e.g., M1, H1, D1, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-546" name="__codelineno-0-546"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-547" name="__codelineno-0-547"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-548" name="__codelineno-0-548"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-549" name="__codelineno-0-549"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-550" name="__codelineno-0-550"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-551" name="__codelineno-0-551"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span>
|
|
<a id="__codelineno-0-552" name="__codelineno-0-552"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date in ISO 8601 format."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-553" name="__codelineno-0-553"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-554" name="__codelineno-0-554"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-555" name="__codelineno-0-555"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Number of records."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-556" name="__codelineno-0-556"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-557" name="__codelineno-0-557"></a><span class="w"> </span><span class="sd">"""Export rates from a start date."""</span>
|
|
<a id="__codelineno-0-558" name="__codelineno-0-558"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-559" name="__codelineno-0-559"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-560" name="__codelineno-0-560"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">copy_rates_from_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-561" name="__codelineno-0-561"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-562" name="__codelineno-0-562"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-563" name="__codelineno-0-563"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-564" name="__codelineno-0-564"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-565" name="__codelineno-0-565"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-566" name="__codelineno-0-566"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.rates_from_pos" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">rates_from_pos</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.rates_from_pos" 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">rates_from_pos</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.TIMEFRAME_TYPE)" href="#mt5cli.cli.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Timeframe."</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start position (0 = current bar)."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Number of records."</span><span class="p">)</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export rates from a start position.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-569">569</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-570">570</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-571">571</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-572">572</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-573">573</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-574">574</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-575">575</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-576">576</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-577">577</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-578">578</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-579">579</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-580">580</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-581">581</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-582">582</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-583">583</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-584">584</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-585">585</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-586">586</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-587">587</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-588">588</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-589">589</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-590">590</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-591">591</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-592">592</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-569" name="__codelineno-0-569"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-570" name="__codelineno-0-570"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_from_pos</span><span class="p">(</span>
|
|
<a id="__codelineno-0-571" name="__codelineno-0-571"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-572" name="__codelineno-0-572"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-573" name="__codelineno-0-573"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-574" name="__codelineno-0-574"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-575" name="__codelineno-0-575"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-576" name="__codelineno-0-576"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
|
|
<a id="__codelineno-0-577" name="__codelineno-0-577"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Timeframe."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-578" name="__codelineno-0-578"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-579" name="__codelineno-0-579"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-580" name="__codelineno-0-580"></a> <span class="n">start_pos</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Start position (0 = current bar)."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-581" name="__codelineno-0-581"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Number of records."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-582" name="__codelineno-0-582"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-583" name="__codelineno-0-583"></a><span class="w"> </span><span class="sd">"""Export rates from a start position."""</span>
|
|
<a id="__codelineno-0-584" name="__codelineno-0-584"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-585" name="__codelineno-0-585"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-586" name="__codelineno-0-586"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">copy_rates_from_pos_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-587" name="__codelineno-0-587"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-588" name="__codelineno-0-588"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-589" name="__codelineno-0-589"></a> <span class="n">start_pos</span><span class="o">=</span><span class="n">start_pos</span><span class="p">,</span>
|
|
<a id="__codelineno-0-590" name="__codelineno-0-590"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-591" name="__codelineno-0-591"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-592" name="__codelineno-0-592"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.rates_range" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">rates_range</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.rates_range" 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">rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TIMEFRAME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.TIMEFRAME_TYPE)" href="#mt5cli.cli.TIMEFRAME_TYPE">TIMEFRAME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Timeframe."</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start date."</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export rates for a date range.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-595">595</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-596">596</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-597">597</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-598">598</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-599">599</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-600">600</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-601">601</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-602">602</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-603">603</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-604">604</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-605">605</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-606">606</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-607">607</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-608">608</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-609">609</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-610">610</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-611">611</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-612">612</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-613">613</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-614">614</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-615">615</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-616">616</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-617">617</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-618">618</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-619">619</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-620">620</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-621">621</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-622">622</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-623">623</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-624">624</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-595" name="__codelineno-0-595"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-596" name="__codelineno-0-596"></a><span class="k">def</span><span class="w"> </span><span class="nf">rates_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-597" name="__codelineno-0-597"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-598" name="__codelineno-0-598"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-599" name="__codelineno-0-599"></a> <span class="n">timeframe</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-600" name="__codelineno-0-600"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-601" name="__codelineno-0-601"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-602" name="__codelineno-0-602"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TIMEFRAME_TYPE</span><span class="p">,</span>
|
|
<a id="__codelineno-0-603" name="__codelineno-0-603"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Timeframe."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-604" name="__codelineno-0-604"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-605" name="__codelineno-0-605"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-606" name="__codelineno-0-606"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-607" name="__codelineno-0-607"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-608" name="__codelineno-0-608"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-609" name="__codelineno-0-609"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-610" name="__codelineno-0-610"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-611" name="__codelineno-0-611"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-612" name="__codelineno-0-612"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-613" name="__codelineno-0-613"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-614" name="__codelineno-0-614"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-615" name="__codelineno-0-615"></a><span class="w"> </span><span class="sd">"""Export rates for a date range."""</span>
|
|
<a id="__codelineno-0-616" name="__codelineno-0-616"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-617" name="__codelineno-0-617"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-618" name="__codelineno-0-618"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">copy_rates_range_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-619" name="__codelineno-0-619"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-620" name="__codelineno-0-620"></a> <span class="n">timeframe</span><span class="o">=</span><span class="n">timeframe</span><span class="p">,</span>
|
|
<a id="__codelineno-0-621" name="__codelineno-0-621"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-622" name="__codelineno-0-622"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
|
|
<a id="__codelineno-0-623" name="__codelineno-0-623"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-624" name="__codelineno-0-624"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.symbol_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbol_info</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.symbol_info" 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">symbol_info</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export symbol details.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-712">712</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-713">713</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-714">714</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-715">715</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-716">716</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-717">717</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-718">718</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-719">719</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-720">720</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-721">721</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-712" name="__codelineno-0-712"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-713" name="__codelineno-0-713"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info</span><span class="p">(</span>
|
|
<a id="__codelineno-0-714" name="__codelineno-0-714"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-715" name="__codelineno-0-715"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-716" name="__codelineno-0-716"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-717" name="__codelineno-0-717"></a><span class="w"> </span><span class="sd">"""Export symbol details."""</span>
|
|
<a id="__codelineno-0-718" name="__codelineno-0-718"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-719" name="__codelineno-0-719"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-720" name="__codelineno-0-720"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">symbol_info_as_df</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">),</span>
|
|
<a id="__codelineno-0-721" name="__codelineno-0-721"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.symbol_info_tick" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbol_info_tick</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.symbol_info_tick" 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">symbol_info_tick</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export the last tick for a symbol.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-832">832</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-833">833</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-834">834</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-835">835</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-836">836</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-837">837</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-838">838</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-839">839</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-840">840</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-841">841</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-832" name="__codelineno-0-832"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-833" name="__codelineno-0-833"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbol_info_tick</span><span class="p">(</span>
|
|
<a id="__codelineno-0-834" name="__codelineno-0-834"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-835" name="__codelineno-0-835"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-836" name="__codelineno-0-836"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-837" name="__codelineno-0-837"></a><span class="w"> </span><span class="sd">"""Export the last tick for a symbol."""</span>
|
|
<a id="__codelineno-0-838" name="__codelineno-0-838"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-839" name="__codelineno-0-839"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-840" name="__codelineno-0-840"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">symbol_info_tick_as_df</span><span class="p">(</span><span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">),</span>
|
|
<a id="__codelineno-0-841" name="__codelineno-0-841"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.symbols" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">symbols</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.symbols" 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">symbols</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">group</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n"><span title="str">str</span></span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol group filter (e.g., *USD*)."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export symbol list.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-697">697</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-698">698</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-699">699</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-700">700</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-701">701</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-702">702</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-703">703</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-704">704</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-705">705</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-706">706</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-707">707</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-708">708</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-709">709</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-697" name="__codelineno-0-697"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-698" name="__codelineno-0-698"></a><span class="k">def</span><span class="w"> </span><span class="nf">symbols</span><span class="p">(</span>
|
|
<a id="__codelineno-0-699" name="__codelineno-0-699"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-700" name="__codelineno-0-700"></a> <span class="n">group</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-701" name="__codelineno-0-701"></a> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-702" name="__codelineno-0-702"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol group filter (e.g., *USD*)."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-703" name="__codelineno-0-703"></a> <span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-704" name="__codelineno-0-704"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-705" name="__codelineno-0-705"></a><span class="w"> </span><span class="sd">"""Export symbol list."""</span>
|
|
<a id="__codelineno-0-706" name="__codelineno-0-706"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-707" name="__codelineno-0-707"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-708" name="__codelineno-0-708"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">symbols_get_as_df</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">),</span>
|
|
<a id="__codelineno-0-709" name="__codelineno-0-709"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.terminal_info" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">terminal_info</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.terminal_info" 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">terminal_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export terminal information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-691">691</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-692">692</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-693">693</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-694">694</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-691" name="__codelineno-0-691"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-692" name="__codelineno-0-692"></a><span class="k">def</span><span class="w"> </span><span class="nf">terminal_info</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-693" name="__codelineno-0-693"></a><span class="w"> </span><span class="sd">"""Export terminal information."""</span>
|
|
<a id="__codelineno-0-694" name="__codelineno-0-694"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">terminal_info_as_df</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.cli.ticks_from" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">ticks_from</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.ticks_from" 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">ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start date."</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">count</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="int">int</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Number of ticks."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TICK_FLAGS_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.TICK_FLAGS_TYPE)" href="#mt5cli.cli.TICK_FLAGS_TYPE">TICK_FLAGS_TYPE</a></span><span class="p">,</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Tick flags (ALL, INFO, TRADE, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export ticks from a start date.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-627">627</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-628">628</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-629">629</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-630">630</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-631">631</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-632">632</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-633">633</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-634">634</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-635">635</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-636">636</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-637">637</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-638">638</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-639">639</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-640">640</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-641">641</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-642">642</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-643">643</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-644">644</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-645">645</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-646">646</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-647">647</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-648">648</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-649">649</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-650">650</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-651">651</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-652">652</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-653">653</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-627" name="__codelineno-0-627"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-628" name="__codelineno-0-628"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_from</span><span class="p">(</span>
|
|
<a id="__codelineno-0-629" name="__codelineno-0-629"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-630" name="__codelineno-0-630"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-631" name="__codelineno-0-631"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-632" name="__codelineno-0-632"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-633" name="__codelineno-0-633"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-634" name="__codelineno-0-634"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-635" name="__codelineno-0-635"></a> <span class="n">count</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Number of ticks."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-636" name="__codelineno-0-636"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-637" name="__codelineno-0-637"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-638" name="__codelineno-0-638"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span>
|
|
<a id="__codelineno-0-639" name="__codelineno-0-639"></a> <span class="n">click_type</span><span class="o">=</span><span class="n">TICK_FLAGS_TYPE</span><span class="p">,</span>
|
|
<a id="__codelineno-0-640" name="__codelineno-0-640"></a> <span class="n">help</span><span class="o">=</span><span class="s2">"Tick flags (ALL, INFO, TRADE, or integer)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-641" name="__codelineno-0-641"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-642" name="__codelineno-0-642"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-643" name="__codelineno-0-643"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-644" name="__codelineno-0-644"></a><span class="w"> </span><span class="sd">"""Export ticks from a start date."""</span>
|
|
<a id="__codelineno-0-645" name="__codelineno-0-645"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-646" name="__codelineno-0-646"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-647" name="__codelineno-0-647"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">copy_ticks_from_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-648" name="__codelineno-0-648"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-649" name="__codelineno-0-649"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-650" name="__codelineno-0-650"></a> <span class="n">count</span><span class="o">=</span><span class="n">count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-651" name="__codelineno-0-651"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-652" name="__codelineno-0-652"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-653" name="__codelineno-0-653"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.ticks_range" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">ticks_range</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.ticks_range" 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">ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Start date."</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a> <span class="n"><span title="datetime.datetime">datetime</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span><span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="DATETIME_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.DATETIME_TYPE)" href="#mt5cli.cli.DATETIME_TYPE">DATETIME_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> <span class="n">flags</span><span class="p">:</span> <span class="n"><span title="typing.Annotated">Annotated</span></span><span class="p">[</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> <span class="n"><span title="int">int</span></span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> <span class="n"><span title="typer.Option">Option</span></span><span class="p">(</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> <span class="n"><span title="typer.Option(click_type)">click_type</span></span><span class="o">=</span><span class="n"><a class="autorefs autorefs-internal" title="TICK_FLAGS_TYPE
|
|
|
|
|
|
|
|
module-attribute
|
|
(mt5cli.cli.TICK_FLAGS_TYPE)" href="#mt5cli.cli.TICK_FLAGS_TYPE">TICK_FLAGS_TYPE</a></span><span class="p">,</span> <span class="n"><span title="typer.Option(help)">help</span></span><span class="o">=</span><span class="s2">"Tick flags."</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export ticks for a date range.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-656">656</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-657">657</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-658">658</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-659">659</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-660">660</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-661">661</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-662">662</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-663">663</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-664">664</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-665">665</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-666">666</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-667">667</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-668">668</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-669">669</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-670">670</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-671">671</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-672">672</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-673">673</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-674">674</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-675">675</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-676">676</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-677">677</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-678">678</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-679">679</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-680">680</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-681">681</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-682">682</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-656" name="__codelineno-0-656"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-657" name="__codelineno-0-657"></a><span class="k">def</span><span class="w"> </span><span class="nf">ticks_range</span><span class="p">(</span>
|
|
<a id="__codelineno-0-658" name="__codelineno-0-658"></a> <span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span>
|
|
<a id="__codelineno-0-659" name="__codelineno-0-659"></a> <span class="n">symbol</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">help</span><span class="o">=</span><span class="s2">"Symbol name."</span><span class="p">)],</span>
|
|
<a id="__codelineno-0-660" name="__codelineno-0-660"></a> <span class="n">date_from</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-661" name="__codelineno-0-661"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-662" name="__codelineno-0-662"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Start date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-663" name="__codelineno-0-663"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-664" name="__codelineno-0-664"></a> <span class="n">date_to</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-665" name="__codelineno-0-665"></a> <span class="n">datetime</span><span class="p">,</span>
|
|
<a id="__codelineno-0-666" name="__codelineno-0-666"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">DATETIME_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"End date."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-667" name="__codelineno-0-667"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-668" name="__codelineno-0-668"></a> <span class="n">flags</span><span class="p">:</span> <span class="n">Annotated</span><span class="p">[</span>
|
|
<a id="__codelineno-0-669" name="__codelineno-0-669"></a> <span class="nb">int</span><span class="p">,</span>
|
|
<a id="__codelineno-0-670" name="__codelineno-0-670"></a> <span class="n">typer</span><span class="o">.</span><span class="n">Option</span><span class="p">(</span><span class="n">click_type</span><span class="o">=</span><span class="n">TICK_FLAGS_TYPE</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s2">"Tick flags."</span><span class="p">),</span>
|
|
<a id="__codelineno-0-671" name="__codelineno-0-671"></a> <span class="p">],</span>
|
|
<a id="__codelineno-0-672" name="__codelineno-0-672"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-673" name="__codelineno-0-673"></a><span class="w"> </span><span class="sd">"""Export ticks for a date range."""</span>
|
|
<a id="__codelineno-0-674" name="__codelineno-0-674"></a> <span class="n">_execute_export</span><span class="p">(</span>
|
|
<a id="__codelineno-0-675" name="__codelineno-0-675"></a> <span class="n">ctx</span><span class="p">,</span>
|
|
<a id="__codelineno-0-676" name="__codelineno-0-676"></a> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">copy_ticks_range_as_df</span><span class="p">(</span>
|
|
<a id="__codelineno-0-677" name="__codelineno-0-677"></a> <span class="n">symbol</span><span class="o">=</span><span class="n">symbol</span><span class="p">,</span>
|
|
<a id="__codelineno-0-678" name="__codelineno-0-678"></a> <span class="n">date_from</span><span class="o">=</span><span class="n">date_from</span><span class="p">,</span>
|
|
<a id="__codelineno-0-679" name="__codelineno-0-679"></a> <span class="n">date_to</span><span class="o">=</span><span class="n">date_to</span><span class="p">,</span>
|
|
<a id="__codelineno-0-680" name="__codelineno-0-680"></a> <span class="n">flags</span><span class="o">=</span><span class="n">flags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-681" name="__codelineno-0-681"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-682" name="__codelineno-0-682"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
<h3 id="mt5cli.cli.version" class="doc doc-heading">
|
|
<span class="doc doc-object-name doc-function-name">version</span>
|
|
|
|
|
|
<a href="#mt5cli.cli.version" 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">version</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n"><span title="typer.Context">Context</span></span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span>
|
|
</code></pre></div>
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Export MetaTrader5 version information.</p>
|
|
|
|
|
|
<details class="mkdocstrings-source">
|
|
<summary>Source code in <code>mt5cli/cli.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-820">820</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-821">821</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-822">822</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-823">823</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-820" name="__codelineno-0-820"></a><span class="nd">@app</span><span class="o">.</span><span class="n">command</span><span class="p">()</span>
|
|
<a id="__codelineno-0-821" name="__codelineno-0-821"></a><span class="k">def</span><span class="w"> </span><span class="nf">version</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">typer</span><span class="o">.</span><span class="n">Context</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-822" name="__codelineno-0-822"></a><span class="w"> </span><span class="sd">"""Export MetaTrader5 version information."""</span>
|
|
<a id="__codelineno-0-823" name="__codelineno-0-823"></a> <span class="n">_execute_export</span><span class="p">(</span><span class="n">ctx</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="o">.</span><span class="n">version_as_df</span><span class="p">())</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="col-md-12">
|
|
<hr>
|
|
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
|
|
</footer>
|
|
<script src="../../js/bootstrap.bundle.min.js"></script>
|
|
<script>
|
|
var base_url = "../..",
|
|
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
|
|
</script>
|
|
<script src="../../js/base.js"></script>
|
|
<script src="../../search/main.js"></script>
|
|
|
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
|
<div class="modal-dialog modal-lg">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
|
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
|
</div>
|
|
<div class="modal-body">
|
|
<p>From here you can search these documents. Enter your search terms below.</p>
|
|
<form>
|
|
<div class="form-group">
|
|
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
|
</div>
|
|
</form>
|
|
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
|
|
</div>
|
|
<div class="modal-footer">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
|
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
|
|
</div>
|
|
<div class="modal-body">
|
|
<table class="table">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 20%;">Keys</th>
|
|
<th>Action</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="help shortcut"><kbd>?</kbd></td>
|
|
<td>Open this help</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="next shortcut"><kbd>n</kbd></td>
|
|
<td>Next page</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
|
<td>Previous page</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="search shortcut"><kbd>s</kbd></td>
|
|
<td>Search</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="modal-footer">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|