python-jsonstore 1.2.0__tar.gz → 1.3.3__tar.gz

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

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          - "pypy-3.9"
+        exclude:
+          - os: windows-latest
+            python-version: "pypy-3.9"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install system dependencies
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zip p7zip-full
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install . pytest pytest-cov
+
+      - name: Run tests
+        run: pytest -vv --cov=jsonstore --cov-report=xml --junitxml=test-results.xml
+
+      - name: Upload coverage to Codecov
+        if: always() && env.CODECOV_TOKEN != ''
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ env.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          fail_ci_if_error: true
+
+      - name: Upload test results to Codecov
+        if: always() && env.CODECOV_TOKEN != ''
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ env.CODECOV_TOKEN }}
+          files: ./test-results.xml
+          report_type: test_results
+          fail_ci_if_error: true

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

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/python-jsonstore
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+      # the publishing uses PyPI's trusted publishing, so configured on pypi instead of using secrets
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

python_jsonstore-1.3.3/PKG-INFO

@@ -0,0 +1,152 @@
+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.2.0 → python_jsonstore-1.3.3}/README.rst

@@ -1,4 +1,4 @@
-|PyPi Package| |Build Status| |Codacy Rating|
+|PyPI| |Build Status| |Coverage Report|
 
 jsonstore
 =========
@@ -12,11 +12,8 @@ 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.3+. It will
-not work on 2.6 or lower, but is expected to work on 3.0-3.2. The tests
-do not work in 3.2.6 due to
-`mistreating <https://travis-ci.org/Code0x58/python-jsonstore/jobs/198150401>`__
-the 💩 when parsing the test code. This is also tested on pypy and pypy3.
+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
 --------
@@ -47,6 +44,8 @@ Basics
     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']
@@ -59,6 +58,25 @@ Basics
     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
 ~~~~~~~~~~~~
 
@@ -89,9 +107,10 @@ file until all of the transactions have been closed.
     # here we see the value that was saved previously
     assert store.value == 1
 
-.. |Build Status| image:: https://travis-ci.org/Code0x58/python-jsonstore.svg?branch=master
-   :target: https://travis-ci.org/Code0x58/python-jsonstore
-.. |Codacy Rating| image:: https://api.codacy.com/project/badge/Grade/37ea488773444de59469a3775be83faf
-   :target: https://www.codacy.com/app/evilumbrella-github/python-jsonstore?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Code0x58/python-jsonstore&amp;utm_campaign=Badge_Grade
-.. |PyPi Package| image:: https://badge.fury.io/py/python-jsonstore.svg
+
+.. |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.2.0 → python_jsonstore-1.3.3}/jsonstore.py

@@ -12,6 +12,13 @@ from copy import deepcopy
 
 __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
+
 
 class JsonStore(object):
     """A class to provide object based access to a JSON file"""
@@ -81,9 +88,10 @@ class JsonStore(object):
             raise AttributeError(key)
 
     @classmethod
-    def _valid_object(cls, obj, parents=None):
+    def _verify_object(cls, obj, parents=None):
         """
-        Determine if the object can be encoded into JSON
+        Raise an exception if the object is not suitable for assignment.
+
         """
         # pylint: disable=unicode-builtin,long-builtin
         if isinstance(obj, (dict, list)):
@@ -94,85 +102,100 @@ class JsonStore(object):
             parents.append(obj)
 
         if isinstance(obj, dict):
-            return all(
-                cls._valid_string(k) and cls._valid_object(v, parents)
-                for k, v in obj.items()
-            )
+            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)):
-            return all(cls._valid_object(o, parents) for o in obj)
+            for o in obj:
+                cls._verify_object(o, parents)
         else:
             return cls._valid_value(obj)
 
     @classmethod
     def _valid_value(cls, value):
-        if isinstance(value, (bool, int, float, type(None))):
-            return True
-        elif sys.version_info < (3,) and isinstance(value, long):
+        if isinstance(value, VALUE_TYPES):
             return True
         else:
             return cls._valid_string(value)
 
     @classmethod
     def _valid_string(cls, value):
-        if isinstance(value, str):
+        if isinstance(value, STRING_TYPES):
             return True
-        elif sys.version_info < (3,):
-            return isinstance(value, unicode)
         else:
             return False
 
-    def __setattr__(self, key, value):
-        if not self._valid_object(value):
-            raise AttributeError
-        self._data[key] = deepcopy(value)
+    @classmethod
+    def _canonical_key(cls, key):
+        """Convert a set/get/del key into the canonical form."""
+        if cls._valid_string(key):
+            return tuple(key.split("."))
+
+        if isinstance(key, (tuple, list)):
+            key = tuple(key)
+            if not key:
+                raise TypeError("key must be a string or non-empty tuple/list")
+            return key
+
+        raise TypeError("key must be a string or non-empty tuple/list")
+
+    def __setattr__(self, attr, value):
+        self._verify_object(value)
+        self._data[attr] = deepcopy(value)
         self._do_auto_commit()
 
