Skip to content

Commit 1b9af0d

Browse files
hakiKhuvahakiKhuva
committed
added docs
1 parent a5831b0 commit 1b9af0d

File tree

7 files changed

+4377
-0
lines changed

7 files changed

+4377
-0
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
__pycache__/
12
build/
23
dist/
34
pexicdb.egg-info/

‎docs/core.html‎

Lines changed: 2209 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/fields.html‎

Lines changed: 1273 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/functions.html‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.10.0" />
7+
<title>pexicdb.functions API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>pexicdb.functions</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<details class="source">
26+
<summary>
27+
<span>Expand source code</span>
28+
</summary>
29+
<pre><code class="python">import os
30+
import time
31+
from .helpers import encode, get_current_container_name
32+
from .core import PexicdbCursor
33+
34+
35+
def __create_fresh(name: str):
36+
&#34;&#34;&#34;
37+
create fresh directory and file structure
38+
39+
Arguments:
40+
`name`: name of the container
41+
&#34;&#34;&#34;
42+
43+
# create directory of the name
44+
os.mkdir(name)
45+
46+
# create data file
47+
# data files contains the name of the container and the triggers&#39; function
48+
with open(os.path.join(name, &#34;datafile&#34;), &#34;wb&#34;) as f:
49+
f.write(encode({
50+
&#34;name&#34;: name,
51+
}))
52+
53+
# create container file
54+
with open(os.path.join(name, f&#34;container-{time.time()}&#34;), &#34;wb&#34;) as f:
55+
pass
56+
57+
58+
def connect(name: str, model: list, *args, **kwargs) -&gt; PexicdbCursor:
59+
&#34;&#34;&#34;
60+
connect to the container using the name and you have to provide a model
61+
that is passed to the cursor.
62+
63+
`connect` function&#39;s main work is to create the container if it does not exists
64+
and create the cursor with all file pointers and return it.
65+
66+
67+
Arguments:
68+
`name`: container name
69+
70+
`model`: model of the list containing fields
71+
72+
Returns:
73+
returns the PexicdbCursor object to the container
74+
&#34;&#34;&#34;
75+
# if container not found or not exists
76+
if os.path.exists(name) is not True or os.path.isdir(name) is not True:
77+
# create new one
78+
__create_fresh(name)
79+
80+
return PexicdbCursor(
81+
name,
82+
model,
83+
open(os.path.join(name, &#34;datafile&#34;), &#34;rb+&#34;),
84+
open(get_current_container_name(name), &#34;rb+&#34;),
85+
*args,
86+
**kwargs
87+
)</code></pre>
88+
</details>
89+
</section>
90+
<section>
91+
</section>
92+
<section>
93+
</section>
94+
<section>
95+
<h2 class="section-title" id="header-functions">Functions</h2>
96+
<dl>
97+
<dt id="pexicdb.functions.connect"><code class="name flex">
98+
<span>def <span class="ident">connect</span></span>(<span>name: str, model: list, *args, **kwargs) ‑> <a title="pexicdb.core.PexicdbCursor" href="core.html#pexicdb.core.PexicdbCursor">PexicdbCursor</a></span>
99+
</code></dt>
100+
<dd>
101+
<div class="desc"><p>connect to the container using the name and you have to provide a model
102+
that is passed to the cursor.</p>
103+
<p><code><a title="pexicdb.functions.connect" href="#pexicdb.functions.connect">connect()</a></code> function's main work is to create the container if it does not exists
104+
and create the cursor with all file pointers and return it.</p>
105+
<h2 id="arguments">Arguments</h2>
106+
<p><code>name</code>: container name</p>
107+
<p><code>model</code>: model of the list containing fields</p>
108+
<h2 id="returns">Returns</h2>
109+
<p>returns the PexicdbCursor object to the container</p></div>
110+
<details class="source">
111+
<summary>
112+
<span>Expand source code</span>
113+
</summary>
114+
<pre><code class="python">def connect(name: str, model: list, *args, **kwargs) -&gt; PexicdbCursor:
115+
&#34;&#34;&#34;
116+
connect to the container using the name and you have to provide a model
117+
that is passed to the cursor.
118+
119+
`connect` function&#39;s main work is to create the container if it does not exists
120+
and create the cursor with all file pointers and return it.
121+
122+
123+
Arguments:
124+
`name`: container name
125+
126+
`model`: model of the list containing fields
127+
128+
Returns:
129+
returns the PexicdbCursor object to the container
130+
&#34;&#34;&#34;
131+
# if container not found or not exists
132+
if os.path.exists(name) is not True or os.path.isdir(name) is not True:
133+
# create new one
134+
__create_fresh(name)
135+
136+
return PexicdbCursor(
137+
name,
138+
model,
139+
open(os.path.join(name, &#34;datafile&#34;), &#34;rb+&#34;),
140+
open(get_current_container_name(name), &#34;rb+&#34;),
141+
*args,
142+
**kwargs
143+
)</code></pre>
144+
</details>
145+
</dd>
146+
</dl>
147+
</section>
148+
<section>
149+
</section>
150+
</article>
151+
<nav id="sidebar">
152+
<h1>Index</h1>
153+
<div class="toc">
154+
<ul></ul>
155+
</div>
156+
<ul id="index">
157+
<li><h3>Super-module</h3>
158+
<ul>
159+
<li><code><a title="pexicdb" href="index.html">pexicdb</a></code></li>
160+
</ul>
161+
</li>
162+
<li><h3><a href="#header-functions">Functions</a></h3>
163+
<ul class="">
164+
<li><code><a title="pexicdb.functions.connect" href="#pexicdb.functions.connect">connect</a></code></li>
165+
</ul>
166+
</li>
167+
</ul>
168+
</nav>
169+
</main>
170+
<footer id="footer">
171+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
172+
</footer>
173+
</body>
174+
</html>

0 commit comments

Comments
 (0)