python-jsonstore 1.3.3__py3-none-any.whl → 2.0.0__py3-none-any.whl

jsonstore.py

@@ -5,19 +5,16 @@ Provides a Python class that maps values to/from a JSON file
 """
 from __future__ import absolute_import
 import json
-import os.path
-import sys
+import os
+import stat
 from collections import OrderedDict
 from copy import deepcopy
+from tempfile import mkstemp
 
 __all__ = ["JsonStore"]
 
 STRING_TYPES = (str,)
-INT_TYPES = (int,)
-if sys.version_info < (3,):
-    STRING_TYPES += (unicode,)
-    INT_TYPES += (long,)
-VALUE_TYPES = (bool, int, float, type(None)) + INT_TYPES
+VALUE_TYPES = (bool, int, float, type(None))
 
 
 class JsonStore(object):
@@ -34,7 +31,11 @@ class JsonStore(object):
         if any(args):
             self.__dict__["_data"] = previous_state
         elif not self.__dict__["_states"]:
-            self._save()
+            try:
+                self._save()
+            except BaseException:
+                self.__dict__["_data"] = previous_state
+                raise
 
     def _do_auto_commit(self):
         if self._auto_commit and not self.__dict__["_states"]:
@@ -56,25 +57,39 @@ class JsonStore(object):
         self.__dict__["_data"] = data
 
     def _save(self):
-        temp = self._path + "~"
-        with open(temp, "wb") as store:
-            output = json.dumps(self._data, indent=self._indent)
-            store.write(output.encode("utf-8"))
-        
-        if sys.version_info >= (3, 3):
+        output = json.dumps(self._data, indent=self._indent).encode("utf-8")
+        try:
+            mode = stat.S_IMODE(os.stat(self._path).st_mode)
+        except FileNotFoundError:
+            mode = None
+        descriptor, temp = mkstemp(
+            prefix="." + os.path.basename(self._path) + ".",
+            suffix=".tmp",
+            dir=os.path.dirname(os.path.abspath(self._path)),
+        )
+        try:
+            with os.fdopen(descriptor, "wb") as store:
+                store.write(output)
+            if mode is not None:
+                os.chmod(temp, mode)
             os.replace(temp, self._path)
-        elif os.name == "windows":
-            os.remove(self._path)
-            os.rename(temp, self._path)
-        else:
-            os.rename(temp, self._path)
+        finally:
+            try:
+                os.unlink(temp)
+            except FileNotFoundError:
+                pass
+            except PermissionError:
+                if os.name != "nt":
+                    raise
+                os.chmod(temp, stat.S_IWRITE)
+                os.unlink(temp)
 
     def __init__(self, path, indent=2, auto_commit=True):
         self.__dict__.update(
             {
                 "_auto_commit": auto_commit,
                 "_data": None,
-                "_path": path,
+                "_path": os.fsdecode(path),
                 "_indent": indent,
                 "_states": [],
             }
@@ -93,25 +108,26 @@ class JsonStore(object):
         Raise an exception if the object is not suitable for assignment.
 
         """
-        # pylint: disable=unicode-builtin,long-builtin
-        if isinstance(obj, (dict, list)):
+        if isinstance(obj, (dict, list, tuple)):
             if parents is None:
-                parents = []
-            elif any(o is obj for o in parents):
-                raise ValueError("Cycle detected in list/dictionary")
-            parents.append(obj)
-
-        if isinstance(obj, dict):
-            for k, v in obj.items():
-                if not cls._valid_string(k):
-                    # this is necessary because of the JSON serialisation
-                    raise TypeError("a dict has non-string keys")
-                cls._verify_object(v, parents)
-        elif isinstance(obj, (list, tuple)):
-            for o in obj:
-                cls._verify_object(o, parents)
-        else:
-            return cls._valid_value(obj)
+                parents = set()
+            identity = id(obj)
+            if identity in parents:
+                raise ValueError("Cycle detected in list/dictionary/tuple")
+            parents.add(identity)
+            try:
+                if isinstance(obj, dict):
+                    for key, value in obj.items():
+                        if not cls._valid_string(key):
+                            raise TypeError("a dict has non-string keys")
+                        cls._verify_object(value, parents)
+                else:
+                    for value in obj:
+                        cls._verify_object(value, parents)
+            finally:
+                parents.remove(identity)
+        elif not cls._valid_value(obj):
+            raise TypeError("unsupported JSON value type: %s" % type(obj).__name__)
 
     @classmethod
     def _valid_value(cls, value):
