Skip to content

Commit

Permalink
documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@maet3608
maet3608 committed Nov 18, 2020
1 parent 28f4c72 commit b96da53
Show file tree
Hide file tree
Showing 7 changed files with 1,094 additions and 697 deletions.
27 changes: 4 additions & 23 deletions docs/html/_modules/nutsflow/factory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,19 +194,14 @@ <h1>Source code for nutsflow.factory</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">class</span> <span class="nc">Wrapper</span><span class="p">(</span><span class="n">base_class</span><span class="p">):</span>
<span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__doc__</span>

<span class="k">def</span> <span class="fm">__rrshift__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">iterable</span><span class="p">):</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">_arg_insert</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="n">iterable</span><span class="p">,</span> <span class="n">iterpos</span><span class="p">)</span>
<span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span>

<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__module__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__rrshift__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;Chaining operator (&gt;&gt;) for nuts&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__call__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">return</span> <span class="n">Wrapper</span>


Expand All @@ -221,21 +216,16 @@ <h1>Source code for nutsflow.factory</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">class</span> <span class="nc">Wrapper</span><span class="p">(</span><span class="n">Nut</span><span class="p">):</span>
<span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__doc__</span>

<span class="k">def</span> <span class="fm">__rrshift__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">iterable</span><span class="p">):</span>
<span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="n">iterable</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">_arg_insert</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">bool</span><span class="p">(</span><span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">))</span> <span class="o">!=</span> <span class="n">invert</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">e</span>

<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__module__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__rrshift__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;Chaining operator (&gt;&gt;) for nuts&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__call__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">return</span> <span class="n">Wrapper</span>


Expand Down Expand Up @@ -349,17 +339,13 @@ <h1>Source code for nutsflow.factory</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">class</span> <span class="nc">Wrapper</span><span class="p">(</span><span class="n">NutFunction</span><span class="p">):</span>
<span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__doc__</span>

<span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">element</span><span class="p">):</span>
<span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span>

<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__module__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__call__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">return</span> <span class="n">Wrapper</span></div>


Expand Down Expand Up @@ -394,18 +380,13 @@ <h1>Source code for nutsflow.factory</h1><div class="highlight"><pre>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">class</span> <span class="nc">Wrapper</span><span class="p">(</span><span class="n">NutSource</span><span class="p">):</span>
<span class="nd">@functools</span><span class="o">.</span><span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">pass</span>
<span class="vm">__doc__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__doc__</span>

<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">kwargs</span><span class="p">)</span>

<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="vm">__module__</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__module__</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__iter__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;Iterator over source elements&quot;</span>
<span class="n">Wrapper</span><span class="o">.</span><span class="fm">__call__</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
<span class="k">return</span> <span class="n">Wrapper</span></div>


Expand Down
120 changes: 1 addition & 119 deletions docs/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,152 +210,34 @@ <h2 id="_">_</h2>
<li><a href="nutsflow.html#nutsflow.function.Square.__call__">(Square method)</a>
</li>
</ul></li>
<li><a href="nutsflow.html#nutsflow.processor.Append.__init__">__init__() (Append method)</a>
<li><a href="nutsflow.html#nutsflow.processor.Cache.__init__">__init__() (Cache method)</a>

<ul>
<li><a href="nutsflow.html#nutsflow.sink.ArgMax.__init__">(ArgMax method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.ArgMin.__init__">(ArgMin method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Cache.__init__">(Cache method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Chunk.__init__">(Chunk method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.ChunkBy.__init__">(ChunkBy method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.ChunkWhen.__init__">(ChunkWhen method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Clone.__init__">(Clone method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Collect.__init__">(Collect method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Concat.__init__">(Concat method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Counter.__init__">(Counter method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.CountValues.__init__">(CountValues method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Drop.__init__">(Drop method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.DropWhile.__init__">(DropWhile method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.source.Empty.__init__">(Empty method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.source.Enumerate.__init__">(Enumerate method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.FilterCol.__init__">(FilterCol method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Flatten.__init__">(Flatten method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.FlattenCol.__init__">(FlattenCol method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Format.__init__">(Format method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Get.__init__">(Get method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.GetCols.__init__">(GetCols method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.GroupBy.__init__">(GroupBy method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.GroupBySorted.__init__">(GroupBySorted method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Head.__init__">(Head method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Identity.__init__">(Identity method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.If.__init__">(If method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Insert.__init__">(Insert method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Interleave.__init__">(Interleave method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Join.__init__">(Join method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.MapCol.__init__">(MapCol method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.MapMulti.__init__">(MapMulti method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.MapPar.__init__">(MapPar method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Max.__init__">(Max method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Mean.__init__">(Mean method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.MeanStd.__init__">(MeanStd method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Min.__init__">(Min method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MyClone.__init__">(MyClone method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MyCollect.__init__">(MyCollect method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MyGreaterThan.__init__">(MyGreaterThan method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MyPipeline.__init__">(MyPipeline method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MyRange.__init__">(MyRange method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MySmallerOrEqualThan.__init__">(MySmallerOrEqualThan method)</a>
</li>
<li><a href="nutsflow.examples.html#nutsflow.examples.examples.MyTimes.__init__">(MyTimes method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.NOP.__init__">(NOP method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.base.Nut.__init__">(Nut method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Pick.__init__">(Pick method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Prefetch.__init__">(Prefetch method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.iterfunction.PrefetchIterator.__init__">(PrefetchIterator method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Print.__init__">(Print method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.PrintProgress.__init__">(PrintProgress method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.source.Product.__init__">(Product method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.source.Range.__init__">(Range method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.source.ReadCSV.__init__">(ReadCSV method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.common.Redirect.__init__">(Redirect method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.source.Repeat.__init__">(Repeat method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Shuffle.__init__">(Shuffle method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Sleep.__init__">(Sleep method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Slice.__init__">(Slice method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Sort.__init__">(Sort method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.function.Square.__init__">(Square method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.common.StableRandom.__init__">(StableRandom method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Sum.__init__">(Sum method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Tail.__init__">(Tail method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Take.__init__">(Take method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Try.__init__">(Try method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.Unzip.__init__">(Unzip method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Window.__init__">(Window method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.sink.WriteCSV.__init__">(WriteCSV method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.Zip.__init__">(Zip method)</a>
</li>
<li><a href="nutsflow.html#nutsflow.processor.ZipWith.__init__">(ZipWith method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="nutsflow.html#nutsflow.processor.Append.__rrshift__">__rrshift__() (Append method)</a>

<ul>
Expand Down

0 comments on commit b96da53

Please sign in to comment.