Merge branch '42-log-callback' into dev

Author: greenrobot

.gitlab-ci.yml

@@ -58,6 +58,13 @@ test:linux:aarch64:
 
 test:mac:x64:
   extends: .test
+  script:
+    - python3 -m venv .venv
+    - source .venv/bin/activate
+    - python3 -m pip install pytest
+    - rm -r objectbox  # todo this is ugly; let's copy required files in a sub-folder instead?
+    - pip3 install --force-reinstall dist/*.whl  # Artifacts from the previous stage (downloaded by default)
+    - python -m pytest
   tags: [mac, x64, shell, python3]
 
 test:windows:x64:

objectbox/c.py

@@ -84,6 +84,15 @@ def shlib_name(library: str) -> str:
 OBXValidateOnOpenPagesFlags = ctypes.c_int
 OBXValidateOnOpenKvFlags = ctypes.c_int
 OBXBackupRestoreFlags = ctypes.c_int
+OBXLogLevel = ctypes.c_int
+
+from enum import IntEnum
+class LogLevel(IntEnum):
+    Verbose = 10
+    Debug   = 20
+    Info    = 30
+    Warn    = 40
+    Error   = 50
 
 class DebugFlags(IntEnum):
     """Debug flags"""
@@ -563,8 +572,11 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 # OBX_C_API void obx_opt_async_object_bytes_max_size_to_cache(OBX_store_options* opt, uint64_t value);
 obx_opt_async_object_bytes_max_size_to_cache = c_fn('obx_opt_async_object_bytes_max_size_to_cache', None, [OBX_store_options_p, ctypes.c_uint64])
 
+#typedef void obx_log_callback(OBXLogLevel log_level, const char* message, size_t message_size, void* user_data);
+obx_log_callback_fn = ctypes.CFUNCTYPE(None, OBXLogLevel, ctypes.c_char_p, ctypes.c_size_t, ctypes.c_voidp)
+
 # OBX_C_API void obx_opt_log_callback(OBX_store_options* opt, obx_log_callback* callback, void* user_data);
-# obx_opt_log_callback = c_fn('obx_opt_log_callback', None, [OBX_store_options_p, ...]) TODO
+obx_opt_log_callback = c_fn('obx_opt_log_callback', None, [OBX_store_options_p, obx_log_callback_fn, ctypes.c_voidp])
 
 # OBX_C_API void obx_opt_backup_restore(OBX_store_options* opt, const char* backup_file, uint32_t flags);
 obx_opt_backup_restore = c_fn('obx_opt_backup_restore', None, [OBX_store_options_p, ctypes.c_char_p, OBXBackupRestoreFlags])

objectbox/store.py

@@ -55,6 +55,7 @@ def __init__(self,
                  async_minor_refill_max_count: Optional[int] = None,
                  async_object_bytes_max_cache_size: Optional[int] = None,
                  async_object_bytes_max_size_to_cache: Optional[int] = None,
+                 log_callback: Callable[[c.OBXLogLevel, str],None] = None,
                  c_store: Optional[c.OBX_store_p] = None):
 
         """Opens an ObjectBox database Store
@@ -118,6 +119,8 @@ def __init__(self,
             Total cache size. Defaults to 0.5 mega bytes.
         :param async_object_bytes_max_size_to_cache:
             Maximum size for an object to be cached.
+        :param log_callback:
+            Callback function for logging with the parameters, OBXLogLevel and message.
         :param c_store:
             Internal parameter for deprecated ObjectBox interface. Do not use it; other options would be ignored if passed.
         """
@@ -175,6 +178,8 @@ def __init__(self,
                     options.async_object_bytes_max_cache_size(async_object_bytes_max_cache_size)
                 if async_object_bytes_max_size_to_cache is not None:
                     options.async_object_bytes_max_size_to_cache(async_object_bytes_max_size_to_cache)
+                if log_callback is not None:
+                    options.log_callback(log_callback)
 
             except c.CoreException:
                 options._free()

objectbox/store_options.py

@@ -112,7 +112,10 @@ def async_object_bytes_max_cache_size(self, value: int):
     def async_object_bytes_max_size_to_cache(self, value: int):
         obx_opt_async_object_bytes_max_size_to_cache(self._c_handle, value)
 
-    # TODO def log_callback(self):
+    def log_callback(self, value: Callable[[OBXLogLevel, str],None]):
+        self._c_log_cb = obx_log_callback_fn(lambda level, message, size, userdata: value(level, message.decode('utf-8')))
+        obx_opt_log_callback(self._c_handle, self._c_log_cb, None)
+        return self
 
     def backup_restore(self, backup_file: str, flags: OBXBackupRestoreFlags):
         raise NotImplementedError  # TODO

tests/test_store_options.py

@@ -78,3 +78,30 @@ def test_store_with_options():
         async_object_bytes_max_size_to_cache=100<<10
     )
     store.close()
+
+def test_log_callback():
+    Store.remove_db_files("testdata")
+    remove_json_model_file()
+    
+    log_entries = []
+
+    def mylog(level: OBXLogLevel, message: str):
+        levelText = "?"
+        if level == LogLevel.Debug:
+            levelText = "DEBUG"
+        print(f"MYLOG: {levelText} {message}")
+        log_entries.append( (level, message) )        
+
+    store = Store(
+        model=create_default_model(),
+        directory="testdata",
+        log_callback=mylog
+    )
+    
+    box = store.box(TestEntity)
+    assert len(log_entries) == 2
+    assert log_entries[0][0] == LogLevel.Debug
+    assert log_entries[0][1].startswith("Opening store:")
+    assert log_entries[1][0] == LogLevel.Debug
+    assert log_entries[1][1].startswith("Opening store:")
+