json-store 4.1__py3-none-any.whl

json_store/__init__.py

@@ -0,0 +1,5 @@
+from .json_store import JSONStore
+
+__version__ = "4.1"
+
+open = JSONStore

json_store/json_store.py

@@ -0,0 +1,90 @@
+# encoding: utf-8
+"""A JSON store to use in place of shelve. Unicode keys, FTW!
+
+This is for small stores. Everything is in memory and sync() always writes
+everything out to disk.
+"""
+import json
+import os
+from collections.abc import MutableMapping
+from tempfile import NamedTemporaryFile
+
+__all__ = ["JSONStore"]
+
+MODE_600 = int("600", 8)
+
+
+class JSONStore(MutableMapping):
+    def __init__(self, path, json_kw=None, mode=MODE_600):
+        """Create a JSONStore object backed by the file at `path`.
+
+        If a dict is passed in as `json_kw`, it will be used as keyword
+        arguments to the json module.
+        """
+        self.path = path
+        self.json_kw = json_kw or {}
+        self.mode = mode
+
+        self._data = {}
+
+        self._synced_json_kw = None
+        self._needs_sync = False
+
+        if not os.path.exists(path):
+            self.sync(force=True)  # write empty dict to disk
+            return
+
+        # load the whole store
+        with open(path, "r") as fp:
+            self.update(json.load(fp))
+
+    def __getitem__(self, key):
+        return self._data[key]
+
+    def __setitem__(self, key, value):
+        self._data[key] = value
+        self._needs_sync = True
+
+    def __delitem__(self, key):
+        del self._data[key]
+        self._needs_sync = True
+
+    def keys(self):
+        return self._data.keys()
+
+    def __iter__(self):
+        return iter(self._data)
+
+    def __len__(self):
+        return len(self._data)
+
+    def _mktemp(self):
+        prefix = os.path.basename(self.path) + "."
+        dirname = os.path.dirname(self.path)
+        return NamedTemporaryFile(mode="w", prefix=prefix, dir=dirname, delete=False)
+
+    def sync(self, json_kw=None, force=False):
+        """Atomically write the entire store to disk if it's changed.
+
+        If a dict is passed in as `json_kw`, it will be used as keyword
+        arguments to the json module.
+
+        If force is set True, a new file will be written even if the store
+        hasn't changed since last sync.
+        """
+        json_kw = json_kw or self.json_kw
+        if self._synced_json_kw != json_kw:
+            self._needs_sync = True
+
+        if not (self._needs_sync or force):
+            return False
+
+        with self._mktemp() as fp:
+            json.dump(self._data, fp, **json_kw)
+        if self.mode != MODE_600:  # _mktemp uses 0600 by default
+            os.chmod(fp.name, self.mode)
+        os.replace(fp.name, self.path)
+
+        self._synced_json_kw = json_kw
+        self._needs_sync = False
+        return True

json_store/shelve2json.py

@@ -0,0 +1,42 @@
+#! /usr/bin/env python
+# encoding: utf-8
+"""Naïvely create a json_store file from a shelve DB."""
+
+import os
+import sys
+import shelve
+
+import json_store
+
+
+def convert(oldfile: str):
+    if not os.path.isfile(oldfile):
+        raise ValueError("No such file: {}".format(oldfile))
+
+    name = oldfile
+    # remove extensions that are implicitly added by the underlying DBM module
+    name = name.rsplit(".dat")[0]  # Windows
+    name = name.rsplit(".db")[0]  # macOS
+
+    data = shelve.open(name)
+    newfile = name + ".json"
+    store = json_store.open(newfile)
+    store.update(data)
+    store.sync()
+
+
+def main(argv=sys.argv):
+    if len(argv) < 2:
+        print("Usage: {0[0]} <shelve.db>".format(sys.argv))
+        return 1
+
+    try:
+        convert(argv[1])
+    except Exception as e:
+        print(str(e), file=sys.stderr)
+        return 1
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

json_store-4.1.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.3
+Name: json-store
+Version: 4.1
+Summary: A shelve-like store using JSON serialization.
+Project-URL: Homepage, https://github.com/brainsik/json-store
+Project-URL: Repository, https://github.com/brainsik/json-store.git
+Project-URL: Issues, https://github.com/brainsik/json-store/issues
+Project-URL: Changelog, https://github.com/brainsik/json-store/releases
+Author-email: jeremy avnet <json-store@theory.org>
+License: Copyright (c) 2010-2024 Jeremy Avnet
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+License-File: LICENSE.txt
+Keywords: json,shelve
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+[![json-store](https://github.com/brainsik/json-store/actions/workflows/main.yml/badge.svg)](https://github.com/brainsik/json-store/actions/workflows/main.yml)
+![PyPI](https://img.shields.io/pypi/v/json-store)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/json-store)
+
+# JSON Store
+
+JSON store is a simple replacement for shelve. It writes JSON serialized files,
+accepts unicode keys, and tracks whether the store has been changed since last
+sync. It has no dependencies.
+
+JSON store is intended for smaller stores. Everything is kept in memory and `sync()`
+writes the whole store to disk.
+
+For issues and development, see:
+
+https://github.com/brainsik/json-store

json_store-4.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+json_store/__init__.py,sha256=CN4YZ7ExdI603zBDfHshBRqJEUJ5vik630Tin3nkfdQ,73
+json_store/json_store.py,sha256=4HkIRYTIiBI9FYnXTMLqI5taOeaf-aiXNro_BD_vV7k,2538
+json_store/shelve2json.py,sha256=SQVs-6rFcTeyKFF-R4E32paMb9yOMn5bts2spp0s6o4,909
+json_store-4.1.dist-info/METADATA,sha256=Hz75FfVpwO_mOBvCPFn3lXaUQI9Pd930-1_PUbxDzRo,3130
+json_store-4.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+json_store-4.1.dist-info/entry_points.txt,sha256=yuGm6KJT2rMFFV_Cy7fU8wc6mIt4a1UypNkNTaLcp2g,60
+json_store-4.1.dist-info/licenses/LICENSE.txt,sha256=_AHzh2pqgHGGB_7VPIlfLxo0C9VORfV4eoev9CeSCCw,1061
+json_store-4.1.dist-info/RECORD,,

json_store-4.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

json_store-4.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+shelve2json = json_store.shelve2json:main

json_store-4.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2010-2024 Jeremy Avnet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.