@@ -143,11 +159,14 @@ class JsonStore(object):
 
     def __setattr__(self, attr, value):
         self._verify_object(value)
-        self._data[attr] = deepcopy(value)
+        value = deepcopy(value)
+        self._verify_object(value)
+        self._data[attr] = value
         self._do_auto_commit()
 
     def __delattr__(self, attr):
         del self._data[attr]
+        self._do_auto_commit()
 
     def __get_obj(self, steps):
         """Returns the object which is under the given path."""
@@ -168,11 +187,13 @@ class JsonStore(object):
         steps = self._canonical_key(key)
         path, step = steps[:-1], steps[-1]
         self._verify_object(value)
+        value = deepcopy(value)
+        self._verify_object(value)
         container = self.__get_obj(path)
         if isinstance(container, dict) and not self._valid_string(step):
             raise TypeError("%s is a dict and %s is not a string" % (path, step))
         try:
-            container[step] = deepcopy(value)
+            container[step] = value
         except (IndexError, TypeError) as e:
             raise type(e)("unable to set %s from %s: %s" % (step, path, e))
         self._do_auto_commit()
@@ -190,6 +211,7 @@ class JsonStore(object):
             del obj[step]
         except (KeyError, IndexError, TypeError) as e:
             raise type(e)("unable to delete %s from %s: %s" % (step, path, e))
+        self._do_auto_commit()
 
     def __contains__(self, key):
         steps = self._canonical_key(key)

python_jsonstore-2.0.0.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: python-jsonstore
+Version: 2.0.0
+Summary: Map JSON files onto Python attributes for simple configuration storage
+Author-email: Oliver Bristow <github+pypi@oliverbristow.co.uk>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Code0x58/python-jsonstore/
+Keywords: json,key,value,store
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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 :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENCE.md
+Dynamic: license-file
+
+|PyPI| |Build Status| |Coverage Report|
+
+jsonstore
+=========
+
+``JsonStore`` maps a JSON object's keys to Python attributes. Use it to
+load and save configuration containing nested dictionaries and lists.
+
+Requires Python 3.9 or newer. Tests run on CPython 3.9–3.15 and PyPy 3.11.
+
+Examples
+--------
+
+Install with ``pip install python-jsonstore``.
+
+Basics
+~~~~~~
+
+.. code:: python
+
+    from jsonstore import JsonStore
+
+    # Assignments and deletions are saved automatically.
+    store = JsonStore("config.json")
+    store.message = "hello"
+    store.options = {"enabled": True, "greeting": "💐"}
+    store.numbers = [1, 2, 3]
+    assert "message" in store
+    del store.message
+
+    # Dot-separated keys traverse dictionaries.
+    store["options.enabled"] = False
+    assert store["options", "enabled"] is False
+
+    # Tuple or list paths also accept list indices and slices.
+    assert store["numbers", -1] == 3
+    assert store[["numbers", 1]] == 2
+    del store["numbers", :2]
+    assert store.numbers == [3]
+
+    # A one-element tuple addresses a literal key containing a dot.
+    store[("literal.key",)] = "value"
+
+Reads and assignments use deep copies. To update a stored collection,
+assign the modified value back; ``+=`` also does this:
+
+.. code:: python
+
+    store.numbers.append(4)
+    assert store.numbers == [3]
+    store.numbers += [4, 5]
+    assert store.numbers == [3, 4, 5]
+
+Use item access for keys that conflict with ``JsonStore`` attributes.
+``indent`` controls JSON formatting and defaults to 2; use ``None`` for
+compact output. ``auto_commit=False`` defers saving until a transaction
+commits.
+
+Transactions
+~~~~~~~~~~~~
+
+Use ``with store:`` to group changes into a transaction. Transactions may
+be nested; only successful exit from the outermost transaction saves the
+file. An exception in a transaction restores its previous state, including
+when saving fails.
+
+.. code:: python
+
+    from jsonstore import JsonStore
+
+    with JsonStore("config.json", indent=None, auto_commit=False) as store:
+        store.value = 1
+    assert JsonStore("config.json").value == 1
+
+    try:
+        with store:
+            store.value = 2
+            with store:
+                store.value = 3
+            raise ValueError("cancel the transaction")
+    except ValueError:
+        pass
+    assert store.value == 1
+    assert JsonStore("config.json").value == 1
+
+Transactions provide in-memory rollback, with no locking or coordination
+between writers. Use one writer per file; separate stores do not reload
+each other's changes. Atomic replacement does not guarantee durability
+across a power failure.
+
+.. |Build Status| image:: https://github.com/Code0x58/python-jsonstore/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/Code0x58/python-jsonstore/actions/workflows/ci.yml
+.. |PyPI| image:: https://img.shields.io/pypi/v/python-jsonstore.svg
+   :target: https://pypi.org/project/python-jsonstore/
+.. |Coverage Report| image:: https://codecov.io/gh/Code0x58/python-jsonstore/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/Code0x58/python-jsonstore