-    def __delattr__(self, key):
-        del self._data[key]
+    def __delattr__(self, attr):
+        del self._data[attr]
 
-    def __get_obj(self, full_path):
-        """
-        Returns the object which is under the given path
-        """
-        if isinstance(full_path, (tuple, list)):
-            steps = full_path
-        else:
-            steps = full_path.split(".")
+    def __get_obj(self, steps):
+        """Returns the object which is under the given path."""
         path = []
         obj = self._data
-        if not full_path:
-            return obj
         for step in steps:
-            path.append(step)
+            if isinstance(obj, dict) and not self._valid_string(step):
+                # this is necessary because of the JSON serialisation
+                raise TypeError("%s is a dict and %s is not a string" % (path, step))
             try:
                 obj = obj[step]
-            except KeyError:
-                raise KeyError(".".join(path))
+            except (KeyError, IndexError, TypeError) as e:
+                raise type(e)("unable to get %s from %s: %s" % (step, path, e))
+            path.append(step)
         return obj
 
-    def __setitem__(self, name, value):
-        path, _, key = name.rpartition(".")
-        if self._valid_object(value):
-            dictionary = self.__get_obj(path)
-            dictionary[key] = deepcopy(value)
-            self._do_auto_commit()
-        else:
-            raise AttributeError
+    def __setitem__(self, key, value):
+        steps = self._canonical_key(key)
+        path, step = steps[:-1], steps[-1]
+        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)
+        except (IndexError, TypeError) as e:
+            raise type(e)("unable to set %s from %s: %s" % (step, path, e))
+        self._do_auto_commit()
 
     def __getitem__(self, key):
-        obj = self.__get_obj(key)
-        if obj is self._data:
-            raise KeyError
+        steps = self._canonical_key(key)
+        obj = self.__get_obj(steps)
         return deepcopy(obj)
 
-    def __delitem__(self, name):
-        if isinstance(name, (tuple, list)):
-            path = name[:-1]
-            key = name[-1]
-        else:
-            path, _, key = name.rpartition(".")
+    def __delitem__(self, key):
+        steps = self._canonical_key(key)
+        path, step = steps[:-1], steps[-1]
         obj = self.__get_obj(path)
-        del obj[key]
+        try:
+            del obj[step]
+        except (KeyError, IndexError, TypeError) as e:
+            raise type(e)("unable to delete %s from %s: %s" % (step, path, e))
 
     def __contains__(self, key):
-        return key in self._data
+        steps = self._canonical_key(key)
+        try:
+            self.__get_obj(steps)
+            return True
+        except (KeyError, IndexError, TypeError):
+            # this is rather permissive as the types are dynamic
+            return False

python_jsonstore-1.3.3/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=75", "setuptools_scm>=7", "wheel"]
+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 = ">=2.7"
+license = {text = "MIT"}
+authors = [
+    {name = "Oliver Bristow", email = "github+pypi@oliverbristow.co.uk"},
+]
+keywords = ["json", "key", "value", "store"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 2",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.3",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "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 :: 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"]
+license-files = ["LICENCE.md"]
+
+[tool.setuptools_scm]

python_jsonstore-1.3.3/python_jsonstore.egg-info/PKG-INFO

@@ -0,0 +1,152 @@
+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.2.0 → python_jsonstore-1.3.3}/python_jsonstore.egg-info/SOURCES.txt

@@ -1,10 +1,10 @@
-.travis.yml
 LICENCE.md
 README.rst
 jsonstore.py
-setup.cfg
-setup.py
+pyproject.toml
 test_jsonstore.py
+.github/workflows/ci.yml
+.github/workflows/publish.yml
 python_jsonstore.egg-info/PKG-INFO
 python_jsonstore.egg-info/SOURCES.txt
 python_jsonstore.egg-info/dependency_links.txt

{python-jsonstore-1.2.0 → python_jsonstore-1.3.3}/setup.cfg

@@ -1,6 +1,3 @@
-[bdist_wheel]
-universal = 1
-
 [egg_info]
 tag_build = 
 tag_date = 0

{python-jsonstore-1.2.0 → python_jsonstore-1.3.3}/test_jsonstore.py

@@ -105,19 +105,39 @@ class Tests(unittest.TestCase):
             self.assertRaises(KeyError, self._getitem(name))
             self.assertRaises(AttributeError, self._getattr(name))
 
