added flush at exit
This commit is contained in:
Kevin Froman
parent
e8d989189f
commit
0e46b49e9c
@ -10,7 +10,7 @@ It doesn't do anything crazy. It just takes json serializable data and stores it
|
||||
|
||||
You can control when and where to read/write, and that's it.
|
||||
|
||||
No bloat, only 3 public methods.
|
||||
No bloat, only 5 public methods.
|
||||
|
||||
## Usage
|
||||
|
||||
@ -43,4 +43,4 @@ kv.get('my_key') # returns True.
|
||||
kv.delete('my_key')
|
||||
~~~
|
||||
|
||||
***Warning:*** **Be sure to manually flush when destroying the kv instance (such as by exiting your program) to avoid losing data, as flushes only happen when .put has been called.**
|
||||
***Warning:*** **Be sure to keep flush_on_exit set to true or manually flush when destroying the kv instance (such as by exiting your program) to avoid losing data.**
|
||||
@ -15,7 +15,7 @@
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
'''
|
||||
import json, time, math, os
|
||||
import json, time, math, os, atexit
|
||||
|
||||
def _is_serializable(data):
|
||||
'''
|
||||
@ -28,12 +28,12 @@ def _is_serializable(data):
|
||||
return False
|
||||
|
||||
class DeadSimpleKV:
|
||||
def __init__(self, file_path=None, refresh_seconds=0, flush_seconds=0):
|
||||
def __init__(self, file_path=None, refresh_seconds=0, flush_seconds=0, flush_on_exit=True):
|
||||
'''
|
||||
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
|
||||
If refresh_seconds or flush_seconds are set to None they will not be done automatically (except where flush_on_exit applies)
|
||||
'''
|
||||
temp_time = DeadSimpleKV._get_epoch() # Initialization time
|
||||
self.file_path = file_path # The file path where we write our data in JSON format
|
||||
@ -48,6 +48,9 @@ class DeadSimpleKV:
|
||||
self.refresh()
|
||||
except TypeError:
|
||||
pass
|
||||
|
||||
if flush_on_exit:
|
||||
atexit.register(self.flush)
|
||||
|
||||
def get(self, key):
|
||||
'''
|
||||
|
||||
@ -3,14 +3,14 @@
|
||||
<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" />
|
||||
<meta name="generator" content="pdoc 0.5.3" />
|
||||
<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>.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}@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}.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{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%}.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>
|
||||
@ -57,6 +57,9 @@ If not, see <a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses
|
||||
import json, time, math, os
|
||||
|
||||
def _is_serializable(data):
|
||||
'''
|
||||
Test if something is able to be in JSON format
|
||||
'''
|
||||
try:
|
||||
json.dumps(data)
|
||||
return True
|
||||
@ -86,6 +89,9 @@ class DeadSimpleKV:
|
||||
pass
|
||||
|
||||
def get(self, key):
|
||||
'''
|
||||
Accepts key, which must be json serializable
|
||||
'''
|
||||
self._do_auto_refresh()
|
||||
try:
|
||||
return self._data[key]
|
||||
@ -93,8 +99,9 @@ class DeadSimpleKV:
|
||||
return None
|
||||
|
||||
def put(self, key, value):
|
||||
'''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
|
||||
'''
|
||||
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
|
||||
|
||||
@ -107,12 +114,16 @@ class DeadSimpleKV:
|
||||
return (key, value)
|
||||
|
||||
def delete(self, key):
|
||||
'''Deletes value. Will automatically flush if auto_flush is True and file_path is not None'''
|
||||
'''
|
||||
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. Can be manually called'''
|
||||
'''
|
||||
Refresh data and then mark time read. Can be manually called
|
||||
'''
|
||||
try:
|
||||
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
|
||||
except FileNotFoundError:
|
||||
@ -120,7 +131,9 @@ class DeadSimpleKV:
|
||||
self._last_refresh = DeadSimpleKV._get_epoch()
|
||||
|
||||
def flush(self):
|
||||
'''Write out then mark time flushed. Can be manually called'''
|
||||
'''
|
||||
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()
|
||||
|
||||
@ -131,8 +144,8 @@ class DeadSimpleKV:
|
||||
self.flush()
|
||||
|
||||
def _do_auto_refresh(self):
|
||||
# Automatically flush if it is enabled and time to do so
|
||||
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()
|
||||
|
||||
@ -192,6 +205,9 @@ class DeadSimpleKV:
|
||||
pass
|
||||
|
||||
def get(self, key):
|
||||
'''
|
||||
Accepts key, which must be json serializable
|
||||
'''
|
||||
self._do_auto_refresh()
|
||||
try:
|
||||
return self._data[key]
|
||||
@ -199,8 +215,9 @@ class DeadSimpleKV:
|
||||
return None
|
||||
|
||||
def put(self, key, value):
|
||||
'''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
|
||||
'''
|
||||
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
|
||||
|
||||
@ -213,12 +230,16 @@ class DeadSimpleKV:
|
||||
return (key, value)
|
||||
|
||||
def delete(self, key):
|
||||
'''Deletes value. Will automatically flush if auto_flush is True and file_path is not None'''
|
||||
'''
|
||||
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. Can be manually called'''
|
||||
'''
|
||||
Refresh data and then mark time read. Can be manually called
|
||||
'''
|
||||
try:
|
||||
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
|
||||
except FileNotFoundError:
|
||||
@ -226,7 +247,9 @@ class DeadSimpleKV:
|
||||
self._last_refresh = DeadSimpleKV._get_epoch()
|
||||
|
||||
def flush(self):
|
||||
'''Write out then mark time flushed. Can be manually called'''
|
||||
'''
|
||||
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()
|
||||
|
||||
@ -237,8 +260,8 @@ class DeadSimpleKV:
|
||||
self.flush()
|
||||
|
||||
def _do_auto_refresh(self):
|
||||
# Automatically flush if it is enabled and time to do so
|
||||
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()
|
||||
|
||||
@ -300,7 +323,9 @@ If refresh_seconds or flush_seconds are set to None they will not be done automa
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def delete(self, key):
|
||||
'''Deletes value. Will automatically flush if auto_flush is True and file_path is not None'''
|
||||
'''
|
||||
Deletes value. Will automatically flush if auto_flush is True and file_path is not None
|
||||
'''
|
||||
del self._data[key]
|
||||
self._do_auto_flush()</code></pre>
|
||||
</details>
|
||||
@ -313,7 +338,9 @@ If refresh_seconds or flush_seconds are set to None they will not be done automa
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def flush(self):
|
||||
'''Write out then mark time flushed. Can be manually called'''
|
||||
'''
|
||||
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()</code></pre>
|
||||
</details>
|
||||
@ -322,10 +349,13 @@ If refresh_seconds or flush_seconds are set to None they will not be done automa
|
||||
<span>def <span class="ident">get</span></span>(<span>self, key)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"></section>
|
||||
<section class="desc"><p>Accepts key, which must be json serializable</p></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def get(self, key):
|
||||
'''
|
||||
Accepts key, which must be json serializable
|
||||
'''
|
||||
self._do_auto_refresh()
|
||||
try:
|
||||
return self._data[key]
|
||||
@ -342,8 +372,9 @@ Will return value error if either key or value are not JSON serializable</p></se
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def put(self, key, value):
|
||||
'''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
|
||||
'''
|
||||
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
|
||||
|
||||
@ -364,7 +395,9 @@ Will return value error if either key or value are not JSON serializable</p></se
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def refresh(self):
|
||||
'''Refresh data and then mark time read. Can be manually called'''
|
||||
'''
|
||||
Refresh data and then mark time read. Can be manually called
|
||||
'''
|
||||
try:
|
||||
self._data = json.loads(DeadSimpleKV._read_in(self.file_path))
|
||||
except FileNotFoundError:
|
||||
@ -402,7 +435,7 @@ Will return value error if either key or value are not JSON serializable</p></se
|
||||
</nav>
|
||||
</main>
|
||||
<footer id="footer">
|
||||
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.2</a>.</p>
|
||||
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.3</a>.</p>
|
||||
</footer>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
||||
<script>hljs.initHighlightingOnLoad()</script>
|
||||
|
||||
6
setup.py
6
setup.py
@ -1,10 +1,10 @@
|
||||
from distutils.core import setup
|
||||
|
||||
setup(name='deadsimplekv-beardog',
|
||||
version='0.0.1',
|
||||
setup(name='deadsimplekv',
|
||||
version='0.1.1',
|
||||
description='Very simple key-value store for Python',
|
||||
author='Kevin Froman',
|
||||
author_email='beardog@firemail.cc',
|
||||
author_email='beardog@mailbox.org',
|
||||
url='https://github.com/beardog108/deadsimplekv',
|
||||
packages=['deadsimplekv'],
|
||||
)
|
||||
|
||||
@ -23,6 +23,7 @@ def get_test_id():
|
||||
return str(uuid.uuid4()) + '.dat'
|
||||
|
||||
class TestInit(unittest.TestCase):
|
||||
|
||||
def test_init(self):
|
||||
kv = deadsimplekv.DeadSimpleKV(get_test_id())
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user