Renaming to improve self-descriptiveness.

1. GLOG defaults (log_dir=None) to outputing to color-enhanced std::cerr
2. Specifying valid log_dir changes the mode to logging
3. Context manager renamed from verbose to syclinterface_diagnostic

Test updated.

Author: oleksandr-pavlyk

.flake8

@@ -13,7 +13,7 @@ exclude =
     .git
 
 per-file-ignores =
-    dpctl/_dev.pyx: E999
+    dpctl/_diagnostics.pyx: E999
     dpctl/_sycl_context.pyx: E999, E225, E227
     dpctl/_sycl_device.pyx: E999, E225
     dpctl/_sycl_device_factory.pyx: E999, E225

dpctl/_dev.pyx renamed to dpctl/_diagnostics.pyx

@@ -29,49 +29,52 @@ cdef extern from "syclinterface/dpctl_service.h":
    cdef void DPCTLService_ShutdownLogger()
 
 
-def init_logger(log_dir=None):
+def _init_logger(log_dir=None):
     """Initialize logger to use given directory to save logs.
 
     The call has no effect if `dpctl` was not built to use logger.
     """
     cdef bytes p = b""
     cdef const char *app_name = "dpctl"
-    if log_dir is None:
-        log_dir = os.getcwd()
-    if not os.path.exists(log_dir):
-        raise ValueError(f"Path {log_dir} does not exist")
-    if isinstance(log_dir, str):
-        p = bytes(log_dir, "utf-8")
-    else:
-        p = bytes(log_dir)
-    DPCTLService_InitLogger(app_name, <char *>p)
+    cdef char *ld_cstr = NULL
+    if log_dir:
+        if not os.path.exists(log_dir):
+            raise ValueError(f"Path {log_dir} does not exist")
+        if isinstance(log_dir, str):
+            p = bytes(log_dir, "utf-8")
+        else:
+            p = bytes(log_dir)
+        ld_cstr = <char *>p
+    DPCTLService_InitLogger(app_name, ld_cstr)
 
 
-def fini_logger():
-    """Finilize logger.
+def _shutdown_logger():
+    """Finalize logger.
 
     The call has no effect if `dpctl` was not built to use logger.
     """
     DPCTLService_ShutdownLogger()
 
 
 @contextlib.contextmanager
-def verbose(verbosity="warning", log_dir=None):
-    """Context manager that activate verbosity"""
+def syclinterface_diagnostics(verbosity="warning", log_dir=None):
+    """Context manager that activate verbosity of DPCTLSyclInterface
+    function calls.
+    """
     _allowed_verbosity = ["warning", "error"]
     if not verbosity in _allowed_verbosity:
         raise ValueError(
             f"Verbosity argument not understood. "
             f"Permitted values are {_allowed_verbosity}"
         )
-    init_logger(log_dir=log_dir)
-    _saved = os.environ.get("DPCTL_VERBOSITY", None)
+    _init_logger(log_dir=log_dir)
+    _saved_verbosity = os.environ.get("DPCTL_VERBOSITY", None)
     os.environ["DPCTL_VERBOSITY"] = verbosity
     try:
         yield
     finally:
-        fini_logger()
-        if _saved:
-            os.environ["DPCTL_VERBOSITY"] = _saved
+        _shutdown_logger()
+        if _saved_verbosity:
+            os.environ["DPCTL_VERBOSITY"] = _saved_verbosity
         else:
             del os.environ["DPCTL_VERBOSITY"]

dpctl/tests/test_service.py

@@ -110,17 +110,22 @@ def test___version__():
 
 
 def test_dev_utils():
-    import dpctl._dev as dd
+    import tempfile
 
-    with dd.verbose():
+    import dpctl._diagnostics as dd
+
+    ctx_mngr = dd.syclinterface_diagnostics
+
+    with ctx_mngr():
         dpctl.SyclDevice().parent_device
-    with dd.verbose(verbosity="error"):
+    with ctx_mngr(verbosity="error"):
         dpctl.SyclDevice().parent_device
     with pytest.raises(ValueError):
-        with dd.verbose(verbosity="blah"):
+        with ctx_mngr(verbosity="blah"):
+            dpctl.SyclDevice().parent_device
+    with tempfile.TemporaryDirectory() as temp_dir:
+        with ctx_mngr(log_dir=temp_dir):
             dpctl.SyclDevice().parent_device
-    with dd.verbose(log_dir="/tmp"):
-        dpctl.SyclDevice().parent_device
     with pytest.raises(ValueError):
-        with dd.verbose(log_dir="/not_a_dir"):
+        with ctx_mngr(log_dir="/not_a_dir"):
             dpctl.SyclDevice().parent_device

libsyclinterface/helper/source/dpctl_error_handlers.cpp

@@ -65,21 +65,30 @@ int requested_verbosity_level(void)
     return requested_level;
 }
 
-void output_message(std::string ss_str, [[maybe_unused]] error_level error_type)
+void output_message(std::string ss_str, error_level error_type)
 {
 #ifdef ENABLE_GLOG
     switch (error_type) {
     case error_level::error:
-        LOG(ERROR) << ss_str;
+        LOG(ERROR) << "[ERR] " << ss_str;
         break;
     case error_level::warning:
-        LOG(WARNING) << ss_str;
+        LOG(WARNING) << "[WARN] " << ss_str;
         break;
     default:
-        LOG(FATAL) << ss_str;
+        LOG(FATAL) << "[FATAL] " << ss_str;
     }
 #else
-    std::cerr << ss_str;
+    switch (error_type) {
+    case error_level::error:
+        std::cerr << "[ERR] " << ss_str;
+        break;
+    case error_level::warning:
+        std::cerr << "[WARN] " << ss_str;
+        break;
+    default:
+        std::cerr << "[FATAL] " << ss_str;
+    }
 #endif
 }
 

libsyclinterface/source/dpctl_service.cpp

@@ -46,21 +46,22 @@ __dpctl_give const char *DPCTLService_GetDPCPPVersion(void)
 void DPCTLService_InitLogger(const char *app_name, const char *log_dir)
 {
     google::InitGoogleLogging(app_name);
-    google::EnableLogCleaner(0);
     google::InstallFailureSignalHandler();
-    FLAGS_colorlogtostderr = true;
-    FLAGS_stderrthreshold = google::FATAL;
 
-    namespace fs = std::filesystem;
-    const fs::path path(log_dir);
-    std::error_code ec;
+    if (log_dir) {
+        namespace fs = std::filesystem;
+        const fs::path path(log_dir);
+        std::error_code ec;
 
-    if (fs::is_directory(path, ec)) {
-        FLAGS_log_dir = log_dir;
+        if (fs::is_directory(path, ec)) {
+            google::EnableLogCleaner(0);
+            FLAGS_log_dir = log_dir;
+        }
     }
     else {
-        std::cerr << "Directory not found. Log files will be created in the "
-                     "default logging directory.\n";
+        FLAGS_colorlogtostderr = true;
+        FLAGS_stderrthreshold = google::FATAL;
+        FLAGS_logtostderr = 1;
     }
 }