elmau
/
zaz
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
zaz/doc/build/main/tools.html

571 lines
41 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Tools &#8212; ZAZ documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Paths and files" href="paths.html" />
<link rel="prev" title="Tools for debug" href="tools_for_debug.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="tools">
<h1>Tools<a class="headerlink" href="#tools" title="Permalink to this headline"></a></h1>
<p>Remember, always import library.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">easymacro</span> <span class="k">as</span> <span class="nn">app</span>
</pre></div>
</div>
<section id="info-from-pc">
<h2>Info from PC<a class="headerlink" href="#info-from-pc" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Operate system</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">OS</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Current user</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">USER</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Name PC</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">PC</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Name desktop, only GNU/Linux</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">DESKTOP</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Language</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">LANG</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Language with variant</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">LANGUAGE</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Application name</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">NAME</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Application version</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">VERSION</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>In Windows</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">IS_WIN</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>In Mac</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">IS_MAC</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="message-box">
<h2>Message Box<a class="headerlink" href="#message-box" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">IS_WIN</span><span class="p">,</span> <span class="s1">&#39;My Macro&#39;</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="show-warning">
<h2>Show warning<a class="headerlink" href="#show-warning" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Caution, this action is dangerous&#39;</span>
<span class="n">title</span> <span class="o">=</span> <span class="s1">&#39;My App&#39;</span>
<span class="n">app</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="show-error-box">
<h2>Show error box<a class="headerlink" href="#show-error-box" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;ERROR: Contact technical support&#39;</span>
<span class="n">title</span> <span class="o">=</span> <span class="s1">&#39;My App&#39;</span>
<span class="n">app</span><span class="o">.</span><span class="n">errorbox</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="make-question">
<h2>Make question<a class="headerlink" href="#make-question" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Is easy Python?&#39;</span>
<span class="n">title</span> <span class="o">=</span> <span class="s1">&#39;My App&#39;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">question</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="inputbox">
<h2>InputBox<a class="headerlink" href="#inputbox" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Normal data</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Type your name&#39;</span>
<span class="n">default</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="n">title</span> <span class="o">=</span> <span class="s1">&#39;My App&#39;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">inputbox</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">default</span><span class="p">,</span> <span class="n">title</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Private data</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">message</span> <span class="o">=</span> <span class="s1">&#39;Type your password&#39;</span>
<span class="n">default</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
<span class="n">title</span> <span class="o">=</span> <span class="s1">&#39;My App&#39;</span>
<span class="n">echochar</span> <span class="o">=</span> <span class="s2">&quot;*&quot;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">inputbox</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">default</span><span class="p">,</span> <span class="n">title</span><span class="p">,</span> <span class="n">echochar</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="date-and-times">
<h2>Date and times<a class="headerlink" href="#date-and-times" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Get today</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">today</span><span class="p">())</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Get now</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">now</span><span class="p">())</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Get now only time</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">now</span><span class="p">(</span><span class="kc">True</span><span class="p">))</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Get <a class="reference external" href="https://en.wikipedia.org/wiki/Unix_time">epoch time</a></p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">get_epoch</span><span class="p">())</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Simple measure time</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="n">app</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="n">seconds</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">end</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="thread">
<h2>Thread<a class="headerlink" href="#thread" title="Permalink to this headline"></a></h2>
<p>You can execute any macro in thread</p>
<ul class="simple">
<li><p>Normal execution</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">show_time</span><span class="p">(</span><span class="n">seconds</span><span class="p">):</span>
<span class="n">app</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">NAME</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">show_time</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="s1">&#39;Finish...&#39;</span><span class="p">)</span>
<span class="k">return</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Run in thread</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@app</span><span class="o">.</span><span class="n">run_in_thread</span>
<span class="k">def</span> <span class="nf">show_time</span><span class="p">(</span><span class="n">seconds</span><span class="p">):</span>
<span class="n">app</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">NAME</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">show_time</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="s1">&#39;Finish...&#39;</span><span class="p">)</span>
<span class="k">return</span>
</pre></div>
</div>
</section>
<section id="dictionary-properties">
<h2>Dictionary &lt;-&gt; properties<a class="headerlink" href="#dictionary-properties" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;Hidden&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">&#39;Password&#39;</span><span class="p">:</span> <span class="s1">&#39;letmein&#39;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">properties</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">dict_to_property</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">properties</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">data_to_dict</span><span class="p">(</span><span class="n">properties</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="tuples-or-lists-to-dictionary">
<h2>Tuples or lists to dictionary<a class="headerlink" href="#tuples-or-lists-to-dictionary" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">tuple_of_tuples</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="s1">&#39;Hidden&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;Password&#39;</span><span class="p">,</span> <span class="s1">&#39;letmein&#39;</span><span class="p">),</span>
<span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">data_to_dict</span><span class="p">(</span><span class="n">tuple_of_tuples</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="n">list_of_lists</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">[</span><span class="s1">&#39;Hidden&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">],</span>
<span class="p">[</span><span class="s1">&#39;Password&#39;</span><span class="p">,</span> <span class="s1">&#39;letmein&#39;</span><span class="p">],</span>
<span class="p">]</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">data_to_dict</span><span class="p">(</span><span class="n">list_of_lists</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="json">
<h2>Json<a class="headerlink" href="#json" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;Hidden&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">&#39;Password&#39;</span><span class="p">:</span> <span class="s1">&#39;letmein&#39;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">json</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">json_dumps</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">json</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">json_loads</span><span class="p">(</span><span class="n">json</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="call-macros">
<h2>Call Macros<a class="headerlink" href="#call-macros" title="Permalink to this headline"></a></h2>
<p>You can any macro, for default call macros Python.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">show_message</span><span class="p">():</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">INFO_DEBUG</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;library&#39;</span><span class="p">:</span> <span class="s1">&#39;test&#39;</span><span class="p">,</span>
<span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;show_message&#39;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">app</span><span class="o">.</span><span class="n">call_macro</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
<span class="k">return</span>
</pre></div>
</div>
<p>Of course is better call directly if both macros are the same languaje, but, you can call macro in Basic too.</p>
<div class="highlight-vbnet notranslate"><div class="highlight"><pre><span></span><span class="k">Sub</span> <span class="nf">show_message</span><span class="p">()</span>
<span class="n">MsgBox</span> <span class="s">&quot;Basic from Python&quot;</span>
<span class="k">End</span> <span class="k">Sub</span>
</pre></div>
</div>
<p>Call from Python with.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;language&#39;</span><span class="p">:</span> <span class="s1">&#39;Basic&#39;</span><span class="p">,</span>
<span class="s1">&#39;library&#39;</span><span class="p">:</span> <span class="s1">&#39;Standard&#39;</span><span class="p">,</span>
<span class="s1">&#39;module&#39;</span><span class="p">:</span> <span class="s1">&#39;Module1&#39;</span><span class="p">,</span>
<span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;show_message&#39;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">app</span><span class="o">.</span><span class="n">call_macro</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
</pre></div>
</div>
<p>Execute macro in other thread</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app</span><span class="o">.</span><span class="n">call_macro</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="call-external-program">
<h2>Call external program<a class="headerlink" href="#call-external-program" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">app_name</span> <span class="o">=</span> <span class="s1">&#39;gnome-calculator&#39;</span>
<span class="n">app</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">app_name</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="s1">&#39;ok&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p>Call command line and capture output</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">args</span> <span class="o">=</span> <span class="s1">&#39;ls -lh ~&#39;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">21</span>/06/2021 <span class="m">22</span>:27:22 - DEBUG - total <span class="m">1</span>.3M
drwxr-xr-x <span class="m">5</span> mau mau <span class="m">4</span>.0K Jun <span class="m">17</span> <span class="m">13</span>:09 Desktop
drwxr-xr-x <span class="m">6</span> mau mau <span class="m">4</span>.0K Jun <span class="m">15</span> <span class="m">12</span>:35 Documents
drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K Jun <span class="m">21</span> <span class="m">20</span>:26 Downloads
drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K Jun <span class="m">21</span> <span class="m">16</span>:18 Pictures
drwxr-xr-x <span class="m">13</span> mau mau <span class="m">4</span>.0K Jun <span class="m">21</span> <span class="m">15</span>:34 Projects
drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K May <span class="m">11</span> <span class="m">18</span>:48 Templates
drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K Jun <span class="m">20</span> <span class="m">23</span>:27 Videos
</pre></div>
</div>
<p>Call command line and capture output line by line.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">args</span> <span class="o">=</span> <span class="s1">&#39;ls -lh /home/mau&#39;</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">app</span><span class="o">.</span><span class="n">popen</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
<span class="n">app</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - total <span class="m">1</span>.3M
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">5</span> mau mau <span class="m">4</span>.0K Jun <span class="m">17</span> <span class="m">13</span>:09 Desktop
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">6</span> mau mau <span class="m">4</span>.0K Jun <span class="m">15</span> <span class="m">12</span>:35 Documents
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K Jun <span class="m">21</span> <span class="m">20</span>:26 Downloads
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - -rw-r----- <span class="m">1</span> mau mau <span class="m">1</span>.3M Jun <span class="m">14</span> <span class="m">11</span>:53 out.png
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K Jun <span class="m">21</span> <span class="m">16</span>:18 Pictures
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">13</span> mau mau <span class="m">4</span>.0K Jun <span class="m">21</span> <span class="m">15</span>:34 Projects
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K May <span class="m">11</span> <span class="m">18</span>:48 Templates
<span class="m">21</span>/06/2021 <span class="m">22</span>:34:42 - DEBUG - drwxr-xr-x <span class="m">2</span> mau mau <span class="m">4</span>.0K Jun <span class="m">20</span> <span class="m">23</span>:27 Videos
</pre></div>
</div>
</section>
<section id="timer">
<h2>Timer<a class="headerlink" href="#timer" title="Permalink to this headline"></a></h2>
<p>Execute any macro every seconds.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">TIMER_NAME</span> <span class="o">=</span> <span class="s1">&#39;clock&#39;</span>
<span class="k">def</span> <span class="nf">show_time</span><span class="p">():</span>
<span class="n">app</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">now</span><span class="p">(</span><span class="kc">True</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">start_clock</span><span class="p">():</span>
<span class="n">seconds</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">macro</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;library&#39;</span><span class="p">:</span> <span class="s1">&#39;test&#39;</span><span class="p">,</span>
<span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;show_time&#39;</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">app</span><span class="o">.</span><span class="n">start_timer</span><span class="p">(</span><span class="n">TIMER_NAME</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="n">macro</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">stop_clock</span><span class="p">():</span>
<span class="n">app</span><span class="o">.</span><span class="n">stop_timer</span><span class="p">(</span><span class="n">TIMER_NAME</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="n">start_clock</span><span class="p">()</span>
<span class="k">return</span>
</pre></div>
</div>
<p>Execute <cite>stop_clock</cite> for stop timer.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="m">21</span>/06/2021 <span class="m">22</span>:43:17 - INFO - Timer started... show_time
<span class="m">21</span>/06/2021 <span class="m">22</span>:43:18 - DEBUG - <span class="m">22</span>:43:18.080315
<span class="m">21</span>/06/2021 <span class="m">22</span>:43:19 - DEBUG - <span class="m">22</span>:43:19.082211
...
<span class="m">21</span>/06/2021 <span class="m">22</span>:43:46 - DEBUG - <span class="m">22</span>:43:46.126446
<span class="m">21</span>/06/2021 <span class="m">22</span>:43:47 - DEBUG - <span class="m">22</span>:43:47.128487
<span class="m">21</span>/06/2021 <span class="m">22</span>:43:47 - INFO - Timer stopped... show_time
</pre></div>
</div>
</section>
<section id="get-digest">
<h2>Get digest<a class="headerlink" href="#get-digest" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">data</span> <span class="o">=</span> <span class="s1">&#39;LibreOffice with Python&#39;</span>
<span class="n">digest</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">digest</span><span class="p">)</span>
<span class="n">digest</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">sha512</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">digest</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="save-and-get-configurations">
<h2>Save and get configurations<a class="headerlink" href="#save-and-get-configurations" title="Permalink to this headline"></a></h2>
<p>You can save any data.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">my_app</span> <span class="o">=</span> <span class="s1">&#39;my_extension&#39;</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;path&#39;</span><span class="p">:</span> <span class="s1">&#39;/home/mau/work&#39;</span><span class="p">,</span>
<span class="s1">&#39;save_data&#39;</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">app</span><span class="o">.</span><span class="n">set_config</span><span class="p">(</span><span class="s1">&#39;config&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">my_app</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="s1">&#39;Save config&#39;</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">get_config</span><span class="p">(</span><span class="s1">&#39;config&#39;</span><span class="p">,</span> <span class="n">my_app</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="render-string">
<h2>Render string<a class="headerlink" href="#render-string" title="Permalink to this headline"></a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;Hello $name</span>
<span class="s2">I send you this $file_name</span>
<span class="s2">Best regards</span>
<span class="s2">&quot;&quot;&quot;</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;name&#39;</span><span class="p">:</span> <span class="s1">&#39;Ingrid Bergman&#39;</span><span class="p">,</span> <span class="s1">&#39;file_name&#39;</span><span class="p">:</span> <span class="s1">&#39;letter_love.odt&#39;</span><span class="p">}</span>
<span class="n">render</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">render</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="encrypt-decrypt">
<h2>Encrypt decrypt<a class="headerlink" href="#encrypt-decrypt" title="Permalink to this headline"></a></h2>
<p>You need install library <a class="reference external" href="https://github.com/pyca/cryptography">cryptography</a></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">easymacro</span> <span class="k">as</span> <span class="nn">app</span>
<span class="kn">from</span> <span class="nn">conf</span> <span class="kn">import</span> <span class="n">PASSWORD</span>
<span class="k">def</span> <span class="nf">encrypt_decrypt</span><span class="p">():</span>
<span class="n">data</span> <span class="o">=</span> <span class="s1">&#39;My super secret data&#39;</span>
<span class="n">token</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">encrypt</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">PASSWORD</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">token</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">decrypt</span><span class="p">(</span><span class="n">token</span><span class="p">,</span> <span class="n">PASSWORD</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="k">return</span>
</pre></div>
</div>
</section>
<section id="simple-url-open">
<h2>Simple url open<a class="headerlink" href="#simple-url-open" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Get text data</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://api.ipify.org&#39;</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">url_open</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p>Get json data</p></li>
</ul>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">url</span> <span class="o">=</span> <span class="s1">&#39;https://api.ipify.org?format=json&#39;</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">url_open</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">get_json</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">app</span><span class="o">.</span><span class="n">msgbox</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<p>For more complex case, you can used <a class="reference external" href="https://docs.python-requests.org">requests</a> or <a class="reference external" href="https://www.python-httpx.org/">httpx</a></p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">ZAZ</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="easymacro.html">Library easymacro.py</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="tools_for_debug.html">Tools for debug</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="paths.html">Paths and files</a></li>
<li class="toctree-l2"><a class="reference internal" href="email.html">Email</a></li>
<li class="toctree-l2"><a class="reference internal" href="application.html">Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="calc.html">Calc</a></li>
<li class="toctree-l2"><a class="reference internal" href="writer.html">Writer</a></li>
<li class="toctree-l2"><a class="reference internal" href="base.html">Base</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="easymacro.html">Library easymacro.py</a><ul>
<li>Previous: <a href="tools_for_debug.html" title="previous chapter">Tools for debug</a></li>
<li>Next: <a href="paths.html" title="next chapter">Paths and files</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, Mauricio Baeza.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/main/tools.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink