Add class conv (#5)

* add pickle for class conversion

* fix lint

* Add NumpySmall

* rename representation to identifier and order to level.

* Update .gitignore

* update notebook with `znjson.config.ACTIVE_CONVERTER`

* revert: rename `representation` to `identifier`

Author: PythonFZ

.gitignore

@@ -1,4 +1,4 @@
 __pycache__/
 .idea
 .coverage
-znjson.egg-info/
+znjson.egg-info/

example/example.ipynb

@@ -17,16 +17,25 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "1. Register the required converter"
+    "1. You can register / deregister `znjson.converter`. By default all available converters will be registered."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 2,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "data": {
+      "text/plain": "[znjson.converter.small_numpy_converter.SmallNumpyConverter,\n znjson.converter.numpy_converter_base64.NumpyConverter,\n znjson.converter.pathlib_converter.PathlibConverter,\n znjson.converter.pandas_converter.PandasConverter,\n znjson.converter.numpy_converter_latin1.NumpyConverterLatin1,\n znjson.converter.class_converter.ClassConverter]"
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
-    "znjson.register(znjson.converter.SmallNumpyConverter)"
+    "znjson.config.ACTIVE_CONVERTER"
    ]
   },
   {
@@ -81,7 +90,11 @@
     }
    ],
    "source": [
-    "data_dump = json.dumps(obj=example_data, cls=znjson.ZnEncoder, indent=4)\n",
+    "data_dump = json.dumps(\n",
+    "    obj=example_data,\n",
+    "    cls=znjson.ZnEncoder,\n",
+    "    indent=4\n",
+    ")\n",
     "print(data_dump)"
    ]
   },

tests/converter/test_small_numpy_converter.py

@@ -11,6 +11,11 @@ def numpy_array():
     return np.arange(10)
 
 
+@pytest.fixture
+def numpy_array_large():
+    return np.arange(1000)
+
+
 @pytest.fixture
 def numpy_float_array():
     return np.arange(10).astype(float)
@@ -21,6 +26,11 @@ def test_encode(numpy_array):
     assert arr == '{"_type": "np.ndarray_small", "value": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]}'
 
 
+def test_encode_large(numpy_array_large):
+    arr = json.dumps(numpy_array_large, cls=znjson.ZnEncoder)
+    assert arr.startswith('{"_type": "np.ndarray64"')
+
+
 def test_encode_float(numpy_float_array):
     arr = json.dumps(numpy_float_array, cls=znjson.ZnEncoder)
     assert (

znjson/base.py

@@ -12,15 +12,15 @@ class ConverterBase(abc.ABC):
         the type of the object to convert, e.g. np.ndarray or pathlib.Path
     representation: str
         the name of the object to convert. should e.g. be `pathlib.Path`
-    order: int
-        The order in which the encoding should be applied. A higher number means this
-        is tried later. E.g. pickle should have a higher order using other serializers
+    level: int
+        The level in which the encoding should be applied. A higher number means it will
+        try this first. E.g. test small numpy conversion before pickle
         first.
     """
 
     instance: type = None
     representation: str = None
-    order: int = 0
+    level: int = 0
 
     @abc.abstractmethod
     def _encode(self, obj) -> str:
@@ -97,4 +97,4 @@ def __eq__(self, other) -> bool:
         return isinstance(other, self.instance)
 
     def __lt__(self, other: ConverterBase):
-        return self.order < other.order
+        return self.level < other.level

znjson/config.py

@@ -9,10 +9,13 @@ class Config:
     ACTIVE_CONVERTER: List[Type[ConverterBase]] = field(default_factory=list)
 
     def sort(self):
-        """Sort the ACTIVE_CONVERTER by their order"""
-        active_converters = set(self.ACTIVE_CONVERTER)
-        sort = sorted([x() for x in active_converters])
-        self.ACTIVE_CONVERTER = [type(x) for x in sort]
+        """Sort the ACTIVE_CONVERTER by their level
+
+        Start from high levels to low levels
+        """
+        active_converter = set(self.ACTIVE_CONVERTER)
+        active_converter = sorted([x() for x in active_converter], reverse=True)
+        self.ACTIVE_CONVERTER = [type(x) for x in active_converter]
 
 
 config = Config()

znjson/converter/class_converter.py

@@ -8,7 +8,7 @@
 class ClassConverter(ConverterBase):
     instance = object
     representation = "class"
-    order = 100
+    level = 0
 
     def _encode(self, obj):
         with io.BytesIO() as f:

znjson/converter/numpy_converter_base64.py

@@ -9,7 +9,7 @@
 class NumpyConverter(ConverterBase):
     instance = np.ndarray
     representation = "np.ndarray64"
-    order = 10
+    level = 30
 
     def _encode(self, obj):
         with io.BytesIO() as f:

znjson/converter/numpy_converter_latin1.py

@@ -10,7 +10,7 @@ class NumpyConverterLatin1(ConverterBase):
 
     instance = np.ndarray
     representation = "np.ndarray"
-    order = 999
+    level = 0
 
     def _encode(self, obj):
         with io.BytesIO() as f:

znjson/converter/pandas_converter.py

@@ -8,6 +8,7 @@
 class PandasConverter(ConverterBase):
     instance = pandas.DataFrame
     representation = "pandas.DataFrame"
+    level = 10
 
     def _encode(self, obj: pandas.DataFrame):
         with io.BytesIO() as f:

znjson/converter/pathlib_converter.py

@@ -6,6 +6,7 @@
 class PathlibConverter(ConverterBase):
     instance = pathlib.Path
     representation = "pathlib.Path"
+    level = 10
 
     def _encode(self, obj: pathlib.Path):
         return obj.as_posix()