Dev (#151)

* updated pyworkflow yaml

* Updates to documentation and CI/CD passes all tests

* updates

* Upgrade to the rebuild feature

* fixes to hashing bug and upgrades to rebuild command

* fixed gaps in coverage

* Fixed some antipatterns

* fixed coverage gaps

* fixed testing errors

Author: alexpdev

.gitignore

@@ -13,6 +13,7 @@ temp/
 runner/
 run.py
 venv/
+/tests/dest/
 # Byte-compiled / optimized / DLL files
 *.bin
 *.pyc

CHANGELOG.md

@@ -1,5 +1,16 @@
 # TorrentFile
 
+## Version 0.8.2
+
+-   Rebuild subcommand now checks on a hash by hash basis 
+-   Fixed coverage issues
+-   Added unittests for the rebuild command
+-   Fixed bug with torrentfile creation when a file was a perfect power of 2
+-   Reconfigured the rebuild module
+-   Reconfigured the rebuild cli flags and arguments
+
+* * *
+
 ## Version 0.8.1
 
 -   Further improvements to documentation

Makefile

@@ -73,6 +73,7 @@ clean-build: ## remove build artifacts
 	rm -frv runner/dist
 
 test: ## Get coverage report
+	# pip install torrentfile torrentfileQt QStyler ebookatty --force-reinstall --no-cache --upgrade
 	tox
 
 docs: ## Regenerate docs from changes

docs/Source/cli/index.html

@@ -956,9 +956,9 @@ <h3 id="torrentfile.cli.TorrentFileHelpFormatter" class="doc doc-heading">
 <span class="sd">    max_help_positions : int</span>
 <span class="sd">        max length until line wrap.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">prog</span><span class="p">,</span>
-                     <span class="n">width</span><span class="o">=</span><span class="n">width</span><span class="p">,</span>
-                     <span class="n">max_help_position</span><span class="o">=</span><span class="n">max_help_positions</span><span class="p">)</span>
+    <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
+        <span class="n">prog</span><span class="p">,</span> <span class="n">width</span><span class="o">=</span><span class="n">width</span><span class="p">,</span> <span class="n">max_help_position</span><span class="o">=</span><span class="n">max_help_positions</span>
+    <span class="p">)</span>
 </code></pre></div></td></tr></table></div>
           </details>
 
@@ -1440,7 +1440,18 @@ <h3 id="torrentfile.cli.execute" class="doc doc-heading">
 <span class="normal">582</span>
 <span class="normal">583</span>
 <span class="normal">584</span>
-<span class="normal">585</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
+<span class="normal">585</span>
+<span class="normal">586</span>
+<span class="normal">587</span>
+<span class="normal">588</span>
+<span class="normal">589</span>
+<span class="normal">590</span>
+<span class="normal">591</span>
+<span class="normal">592</span>
+<span class="normal">593</span>
+<span class="normal">594</span>
+<span class="normal">595</span>
+<span class="normal">596</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Execute program with provided list of arguments.</span>
 
@@ -1469,7 +1480,8 @@ <h3 id="torrentfile.cli.execute" class="doc doc-heading">
         <span class="n">usage</span><span class="o">=</span><span class="s2">&quot;torrentfile [options] command [command options]&quot;</span><span class="p">,</span>
         <span class="n">description</span><span class="o">=</span><span class="p">(</span>
             <span class="s2">&quot;Command line tools for creating, editing, checking, building &quot;</span>
-            <span class="s2">&quot;and interacting with Bittorrent metainfo files&quot;</span><span class="p">),</span>
+            <span class="s2">&quot;and interacting with Bittorrent metainfo files&quot;</span>
+        <span class="p">),</span>
         <span class="n">prefix_chars</span><span class="o">=</span><span class="s2">&quot;-&quot;</span><span class="p">,</span>
         <span class="n">formatter_class</span><span class="o">=</span><span class="n">TorrentFileHelpFormatter</span><span class="p">,</span>
         <span class="n">conflict_handler</span><span class="o">=</span><span class="s2">&quot;resolve&quot;</span><span class="p">,</span>
@@ -1796,22 +1808,32 @@ <h3 id="torrentfile.cli.execute" class="doc doc-heading">
     <span class="p">)</span>
 
     <span class="n">rebuild_parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
-        <span class="s2">&quot;metafiles&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;-m&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;--metafiles&quot;</span><span class="p">,</span>
         <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store&quot;</span><span class="p">,</span>
         <span class="n">metavar</span><span class="o">=</span><span class="s2">&quot;&lt;*.torrent&gt;&quot;</span><span class="p">,</span>
-        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;path to .torrent file. or directory containing .torrent files&quot;</span><span class="p">,</span>
+        <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;+&quot;</span><span class="p">,</span>
+        <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;metafiles&quot;</span><span class="p">,</span>
+        <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
+        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;path(s) to .torrent file(s)/folder(s) containing .torrent files&quot;</span><span class="p">,</span>
     <span class="p">)</span>
 
     <span class="n">rebuild_parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
-        <span class="s2">&quot;contents&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;-c&quot;</span> <span class="s2">&quot;--contents&quot;</span><span class="p">,</span>
         <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store&quot;</span><span class="p">,</span>
+        <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;contents&quot;</span><span class="p">,</span>
+        <span class="n">nargs</span><span class="o">=</span><span class="s2">&quot;+&quot;</span><span class="p">,</span>
+        <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
         <span class="n">metavar</span><span class="o">=</span><span class="s2">&quot;&lt;contents&gt;&quot;</span><span class="p">,</span>
-        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;directory that contains some or all of the torrents contents&quot;</span><span class="p">,</span>
+        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;folders that might contain the source contents needed to rebuld&quot;</span><span class="p">,</span>
     <span class="p">)</span>
 
     <span class="n">rebuild_parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
-        <span class="s2">&quot;destination&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;-d&quot;</span><span class="p">,</span>
+        <span class="s2">&quot;--destination&quot;</span><span class="p">,</span>
         <span class="n">action</span><span class="o">=</span><span class="s2">&quot;store&quot;</span><span class="p">,</span>
+        <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;destination&quot;</span><span class="p">,</span>
+        <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
         <span class="n">metavar</span><span class="o">=</span><span class="s2">&quot;&lt;destination&gt;&quot;</span><span class="p">,</span>
         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;path to where torrents will be re-assembled&quot;</span><span class="p">,</span>
     <span class="p">)</span>
@@ -1853,11 +1875,11 @@ <h3 id="torrentfile.cli.main" class="doc doc-heading">
 
       <details class="quote">
         <summary>Source code in <code>torrentfile\cli.py</code></summary>
-        <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">591</span>
-<span class="normal">592</span>
-<span class="normal">593</span>
-<span class="normal">594</span>
-<span class="normal">595</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
+        <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">602</span>
+<span class="normal">603</span>
+<span class="normal">604</span>
+<span class="normal">605</span>
+<span class="normal">606</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Initiate main function for CLI script.</span>
 <span class="sd">    &quot;&quot;&quot;</span>