python_jsonstore-2.0.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+jsonstore.py,sha256=9P6hCPeB92dfnSgfdoO2PzcvzxlzBsf836D7bFNIk5c,7334
+python_jsonstore-2.0.0.dist-info/licenses/LICENCE.md,sha256=CYFsxv7F0RTimJ83xSWkMtR8audySdDV_z9XzTr2EP0,1071
+python_jsonstore-2.0.0.dist-info/METADATA,sha256=sc9XZ8fOju_A3_x0Abus8ywKuDj9_dpyCqEi01I-x5I,4290
+python_jsonstore-2.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_jsonstore-2.0.0.dist-info/top_level.txt,sha256=5Lr-ZZ_07h17JRcT8M4FAt5aEkwAMHNGZuVHNC7yZ5w,10
+python_jsonstore-2.0.0.dist-info/RECORD,,

{python_jsonstore-1.3.3.dist-info → python_jsonstore-2.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

python_jsonstore-1.3.3.dist-info/METADATA

@@ -1,152 +0,0 @@
-Metadata-Version: 2.4
-Name: python-jsonstore
-Version: 1.3.3
-Summary: Map JSON files onto Python attributes for simple configuration storage
-Author-email: Oliver Bristow <github+pypi@oliverbristow.co.uk>
-License: MIT
-Project-URL: Homepage, https://github.com/Code0x58/python-jsonstore/
-Keywords: json,key,value,store
-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 :: 2
-Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-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 :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Topic :: Database
-Classifier: Topic :: Software Development
-Requires-Python: >=2.7
-Description-Content-Type: text/x-rst
-License-File: LICENCE.md
-Dynamic: license-file
-
-|PyPI| |Build Status| |Coverage Report|
-
-jsonstore
-=========
-
-This module provides a class that maps keys and values from a JSON file
-onto its attributes.
-
-The goal was to provide a convenient way of loading and saving
-configuration in a familiar human readable format. This is a bit more
-flexible than the
-`configparser <https://docs.python.org/3/library/configparser.html>`__
-module which is included with Python.
-
-This works is tested and working on Python 2.7 and Python 3.6+. It will
-not work on 2.6 or lower. The tests are also executed on PyPy.
-
-Examples
---------
-
-Basics
-~~~~~~
-
-.. code:: python
-
-    # by default JsonStore commits on every change unless in a transaction
-    store = JsonStore('config.json')
-    store.a_string = "something"
-    store.a_list = [1, 2, 3]
-    store.a_dictionary = {
-      'dict-list': [{}],
-      'ln(2)': 0.69314718056,
-      'for-you': u"💐",
-    }
-
-    # you can use […] to set/get/delete string keys
-    store['some_key'] = "a value"
-    # the key is split on '.'s and works on dictionaries
-    del store['a_dictionary.dict-list']
-    store['a_dictionary.new_value'] = "old value"
-    #  you can also use the syntactic sugar for tuple keys (explicit lists work too)
-    assert store['a_dictionary', 'new_value'] == "old value"
-    # you can traverse lists too
-    assert store['a_list', -1] == 3
-    # you can use slices in lists
-    assert len(store['a_list', 1:]) == 2
-    del store['a_list', :2]
-    assert store.a_list == [3]
-
-    # deep copies are made when assigning values
-    my_list = ['fun']
-    store.a_list = my_list
-    assert store.a_list is not my_list
-    assert 'a_list' in store
-
-    # deep copies are also returned to avoid unsanitary changes being made
-    store.a_dictionary['new_value'] = "new value"  # won't update the store!
-    assert store.a_dictionary['new_value'] == "old value"
-    assert store.a_dictionary is not store.a_dictionary
-
-    # Appending to, extending a list
-    >>> store.list = [1, 2, 3]
-
-    # Because of the fact that .append won't modify the list in the actual file,
-    # but only a copy...
-    >>> store.list.append(4)
-    >>> store.list
-    [1, 2, 3]
-
-    # ... we need to rather use the += operator to append to a list.
-    >>> store.list += [4]
-    >>> store.list
-    [1, 2, 3, 4]
-
-    # Similarly, we can extend the list
-    >>> store.list += [5, 6]
-    >>> store.list
-    [1, 2, 3, 4, 5, 6]
-
-Transactions
-~~~~~~~~~~~~
-
-``JsonStore`` objects can be used as `context
-managers <https://www.python.org/dev/peps/pep-0343/>`__ to provide
-transactions which are rolled back in the event of an exception. The
-transaction model is primitive; you can only nest transactions.
-
-While a store is put into a transaction, it will not save changes to
-file until all of the transactions have been closed.
-
-.. code:: python
-
-    from jsonstore import JsonStore
-
-    # even with auto_commit=True, the file won't be saved until the last contexts has been closed
-    with JsonStore('config.json', indent=None, auto_commit=False) as store:
-      self.value = 1
-
-    # the context manager will roll back changes made if an exception is raised
-    store = JsonStore('config.json', indent=None)
-    try:
-      with store:
-        store.value = "new"
-        raise Exception
-    except Exception:
-      pass
-    # here we see the value that was saved previously
-    assert store.value == 1
-
-
-.. |Build Status| image:: https://github.com/Code0x58/python-jsonstore/actions/workflows/ci.yml/badge.svg
-   :target: https://github.com/Code0x58/python-jsonstore/actions/workflows/ci.yml
-.. |PyPI| image:: https://img.shields.io/pypi/v/python-jsonstore.svg
-   :target: https://pypi.org/project/python-jsonstore/
-.. |Coverage Report| image:: https://codecov.io/gh/Code0x58/python-jsonstore/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/Code0x58/python-jsonstore

python_jsonstore-1.3.3.dist-info/RECORD

@@ -1,6 +0,0 @@
-jsonstore.py,sha256=YGCPCsjTnklMHR_neqgbcV6ltQh5A5QKW4rbOQzzXJk,6511
-python_jsonstore-1.3.3.dist-info/licenses/LICENCE.md,sha256=CYFsxv7F0RTimJ83xSWkMtR8audySdDV_z9XzTr2EP0,1071
-python_jsonstore-1.3.3.dist-info/METADATA,sha256=yxS-sej7Mi05NMnx9Zrz3gkLVtIlA8uXpPVBD1Dpbpc,5434
-python_jsonstore-1.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_jsonstore-1.3.3.dist-info/top_level.txt,sha256=5Lr-ZZ_07h17JRcT8M4FAt5aEkwAMHNGZuVHNC7yZ5w,10
-python_jsonstore-1.3.3.dist-info/RECORD,,