kev/deadsimplekv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added documentation, docs and gitignore

Browse Source
This commit is contained in:
Kevin Froman 2019-03-01 10:40:49 -06:00
parent 0149aa0bc7
commit d673495177
5 changed files with 441 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
venv/*
deadsimplekv/__pycache__/*

5
Makefile
View File

@ -1,2 +1,7 @@
test:
./run_tests.sh
docs:
rm -rf docs
pdoc3 --html --html-dir docs deadsimplekv
.PHONY: docs

34
deadsimplekv/__init__.py
View File

@ -17,7 +17,7 @@
'''
import json, time, math, os
def is_serializable(data):
def _is_serializable(data):
try:
json.dumps(data)
return True
@ -40,35 +40,40 @@ class DeadSimpleKV:
self._last_refresh = temp_time # time last refreshed from disk
self._last_flush = temp_time # time last flushed to disk
if os.path.exists(file_path):
self.refresh()
try:
if os.path.exists(file_path):
self.refresh()
except TypeError:
pass
def get(self, key):
if self.refresh_seconds is not None and self.file_path is not None:
self.refresh()
self._do_auto_refresh()
try:
return self._data[key]
except KeyError:
return None
def put(self, key, value):
'''Value setter. Will automatically flush if auto_flush is True and file_path is not None'''
'''Value setter. Will automatically flush if auto_flush is True and file_path is not None
Will return value error if either key or value are not JSON serializable
'''
self._data[key] = value # Set the key
# Check if key and value can be put in JSON
if not is_serializable(key):
if not _is_serializable(key):
raise ValueError('%s is not JSON serializable' % (key,))
if not is_serializable(value):
if not _is_serializable(value):
raise ValueError('%s is not JSON serializable' % (value,))
self._do_auto_flush()
return (key, value)
def delete(self, key):
'''Deletes value. Will automatically flush if auto_flush is True and file_path is not None'''
del self._data[key]
self._do_auto_flush()
def refresh(self):
'''Refresh data and then mark time read'''
'''Refresh data and then mark time read. Can be manually called'''
try:
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
except FileNotFoundError:
@ -76,17 +81,22 @@ class DeadSimpleKV:
self._last_refresh = DeadSimpleKV._get_epoch()
def flush(self):
'''Write out then mark time flushed'''
'''Write out then mark time flushed. Can be manually called'''
DeadSimpleKV._write_out(self.file_path, json.dumps(self._data))
self._last_flush = DeadSimpleKV._get_epoch()
def _do_auto_flush(self):
if self.flush_seconds is not None and self.file_path is not None:
# flush if automatic and it is time to do so
temp_time = DeadSimpleKV._get_epoch()
if temp_time - self._last_flush >= self.flush_seconds:
if DeadSimpleKV._get_epoch() - self._last_flush >= self.flush_seconds:
self.flush()
def _do_auto_refresh(self):
if self.refresh_seconds is not None and self.file_path is not None:
# refresh if automatic and time to do so
if DeadSimpleKV._get_epoch() - self._last_refresh >= self.refresh_seconds:
self.refresh()
@staticmethod
def _get_epoch():
return math.floor(time.time())

410
docs/deadsimplekv/index.html Normal file
View File

@ -0,0 +1,410 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.5.2" />
<title>deadsimplekv API documentation</title>
<meta name="description" content="DeadSimpleKv. An extremely simple key-value storage system with cache
Copyright (C) 2019 Kevin Froman …" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.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%}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{font-weight:bold}#index h4 + ul{margin-bottom:.6em}#index .two-column{column-count:2}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}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.name small{font-weight:normal}.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{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{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%}.admonition{padding:.1em .5em}.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>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#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>
<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>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title"><code>deadsimplekv</code> module</h1>
</header>
<section id="section-intro">
<p>DeadSimpleKv. An extremely simple key-value storage system with cache
Copyright (C) 2019 Kevin Froman</p>
<p>This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the
GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with this program.
If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
DeadSimpleKv. An extremely simple key-value storage system with cache
Copyright (C) 2019 Kevin Froman
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
&#39;&#39;&#39;
import json, time, math, os
def _is_serializable(data):
try:
json.dumps(data)
return True
except TypeError:
return False
class DeadSimpleKV:
def __init__(self, file_path=None, refresh_seconds=0, flush_seconds=0):
&#39;&#39;&#39;
Accepts a file path and refresh.
If file_path is not set, no data will be written to disk.
Refresh is an integer specifying how many seconds should pass before data is re-read from disk.
If refresh_seconds or flush_seconds are set to None they will not be done automatically
&#39;&#39;&#39;
temp_time = DeadSimpleKV._get_epoch() # Initialization time
self.file_path = file_path # The file path where we write our data in JSON format
self.refresh_seconds = refresh_seconds # How often to refresh the
self.flush_seconds = flush_seconds # How often to flush out when setting
self._data = {} # The key store (in memory)
self._last_refresh = temp_time # time last refreshed from disk
self._last_flush = temp_time # time last flushed to disk
try:
if os.path.exists(file_path):
self.refresh()
except TypeError:
pass
def get(self, key):
self._do_auto_refresh()
try:
return self._data[key]
except KeyError:
return None
def put(self, key, value):
&#39;&#39;&#39;Value setter. Will automatically flush if auto_flush is True and file_path is not None
Will return value error if either key or value are not JSON serializable
&#39;&#39;&#39;
self._data[key] = value # Set the key
# Check if key and value can be put in JSON
if not _is_serializable(key):
raise ValueError(&#39;%s is not JSON serializable&#39; % (key,))
if not _is_serializable(value):
raise ValueError(&#39;%s is not JSON serializable&#39; % (value,))
self._do_auto_flush()
return (key, value)
def delete(self, key):
&#39;&#39;&#39;Deletes value. Will automatically flush if auto_flush is True and file_path is not None&#39;&#39;&#39;
del self._data[key]
self._do_auto_flush()
def refresh(self):
&#39;&#39;&#39;Refresh data and then mark time read. Can be manually called&#39;&#39;&#39;
try:
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
except FileNotFoundError:
pass
self._last_refresh = DeadSimpleKV._get_epoch()
def flush(self):
&#39;&#39;&#39;Write out then mark time flushed. Can be manually called&#39;&#39;&#39;
DeadSimpleKV._write_out(self.file_path, json.dumps(self._data))
self._last_flush = DeadSimpleKV._get_epoch()
def _do_auto_flush(self):
if self.flush_seconds is not None and self.file_path is not None:
# flush if automatic and it is time to do so
if DeadSimpleKV._get_epoch() - self._last_flush &gt;= self.flush_seconds:
self.flush()
def _do_auto_refresh(self):
if self.refresh_seconds is not None and self.file_path is not None:
# refresh if automatic and time to do so
if DeadSimpleKV._get_epoch() - self._last_refresh &gt;= self.refresh_seconds:
self.refresh()
@staticmethod
def _get_epoch():
return math.floor(time.time())
@staticmethod
def _write_out(file_path, data):
&#39;&#39;&#39;Write out the raw data&#39;&#39;&#39;
with open(file_path, &#39;w&#39;) as write_file:
write_file.write(data)
@staticmethod
def _read_in(file_path):
&#39;&#39;&#39;Read in raw data&#39;&#39;&#39;
with open(file_path, &#39;r&#39;) as read_file:
return read_file.read()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="deadsimplekv.DeadSimpleKV"><code class="flex name class">
<span>class <span class="ident">DeadSimpleKV</span></span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">class DeadSimpleKV:
def __init__(self, file_path=None, refresh_seconds=0, flush_seconds=0):
&#39;&#39;&#39;
Accepts a file path and refresh.
If file_path is not set, no data will be written to disk.
Refresh is an integer specifying how many seconds should pass before data is re-read from disk.
If refresh_seconds or flush_seconds are set to None they will not be done automatically
&#39;&#39;&#39;
temp_time = DeadSimpleKV._get_epoch() # Initialization time
self.file_path = file_path # The file path where we write our data in JSON format
self.refresh_seconds = refresh_seconds # How often to refresh the
self.flush_seconds = flush_seconds # How often to flush out when setting
self._data = {} # The key store (in memory)
self._last_refresh = temp_time # time last refreshed from disk
self._last_flush = temp_time # time last flushed to disk
try:
if os.path.exists(file_path):
self.refresh()
except TypeError:
pass
def get(self, key):
self._do_auto_refresh()
try:
return self._data[key]
except KeyError:
return None
def put(self, key, value):
&#39;&#39;&#39;Value setter. Will automatically flush if auto_flush is True and file_path is not None
Will return value error if either key or value are not JSON serializable
&#39;&#39;&#39;
self._data[key] = value # Set the key
# Check if key and value can be put in JSON
if not _is_serializable(key):
raise ValueError(&#39;%s is not JSON serializable&#39; % (key,))
if not _is_serializable(value):
raise ValueError(&#39;%s is not JSON serializable&#39; % (value,))
self._do_auto_flush()
return (key, value)
def delete(self, key):
&#39;&#39;&#39;Deletes value. Will automatically flush if auto_flush is True and file_path is not None&#39;&#39;&#39;
del self._data[key]
self._do_auto_flush()
def refresh(self):
&#39;&#39;&#39;Refresh data and then mark time read. Can be manually called&#39;&#39;&#39;
try:
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
except FileNotFoundError:
pass
self._last_refresh = DeadSimpleKV._get_epoch()
def flush(self):
&#39;&#39;&#39;Write out then mark time flushed. Can be manually called&#39;&#39;&#39;
DeadSimpleKV._write_out(self.file_path, json.dumps(self._data))
self._last_flush = DeadSimpleKV._get_epoch()
def _do_auto_flush(self):
if self.flush_seconds is not None and self.file_path is not None:
# flush if automatic and it is time to do so
if DeadSimpleKV._get_epoch() - self._last_flush &gt;= self.flush_seconds:
self.flush()
def _do_auto_refresh(self):
if self.refresh_seconds is not None and self.file_path is not None:
# refresh if automatic and time to do so
if DeadSimpleKV._get_epoch() - self._last_refresh &gt;= self.refresh_seconds:
self.refresh()
@staticmethod
def _get_epoch():
return math.floor(time.time())
@staticmethod
def _write_out(file_path, data):
&#39;&#39;&#39;Write out the raw data&#39;&#39;&#39;
with open(file_path, &#39;w&#39;) as write_file:
write_file.write(data)
@staticmethod
def _read_in(file_path):
&#39;&#39;&#39;Read in raw data&#39;&#39;&#39;
with open(file_path, &#39;r&#39;) as read_file:
return read_file.read()</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="deadsimplekv.DeadSimpleKV.__init__"><code class="name flex">
<span>def <span class="ident">__init__</span></span>(<span>self, file_path=None, refresh_seconds=0, flush_seconds=0)</span>
</code></dt>
<dd>
<section class="desc"><p>Accepts a file path and refresh.
If file_path is not set, no data will be written to disk.
Refresh is an integer specifying how many seconds should pass before data is re-read from disk.
If refresh_seconds or flush_seconds are set to None they will not be done automatically</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def __init__(self, file_path=None, refresh_seconds=0, flush_seconds=0):
&#39;&#39;&#39;
Accepts a file path and refresh.
If file_path is not set, no data will be written to disk.
Refresh is an integer specifying how many seconds should pass before data is re-read from disk.
If refresh_seconds or flush_seconds are set to None they will not be done automatically
&#39;&#39;&#39;
temp_time = DeadSimpleKV._get_epoch() # Initialization time
self.file_path = file_path # The file path where we write our data in JSON format
self.refresh_seconds = refresh_seconds # How often to refresh the
self.flush_seconds = flush_seconds # How often to flush out when setting
self._data = {} # The key store (in memory)
self._last_refresh = temp_time # time last refreshed from disk
self._last_flush = temp_time # time last flushed to disk
try:
if os.path.exists(file_path):
self.refresh()
except TypeError:
pass</code></pre>
</details>
</dd>
<dt id="deadsimplekv.DeadSimpleKV.delete"><code class="name flex">
<span>def <span class="ident">delete</span></span>(<span>self, key)</span>
</code></dt>
<dd>
<section class="desc"><p>Deletes value. Will automatically flush if auto_flush is True and file_path is not None</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def delete(self, key):
&#39;&#39;&#39;Deletes value. Will automatically flush if auto_flush is True and file_path is not None&#39;&#39;&#39;
del self._data[key]
self._do_auto_flush()</code></pre>
</details>
</dd>
<dt id="deadsimplekv.DeadSimpleKV.flush"><code class="name flex">
<span>def <span class="ident">flush</span></span>(<span>self)</span>
</code></dt>
<dd>
<section class="desc"><p>Write out then mark time flushed. Can be manually called</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def flush(self):
&#39;&#39;&#39;Write out then mark time flushed. Can be manually called&#39;&#39;&#39;
DeadSimpleKV._write_out(self.file_path, json.dumps(self._data))
self._last_flush = DeadSimpleKV._get_epoch()</code></pre>
</details>
</dd>
<dt id="deadsimplekv.DeadSimpleKV.get"><code class="name flex">
<span>def <span class="ident">get</span></span>(<span>self, key)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def get(self, key):
self._do_auto_refresh()
try:
return self._data[key]
except KeyError:
return None</code></pre>
</details>
</dd>
<dt id="deadsimplekv.DeadSimpleKV.put"><code class="name flex">
<span>def <span class="ident">put</span></span>(<span>self, key, value)</span>
</code></dt>
<dd>
<section class="desc"><p>Value setter. Will automatically flush if auto_flush is True and file_path is not None
Will return value error if either key or value are not JSON serializable</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def put(self, key, value):
&#39;&#39;&#39;Value setter. Will automatically flush if auto_flush is True and file_path is not None
Will return value error if either key or value are not JSON serializable
&#39;&#39;&#39;
self._data[key] = value # Set the key
# Check if key and value can be put in JSON
if not _is_serializable(key):
raise ValueError(&#39;%s is not JSON serializable&#39; % (key,))
if not _is_serializable(value):
raise ValueError(&#39;%s is not JSON serializable&#39; % (value,))
self._do_auto_flush()
return (key, value)</code></pre>
</details>
</dd>
<dt id="deadsimplekv.DeadSimpleKV.refresh"><code class="name flex">
<span>def <span class="ident">refresh</span></span>(<span>self)</span>
</code></dt>
<dd>
<section class="desc"><p>Refresh data and then mark time read. Can be manually called</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def refresh(self):
&#39;&#39;&#39;Refresh data and then mark time read. Can be manually called&#39;&#39;&#39;
try:
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
except FileNotFoundError:
pass
self._last_refresh = DeadSimpleKV._get_epoch()</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="deadsimplekv.DeadSimpleKV" href="#deadsimplekv.DeadSimpleKV">DeadSimpleKV</a></code></h4>
<ul class="two-column">
<li><code><a title="deadsimplekv.DeadSimpleKV.__init__" href="#deadsimplekv.DeadSimpleKV.__init__">__init__</a></code></li>
<li><code><a title="deadsimplekv.DeadSimpleKV.delete" href="#deadsimplekv.DeadSimpleKV.delete">delete</a></code></li>
<li><code><a title="deadsimplekv.DeadSimpleKV.flush" href="#deadsimplekv.DeadSimpleKV.flush">flush</a></code></li>
<li><code><a title="deadsimplekv.DeadSimpleKV.get" href="#deadsimplekv.DeadSimpleKV.get">get</a></code></li>
<li><code><a title="deadsimplekv.DeadSimpleKV.put" href="#deadsimplekv.DeadSimpleKV.put">put</a></code></li>
<li><code><a title="deadsimplekv.DeadSimpleKV.refresh" href="#deadsimplekv.DeadSimpleKV.refresh">refresh</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.2</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>

2
setup.py
View File

@ -1,7 +1,7 @@
from distutils.core import setup
setup(name='deadsimplekv',
version='0.0.0',
version='0.0.1',
description='Very simple key-value store for Python',
author='Kevin Froman',
author_email='beardog@firemail.cc',