+    def test_slices(self):
+        self.store.list = [1, 2, 3]
+        self.store["list", :2] = ["a", "b"]
+        self.assertEqual(self.store["list", 1:], ["b", 3])
+        del self.store["list", :1]
+        self.assertEqual(self.store.list, ["b", 3])
+
     def test_assign_invalid_types(self):
         for method in (self._setattr, self._setitem):
 
             def assign(value):
                 return method("key", value)
 
-            self.assertRaises(AttributeError, assign(set()))
-            self.assertRaises(AttributeError, assign(object()))
-            self.assertRaises(AttributeError, assign(None for i in range(2)))
+            self.assertRaises(TypeError, assign(set()))
+            self.assertRaises(TypeError, assign(object()))
+            self.assertRaises(TypeError, assign(None for i in range(2)))
+            self.assertRaises(TypeError, assign({1: 1}))
 
     def test_assign_bad_keys(self):
-        # FIXME: a ValueError would make more sense
-        self.assertRaises(AttributeError, self._setitem(1, 2))
+        value = 1
+        # the root object is a dict, so a string key is needed
+        self.assertRaises(TypeError, self._setitem(1, value))
+        self.assertRaises(TypeError, self._setitem((1, "a"), value))
+
+        self.store["dict"] = {}
+        self.store["list"] = []
+        self.assertRaises(TypeError, self._setitem((), value))
+        self.assertRaises(TypeError, self._setitem(("dict", 1), value))
+        self.assertRaises(TypeError, self._setitem(("dict", slice(1)), value))
+        self.assertRaises(TypeError, self._setitem(("list", "a"), value))
+        self.assertRaises(TypeError, self._setitem(("list", slice("a")), value))
+        self.assertRaises(IndexError, self._setitem(("list", 1), value))
+
 
     def test_retrieve_values(self):
         for name, value in self.TEST_DATA:
@@ -177,6 +197,7 @@ class Tests(unittest.TestCase):
         assert self.store[["list", 0, "key", -1]] == "last"
         self.assertRaises(TypeError, self._getitem("list.0.key.1"))
         assert len(self.store["list", 0, "key", 1:]) == 2
+        self.assertRaises(IndexError, self._getitem(("list", 1)))
 
     def test_del(self):
         self.store.key = None
@@ -187,6 +208,18 @@ class Tests(unittest.TestCase):
         del self.store["key"]
         self.assertRaises(KeyError, self._getitem("key"))
 
+        with self.assertRaises(KeyError):
+            del self.store["missing"]
+
+        self.store.list = []
+        with self.assertRaises(IndexError):
+            del self.store["list", 1]
+
+        self.store.dict = {}
+        # somewhere after python 3.9 this went from a TypeError to a KeyError
+        with self.assertRaises((TypeError, KeyError)):
+            del self.store["dict", slice("a")]
+
     def test_context_and_deserialisation(self):
         store_file = mktemp()
         for name, value in self.TEST_DATA:
@@ -284,6 +317,18 @@ class Tests(unittest.TestCase):
         with open(self._store_file) as handle:
             self.assertEqual(handle.read(), '{"value1": 1, "value2": 2}')
 
+    def test_list_concat_inplace(self):
+        self.store.list = []
+        extension = [{"key": "value"}]
+
+        # make sure += happens
+        self.store["list"] += extension
+        self.store.list += extension
+        self.assertEqual(self.store.list, extension * 2)
+
+        # make sure a deepcopy occurred
+        self.assertIsNot(self.store.list[0], extension[0])
+
 
 if __name__ == "__main__":
     unittest.main()

python-jsonstore-1.2.0/.travis.yml

@@ -1,26 +0,0 @@
-language: python
-
-jobs:
-  include:
-    - python: 3.8
-    - python: 3.7
-    - python: 3.6
-    - python: 3.5
-    - python: 3.4
-    - python: 2.7
-    - python: pypy3
-    - python: pypy
-    - name: "Python: 3.7"
-      os: osx
-      osx_image: xcode11.2  # Python 3.7.4 running on macOS 10.14.4
-      language: shell       # 'language: python' is an error on Travis CI macOS
-    - name: "Python: 3.8"
-      os: windows           # Windows 10.0.17134 N/A Build 17134
-      language: shell       # 'language: python' is an error on Travis CI Windows
-      before_install:
-        - choco install python --version 3.8.2
-        - python -m pip install --upgrade pip
-      env: PATH=/c/Python38:/c/Python38/Scripts:$PATH
-
-install: python -m pip install . pytest
-script: python -m pytest

python-jsonstore-1.2.0/PKG-INFO

