python-jsonstore 1.3.0__tar.gz → 2.0.0__tar.gz

python_jsonstore-2.0.0/.coveragerc

@@ -0,0 +1,4 @@
+[paths]
+source =
+    .
+    */site-packages

python_jsonstore-2.0.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      github-actions:
+        patterns:
+          - "*"

python_jsonstore-2.0.0/.github/workflows/ci.yml

@@ -0,0 +1,180 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository and version tags
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.15"
+
+      - name: Build and check distributions
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build --sdist --wheel
+          python -m twine check --strict dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: distributions
+          path: dist/*
+          if-no-files-found: error
+
+  tests:
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          - "3.15"
+          - "pypy3.11"
+        exclude:
+          - os: windows-latest
+            python-version: "pypy3.11"
+    steps:
+      - name: Check out tests
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Download distributions
+        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: distributions
+          path: dist
+
+      - name: Install wheel and test dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --no-cache-dir dist/*.whl pytest pytest-cov
+          mkdir -p "$RUNNER_TEMP/installed-tests"
+          cp test_jsonstore.py "$RUNNER_TEMP/installed-tests/"
+
+      - name: Test installed wheel outside the checkout
+        working-directory: ${{ runner.temp }}/installed-tests
+        run: |
+          python -I -c 'import jsonstore; print(jsonstore.__file__)'
+          python -I -m pytest -vv --cov=jsonstore --cov-report= --junitxml=test-results.xml
+
+      - name: Map installed coverage to repository paths
+        run: |
+          python -m coverage combine "$RUNNER_TEMP/installed-tests/.coverage"
+          python -m coverage xml -o "$RUNNER_TEMP/installed-tests/coverage.xml"
+
+      - name: Build and install wheel from source distribution
+        run: |
+          python -m pip uninstall --yes python-jsonstore
+          python -m pip install --no-cache-dir dist/*.tar.gz
+
+      - name: Test installed source distribution outside the checkout
+        working-directory: ${{ runner.temp }}/installed-tests
+        run: |
+          python -I -c 'import jsonstore; print(jsonstore.__file__)'
+          python -I -m pytest -vv
+
+      - name: Upload test reports
+        if: always() && matrix.python-version == '3.15'
+        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: test-reports-${{ matrix.os }}
+          path: |
+            ${{ runner.temp }}/installed-tests/coverage.xml
+            ${{ runner.temp }}/installed-tests/test-results.xml
+          if-no-files-found: warn
+
+  reports:
+    if: ${{ !cancelled() && github.event_name != 'release' }}
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check whether Codecov is configured
+        id: codecov
+        env:
+          ENABLED: ${{ secrets.CODECOV_TOKEN != '' }}
+        run: echo "enabled=$ENABLED" >> "$GITHUB_OUTPUT"
+
+      - name: Check out repository for report paths
+        if: steps.codecov.outputs.enabled == 'true'
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Download test reports
+        id: reports
+        continue-on-error: ${{ needs.tests.result != 'success' }}
+        if: steps.codecov.outputs.enabled == 'true'
+        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          pattern: test-reports-*
+          path: reports
+
+      - name: Find available test reports
+        id: files
+        if: steps.codecov.outputs.enabled == 'true'
+        run: |
+          python3 - <<'PYTHON'
+          import glob
+          import os
+
+          with open(os.environ["GITHUB_OUTPUT"], "a") as output:
+              for name, pattern in (("coverage", "reports/*/coverage.xml"),
+                                    ("tests", "reports/*/test-results.xml")):
+                  output.write(f"{name}={','.join(sorted(glob.glob(pattern)))}\n")
+          PYTHON
+
+      - name: Upload coverage to Codecov
+        if: steps.files.outputs.coverage != ''
+        uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ${{ steps.files.outputs.coverage }}
+          disable_search: true
+          fail_ci_if_error: true
+
+      - name: Upload test results to Codecov
+        if: steps.files.outputs.tests != ''
+        uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ${{ steps.files.outputs.tests }}
+          report_type: test_results
+          disable_search: true
+          fail_ci_if_error: true

python_jsonstore-2.0.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  validate:
+    uses: ./.github/workflows/ci.yml
+
+  publish:
+    needs: validate
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/python-jsonstore
+    permissions:
+      id-token: write
+    steps:
+      - name: Download validated distributions
+        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: distributions
+          path: dist
+
+      # Keep publishing in this workflow for the existing PyPI Trusted Publisher.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

python_jsonstore-2.0.0/PKG-INFO

@@ -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/README.rst

@@ -0,0 +1,96 @@
+|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-1.3.0 → python_jsonstore-2.0.0}/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/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=77.0.3", "setuptools_scm>=7"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python-jsonstore"
+description = "Map JSON files onto Python attributes for simple configuration storage"
+readme = "README.rst"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENCE.md"]
+authors = [
+    {name = "Oliver Bristow", email = "github+pypi@oliverbristow.co.uk"},
+]
+keywords = ["json", "key", "value", "store"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Topic :: Database",
+    "Topic :: Software Development",
+]
+dependencies = []
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/Code0x58/python-jsonstore/"
+
+[tool.setuptools]
+py-modules = ["jsonstore"]
+
+[tool.setuptools_scm]