Skip to content

Commit bbf30aa

Browse files
alexpdevalexpdev
authored
Merge pull request #14 from alexpdev/0.3.1
bump version 0.3.1
2 parents 3ed001f + 59a8dc9 commit bbf30aa

File tree

16 files changed

+440
-180
lines changed

16 files changed

+440
-180
lines changed

‎LICENSE‎

Lines changed: 201 additions & 165 deletions
Large diffs are not rendered by default.

‎Makefile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,8 @@ dist: clean ## builds source and wheel package
8383

8484
install: clean ## install the package to the active Python's site-packages
8585
python setup.py install
86+
87+
build: lint test docs clean ## Build project library
88+
python setup.py sdist
89+
python setup.py bdist_wheel
90+
python setup.py bdist_egg

‎docs/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h3>Quick search</h3>
113113

114114
<!--
115115
MkDocs version : 1.2.3
116-
Docs Build Date UTC : 2022-03-17 20:14:29.942284+00:00
116+
Docs Build Date UTC : 2022-04-24 00:10:52.551087+00:00
117117
-->
118118
</body>
119119
</html>

‎docs/LICENSE/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ <h3>Quick search</h3>
314314

315315
<!--
316316
MkDocs version : 1.2.3
317-
Docs Build Date UTC : 2022-03-17 20:14:29.965282+00:00
317+
Docs Build Date UTC : 2022-04-24 00:10:52.573093+00:00
318318
-->
319319
</body>
320320
</html>

‎docs/api/index.html‎

Lines changed: 188 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ <h4 id="pyben--functions">Functions</h4>
8181
<li>dumps</li>
8282
<li>load</li>
8383
<li>loads</li>
84+
<li>readinto</li>
8485
</ul>
8586

8687

@@ -420,6 +421,92 @@ <h4 id="pyben.api.load" class="doc doc-heading">
420421

421422

422423

