hint message improved; logging dir renamed to logs_scorep_jupyter

Author: OutlyingWest

.gitignore

@@ -3,4 +3,5 @@ __pycache__/
 .userpersistency
 build
 logging
+kernel_logs
 **/*.egg-info

src/scorep_jupyter/kernel.py

@@ -17,6 +17,7 @@
 from scorep_jupyter.kernel_messages import (
     KernelErrorCode,
     KERNEL_ERROR_MESSAGES,
+    get_scorep_process_error_hint,
 )
 from scorep_jupyter.userpersistence import PersHelper, scorep_script_name
 from scorep_jupyter.userpersistence import magics_cleanup, create_busy_spinner
@@ -570,7 +571,7 @@ async def scorep_execute(
             self.log_error(
                 KernelErrorCode.PERSISTENCE_LOAD_FAIL,
                 direction="Score-P -> Jupyter",
-                optional_hint = self.get_scorep_process_error_hint()
+                optional_hint = get_scorep_process_error_hint()
 
             )
             return self.standard_reply()
@@ -590,7 +591,7 @@ async def scorep_execute(
             self.log_error(
                 KernelErrorCode.PERSISTENCE_LOAD_FAIL,
                 direction="Score-P -> Jupyter",
-                optional_hint = self.get_scorep_process_error_hint()
+                optional_hint = get_scorep_process_error_hint()
             )
             self.pershelper.postprocess()
             return reply_status_update
@@ -750,22 +751,6 @@ def read_scorep_stream(
                     with lock:
                         process_line(line)
 
-    @staticmethod
-    def get_scorep_process_error_hint():
-        is_spinner_enabled = str(os.getenv(
-            "SCOREP_JUPYTER_DISABLE_PROCESSING_ANIMATIONS"
-        )).lower() not in ["true", "1", "t"]
-        scorep_process_error_hint = ""
-        if is_spinner_enabled:
-            scorep_process_error_hint = (
-                "\nHint: If the animation spinner is active, "
-                "runtime errors in Score-P cells might be hidden.\n"
-                "Try disabling the spinner with "
-                "%env SCOREP_JUPYTER_DISABLE_PROCESSING_ANIMATIONS=1 "
-                "and/or check the log file for details."
-            )
-        return scorep_process_error_hint
-
     async def do_execute(
         self,
         code,

src/scorep_jupyter/kernel_messages.py

@@ -1,5 +1,8 @@
+import os
 from enum import Enum, auto
 
+from .logging_config import LOGGING
+
 
 class KernelErrorCode(Enum):
     PERSISTENCE_SETUP_FAIL = auto()
@@ -36,3 +39,20 @@ class KernelErrorCode(Enum):
         "Persistence not recorded (marshaller: {marshaller})."
     ),
 }
+
+
+def get_scorep_process_error_hint():
+    is_spinner_enabled = str(os.getenv(
+        "SCOREP_JUPYTER_DISABLE_PROCESSING_ANIMATIONS"
+    )).lower() not in ["true", "1", "t"]
+    scorep_process_error_hint = ""
+    if is_spinner_enabled:
+        scorep_process_error_hint = (
+            "\nHint: If the animation spinner is active, "
+            "runtime errors in Score-P cells might be hidden.\n"
+            "Try disabling the spinner with "
+            "%env SCOREP_JUPYTER_DISABLE_PROCESSING_ANIMATIONS=1 "
+            f"and/or check the log: "
+            f"{LOGGING['handlers']['error_file']['filename']} for details."
+        )
+    return scorep_process_error_hint

src/scorep_jupyter/logging_config.py

@@ -4,7 +4,7 @@
 from pathlib import Path
 
 
-LOGGING_DIR = Path().cwd().parent / "logging"
+LOGGING_DIR = Path().cwd().parent / "logs_scorep_jupyter"
 os.makedirs(LOGGING_DIR, exist_ok=True)