@@ -1,126 +0,0 @@
-Metadata-Version: 2.1
-Name: python-jsonstore
-Version: 1.2.0
-Summary: UNKNOWN
-Home-page: https://github.com/Code0x58/python-jsonstore/
-Author: Oliver Bristow
-Author-email: github+pypi@oliverbristow.co.uk
-License: MIT
-Description: |PyPi Package| |Build Status| |Codacy Rating|
-        
-        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.3+. It will
-        not work on 2.6 or lower, but is expected to work on 3.0-3.2. The tests
-        do not work in 3.2.6 due to
-        `mistreating <https://travis-ci.org/Code0x58/python-jsonstore/jobs/198150401>`__
-        the 💩 when parsing the test code. This is also tested on pypy and pypy3.
-        
-        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
-        
-            # 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
-        
-        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://travis-ci.org/Code0x58/python-jsonstore.svg?branch=master
-           :target: https://travis-ci.org/Code0x58/python-jsonstore
-        .. |Codacy Rating| image:: https://api.codacy.com/project/badge/Grade/37ea488773444de59469a3775be83faf
-           :target: https://www.codacy.com/app/evilumbrella-github/python-jsonstore?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Code0x58/python-jsonstore&amp;utm_campaign=Badge_Grade
-        .. |PyPi Package| image:: https://badge.fury.io/py/python-jsonstore.svg
-           :target: https://pypi.org/project/python-jsonstore/
-        
-Keywords: json key value store
-Platform: UNKNOWN
-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 :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Topic :: Database
-Classifier: Topic :: Software Development
-Description-Content-Type: text/x-rst

python-jsonstore-1.2.0/python_jsonstore.egg-info/PKG-INFO

@@ -1,126 +0,0 @@
-Metadata-Version: 2.1
-Name: python-jsonstore
-Version: 1.2.0
-Summary: UNKNOWN
-Home-page: https://github.com/Code0x58/python-jsonstore/
-Author: Oliver Bristow
-Author-email: github+pypi@oliverbristow.co.uk
-License: MIT
-Description: |PyPi Package| |Build Status| |Codacy Rating|
-        
-        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.3+. It will
-        not work on 2.6 or lower, but is expected to work on 3.0-3.2. The tests
-        do not work in 3.2.6 due to
-        `mistreating <https://travis-ci.org/Code0x58/python-jsonstore/jobs/198150401>`__
-        the 💩 when parsing the test code. This is also tested on pypy and pypy3.
-        
-        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
-        
-            # 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
-        
-        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://travis-ci.org/Code0x58/python-jsonstore.svg?branch=master
-           :target: https://travis-ci.org/Code0x58/python-jsonstore
-        .. |Codacy Rating| image:: https://api.codacy.com/project/badge/Grade/37ea488773444de59469a3775be83faf
-           :target: https://www.codacy.com/app/evilumbrella-github/python-jsonstore?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Code0x58/python-jsonstore&amp;utm_campaign=Badge_Grade
-        .. |PyPi Package| image:: https://badge.fury.io/py/python-jsonstore.svg
-           :target: https://pypi.org/project/python-jsonstore/
-        
-Keywords: json key value store
-Platform: UNKNOWN
-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 :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Topic :: Database
-Classifier: Topic :: Software Development
-Description-Content-Type: text/x-rst

python-jsonstore-1.2.0/setup.py

@@ -1,46 +0,0 @@
-import codecs
-from os import path
-from textwrap import dedent
-
-from setuptools import setup
-
-here = path.abspath(path.dirname(__file__))
-
-with codecs.open(path.join(here, "README.rst"), encoding='utf-8') as f:
-    long_description = f.read()
-
-setup(
-    name='python-jsonstore',
-    use_scm_version=True,
-    description="",
-    long_description=long_description,
-    long_description_content_type='text/x-rst',
-    author="Oliver Bristow",
-    author_email='github+pypi@oliverbristow.co.uk',
-    license='MIT',
-    classifiers=dedent("""
-        Development Status :: 5 - Production/Stable
-        Intended Audience :: Developers
-        License :: OSI Approved :: MIT License
-        Operating System :: OS Independent
-        Programming Language :: Python :: 2
-        Programming Language :: Python :: 2.7
-        Programming Language :: Python :: 3
-        Programming Language :: Python :: 3.3
-        Programming Language :: Python :: 3.4
-        Programming Language :: Python :: 3.5
-        Programming Language :: Python :: 3.6
-        Programming Language :: Python :: 3.7
-        Programming Language :: Python :: 3.8
-        Programming Language :: Python :: Implementation :: CPython
-        Programming Language :: Python :: Implementation :: PyPy
-        Topic :: Database
-        Topic :: Software Development
-    """).strip().split('\n'),
-    keywords='json key value store',
-    url='https://github.com/Code0x58/python-jsonstore/',
-    py_modules=dedent("""
-        jsonstore
-    """).strip().split('\n'),
-    setup_requires=["setuptools_scm", "wheel"],
-)