424+
<h4 id="pyben.api.loadinto" class="doc doc-heading">
425+
<code class="highlight language-python"><span class="n">loadinto</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="n">lst</span><span class="p">)</span></code>
426+
427+
428+
</h4>
429+
430+
<div class="doc doc-contents ">
431+
432+
<p>Shortcut function to load becoded data from file and store it in list.</p>
433+
<p>This function is most useful for multithreading purposes.</p>
434+
435+
<p><strong>Parameters:</strong></p>
436+
<table>
437+
<thead>
438+
<tr>
439+
<th>Name</th>
440+
<th>Type</th>
441+
<th>Description</th>
442+
<th>Default</th>
443+
</tr>
444+
</thead>
445+
<tbody>
446+
<tr>
447+
<td><code>buffer</code></td>
448+
<td><code>str</code></td>
449+
<td><p>string or open file buffer.</p></td>
450+
<td><em>required</em></td>
451+
</tr>
452+
<tr>
453+
<td><code>lst</code></td>
454+
<td><code>list</code></td>
455+
<td><p>variable to store output into</p></td>
456+
<td><em>required</em></td>
457+
</tr>
458+
</tbody>
459+
</table>
460+
<p><strong>Returns:</strong></p>
461+
<table>
462+
<thead>
463+
<tr>
464+
<th>Type</th>
465+
<th>Description</th>
466+
</tr>
467+
</thead>
468+
<tbody>
469+
<tr>
470+
<td></td>
471+
<td><p>the list containing the output.</p></td>
472+
</tr>
473+
</tbody>
474+
</table>
475+
<details class="quote">
476+
<summary>Source code in <code>pyben\api.py</code></summary>
477+
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">loadinto</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="n">lst</span><span class="p">):</span>
478+
<span class="sd">&quot;&quot;&quot;</span>
479+
<span class="sd"> Shortcut function to load becoded data from file and store it in list.</span>
480+
481+
<span class="sd"> This function is most useful for multithreading purposes.</span>
482+
483+
<span class="sd"> Parameters</span>
484+
<span class="sd"> ----------</span>
485+
<span class="sd"> buffer : str</span>
486+
<span class="sd"> string or open file buffer.</span>
487+
<span class="sd"> lst : list</span>
488+
<span class="sd"> variable to store output into</span>
489+
490+
<span class="sd"> Returns</span>
491+
<span class="sd"> -------</span>
492+
<span class="sd"> list :</span>
493+
<span class="sd"> the list containing the output.</span>
494+
<span class="sd"> &quot;&quot;&quot;</span>
495+
<span class="n">output</span> <span class="o">=</span> <span class="n">load</span><span class="p">(</span><span class="n">buffer</span><span class="p">)</span>
496+
<span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">output</span><span class="p">)</span>
497+
<span class="k">return</span> <span class="n">lst</span>
498+
</code></pre></div>
499+
</details>
500+
</div>
501+
502+
</div>
503+
504+
505+
506+
<div class="doc doc-object doc-function">
507+
508+
509+
423510
<h4 id="pyben.api.loads" class="doc doc-heading">
424511
<code class="highlight language-python"><span class="n">loads</span><span class="p">(</span><span class="n">encoded</span><span class="p">,</span> <span class="n">to_json</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
425512

@@ -3246,6 +3333,10 @@ <h3 id="decode-from-file">Decode from file:</h3>
32463333
<span class="mkapi-item-type">(`any` :)</span>
32473334
<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Load bencoded data from a file of path object and decodes it.</span></li>
32483335

3336+
<li class="function"><code class="mkapi-item-name">loadinto</code><code class="mkapi-object-parenthesis">(</code><code class="mkapi-object-signature">buffer</code>, <code class="mkapi-object-signature">lst</code><code class="mkapi-object-parenthesis">)</code>
3337+
<span class="mkapi-item-type">(list :)</span>
3338+
<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Shortcut function to load becoded data from file and store it in list.</span></li>
3339+
32493340
<li class="function"><code class="mkapi-item-name">loads</code><code class="mkapi-object-parenthesis">(</code><code class="mkapi-object-signature">encoded</code>, <code class="mkapi-object-signature">to_json</code><code class="mkapi-object-parenthesis">)</code>
32503341
<span class="mkapi-item-type">(any :)</span>
32513342
<span class="mkapi-item-dash">&mdash;</span> <span class="mkapi-item-description">Shortcut function for decoding encoded data.</span></li>
@@ -3584,6 +3675,92 @@ <h3 id="pyben.api.load" class="doc doc-heading">
35843675

35853676

35863677

3678+
<h3 id="pyben.api.loadinto" class="doc doc-heading">
3679+
<code class="highlight language-python"><span class="n">loadinto</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="n">lst</span><span class="p">)</span></code>
3680+
3681+
3682+
</h3>
3683+
3684+
<div class="doc doc-contents ">
3685+
3686+
<p>Shortcut function to load becoded data from file and store it in list.</p>
3687+
<p>This function is most useful for multithreading purposes.</p>
3688+
3689+
<p><strong>Parameters:</strong></p>
3690+
<table>
3691+
<thead>
3692+
<tr>
3693+
<th>Name</th>
3694+
<th>Type</th>
3695+
<th>Description</th>
3696+
<th>Default</th>
3697+
</tr>
3698+
</thead>
3699+
<tbody>
3700+
<tr>
3701+
<td><code>buffer</code></td>
3702+
<td><code>str</code></td>
3703+
<td><p>string or open file buffer.</p></td>
3704+
<td><em>required</em></td>
3705+
</tr>
3706+
<tr>
3707+
<td><code>lst</code></td>
3708+
<td><code>list</code></td>
3709+
<td><p>variable to store output into</p></td>
3710+
<td><em>required</em></td>
3711+
</tr>
3712+
</tbody>
3713+
</table>
3714+
<p><strong>Returns:</strong></p>
3715+
<table>
3716+
<thead>
3717+
<tr>
3718+
<th>Type</th>
3719+
<th>Description</th>
3720+
</tr>
3721+
</thead>
3722+
<tbody>
3723+
<tr>
3724+
<td></td>
3725+
<td><p>the list containing the output.</p></td>
3726+
</tr>
3727+
</tbody>
3728+
</table>
3729+
<details class="quote">
3730+
<summary>Source code in <code>pyben\api.py</code></summary>
3731+
<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">loadinto</span><span class="p">(</span><span class="n">buffer</span><span class="p">,</span> <span class="n">lst</span><span class="p">):</span>
3732+
<span class="sd">&quot;&quot;&quot;</span>
3733+
<span class="sd"> Shortcut function to load becoded data from file and store it in list.</span>
3734+
3735+
<span class="sd"> This function is most useful for multithreading purposes.</span>
3736+
3737+
<span class="sd"> Parameters</span>
3738+
<span class="sd"> ----------</span>
3739+
<span class="sd"> buffer : str</span>
3740+
<span class="sd"> string or open file buffer.</span>
3741+
<span class="sd"> lst : list</span>
3742+
<span class="sd"> variable to store output into</span>
3743+
3744+
<span class="sd"> Returns</span>
3745+
<span class="sd"> -------</span>
3746+
<span class="sd"> list :</span>
3747+
<span class="sd"> the list containing the output.</span>
3748+
<span class="sd"> &quot;&quot;&quot;</span>
3749+
<span class="n">output</span> <span class="o">=</span> <span class="n">load</span><span class="p">(</span><span class="n">buffer</span><span class="p">)</span>
3750+
<span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">output</span><span class="p">)</span>
3751+
<span class="k">return</span> <span class="n">lst</span>
3752+
</code></pre></div>
3753+
</details>
3754+
</div>
3755+
3756+
</div>
3757+
3758+
3759+
3760+
<div class="doc doc-object doc-function">
3761+
3762+
3763+
35873764
<h3 id="pyben.api.loads" class="doc doc-heading">
35883765
<code class="highlight language-python"><span class="n">loads</span><span class="p">(</span><span class="n">encoded</span><span class="p">,</span> <span class="n">to_json</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
35893766

@@ -6550,6 +6727,11 @@ <h3>Table Of Contents</h3>
65506727
<li><a href="#pyben.api.load">load()</a></li>
65516728
<ul>
65526729

6730+
</ul>
6731+
6732+
<li><a href="#pyben.api.loadinto">loadinto()</a></li>
6733+
<ul>
6734+
65536735
</ul>
65546736

65556737
<li><a href="#pyben.api.loads">loads()</a></li>
@@ -6816,6 +6998,11 @@ <h3>Table Of Contents</h3>
68166998
<li><a href="#pyben.api.load">load()</a></li>
68176999
<ul>
68187000

7001+
</ul>
7002+
7003+
<li><a href="#pyben.api.loadinto">loadinto()</a></li>
7004+
<ul>
7005+
68197006
</ul>
68207007

68217008
<li><a href="#pyben.api.loads">loads()</a></li>
@@ -7053,7 +7240,7 @@ <h3>Quick search</h3>
70537240

70547241
<!--
70557242
MkDocs version : 1.2.3
7056-
Docs Build Date UTC : 2022-03-17 20:14:29.968283+00:00
7243+
Docs Build Date UTC : 2022-04-24 00:10:52.574919+00:00
70577244
-->
70587245
</body>
70597246
</html>

‎docs/examples/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ <h3>Quick search</h3>
215215

216216
<!--
217217
MkDocs version : 1.2.3
218-
Docs Build Date UTC : 2022-03-17 20:14:30.055281+00:00
218+
Docs Build Date UTC : 2022-04-24 00:10:52.738852+00:00
219219
-->
220220
</body>
221221
</html>

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ <h3>Quick search</h3>
182182

183183
<!--
184184
MkDocs version : 1.2.3
185-
Docs Build Date UTC : 2022-03-17 20:14:29.962281+00:00
185+
Docs Build Date UTC : 2022-04-24 00:10:52.569695+00:00
186186
-->
187187
</body>
188188
</html>

‎docs/objects.inv‎

5 Bytes
Binary file not shown.

‎docs/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/sitemap.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://alexpdev.github.io/pyben/</loc>
5-
<lastmod>2022-03-17</lastmod>
5+
<lastmod>2022-04-24</lastmod>
66
<changefreq>daily</changefreq>
77
</url>
88
<url>
99
<loc>https://alexpdev.github.io/pyben/LICENSE/</loc>
10-
<lastmod>2022-03-17</lastmod>
10+
<lastmod>2022-04-24</lastmod>
1111
<changefreq>daily</changefreq>
1212
</url>
1313
<url>
1414
<loc>https://alexpdev.github.io/pyben/api/</loc>
15-
<lastmod>2022-03-17</lastmod>
15+
<lastmod>2022-04-24</lastmod>
1616
<changefreq>daily</changefreq>
1717
</url>
1818
<url>
1919
<loc>https://alexpdev.github.io/pyben/examples/</loc>
20-
<lastmod>2022-03-17</lastmod>
20+
<lastmod>2022-04-24</lastmod>
2121
<changefreq>daily</changefreq>
2222
</url>
2323
</urlset>

0 commit comments

Comments
 (0)