Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Add debug directory preference and DebugManager for structured logging - #59

Merged
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature
Jan 14, 2026
Merged

Add debug directory preference and DebugManager for structured logging#59
lachlangrose merged 17 commits into
dev-0.1.12from
copilot/add-structured-logging-feature

Conversation

CopilotAI commented Dec 16, 2025

Copy link
Copy Markdown
Contributor

The plugin now centralizes debug logging with a configurable debug directory and session-scoped DebugManager to log parameters and persist artifacts from map2loop runs.

  • Settings
    • Added debug_directory to PlgSettingsStructure with getters/setters and options UI (browse/open).
    • Options page validates directory existence before opening.
  • DebugManager
    • Resolves per-session debug directory (pref or temp map2loop_debug/<project>/session_<uuid>_<timestamp>), logs debug state/dir, sanitizes filenames, and saves parameters/files atomically.
    • Writes a reusable run_map2loop.py helper into the debug folder to replay logged runs outside QGIS using the saved params.
  • Wiring
    • Plugin entrypoint instantiates DebugManager and passes it into map2loop dialogs/widgets.
    • Sampler, sorter, basal contacts, user-defined sorter, and thickness widgets log parameters each run; in debug mode they save artifacts (CSV/JSON/text) and emit error logs on failures.
    • Debug parameter logging now serializes layer metadata (name/id/provider/source) and exports the actual layers to GeoPackage files in the debug directory for offline replay.

Example:

# Within a widget run pathself._debug.log_params("sorter_widget_run", self.get_parameters())
result=sort_stratigraphic_column(**kwargs)
ifself._debug.is_debug():
self._debug.save_debug_file("sorter_result.txt", "\n".join(result).encode("utf-8"))
Original prompt

Project: LoopStructural QGIS plugin (includes map2loop tools)
Feature: Structured logging + debug directory management using plugin.log

Context (Important APIs you must use)

  • Plugin logger:PlgLogger.log(message: str, application: str=__title__, log_level: int=0, push: bool=False, duration: Optional[int]=None, button: bool=False, button_text: Optional[str]=None, button_connect: Optional[Callable]=None, parent_location: Optional[QWidget]=None)

    • Log levels mapping:0=info, 1=warning, 2=critical, 3=success, 4=none/grey
    • Debug gating: When debug_mode is OFF, info/success logs are suppressed unless push=True. Warnings/critical are always shown.
  • Preferences access:PlgOptionsManager.get_plg_settings() returns a PlgSettingsStructure dataclass with fields like debug_mode, etc.

    • Add a new field: debug_directory: str = "" (empty means use system temp).
    • Convenience methods to add:
      • PlgOptionsManager.get_debug_directory() -> str
      • PlgOptionsManager.set_debug_directory(path: str) -> bool
  • Plugin entrypoint:LoopstructuralPlugin has an attribute self.log = PlgLogger().log.
    Create and store a DebugManager instance (defined below) in LoopstructuralPlugin.__init__ and pass it to widgets that run models.

  • QGIS project: Use QgsProject.instance() to get project name (title or filename stem).


Tasks (Implement all)

  1. Add a plugin setting: debug_directory

    • Update PlgSettingsStructure to include debug_directory: str = "".
    • Implement:
      @classmethoddefget_debug_directory(cls) ->str: ...
      @classmethoddefset_debug_directory(cls, path: str) ->bool: ...
    • Ensure PlgOptionsManager.get_plg_settings() populates the new field from QgsSettings (it already maps fields dynamically—just adding the field is enough).
  2. Create DebugManager (new module)

    • Responsibilities:

      • Resolve effective debug directory:
        • If PlgOptionsManager.get_debug_directory() is set, use it.
        • If empty, use tempfile.gettempdir() and create:
          /map2loop_debug/<project_name>/session_<YYYYMMDD%H%M%S>
        • Create directories with parents=True, exist_ok=True. On failure, fallback to system temp and log a warning (log_level=1), or critical (log_level=2) if fallback also fails.
      • Log debug mode state once per session: [map2loop] Debug mode: ON|OFF (info).
      • Log resolved debug directory once per session (info).
      • Provide:
        • log_params(context_label: str, params: Any) → always log full parameters (info); if debug mode is ON, write a compact JSON to the debug dir and log the file path (info).
        • save_debug_file(filename: str, content_bytes: bytes) → atomic write (.tmp then os.replace), log final path (info).
      • All logging must callplugin.log(message=..., log_level=...) (no print / no other loggers).
    • Implementation sketch:

      # debug_manager.pyimportos, json, uuid, tempfile, datetimefrompathlibimportPathfromtypingimportAnyfromqgis.coreimportQgsProjectimportloopstructural.toolbelt.preferencesasplg_prefs_hdlrclassDebugManager:
      def__init__(self, plugin):
      self.plugin=pluginself._session_dir=Noneself._session_id=uuid.uuid4().hexself._project_name=self._get_project_name()
      self._debug_state_logged=Falsedef_get_settings(self):
      returnplg_prefs_hdlr.PlgOptionsManager.get_plg_settings()
      def_get_project_name(self) ->str:
      try:
      proj=QgsProject.instance()
      title=proj.title()
      iftitle:
      returntitlestem=Path(proj.fileName() or"").stemreturnstemor"untitled_project"exceptExceptionase:
      self.plugin.log(message=f"[map2loop] Failed to resolve project name: {e}", log_level=1)
      return"unknown_project"defis_debug(self) ->bool:
      try:
      state=bool(self._get_settings().debug_mode)
      ifnotself._debug_state_logged:
      self.plugin.log(message=f"[map2loop] Debug mode: {'ON'ifstateelse'OFF'}", log_level=0)
      self._debug_state_logged=TruereturnstateexceptExceptionase:
      self.plugin.log(message=f"[map2loop] Error checking debug mode: {e}", log_level=2)
      returnFalse

    ...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

CopilotAIand others added 3 commits December 16, 2025 22:59
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>
CopilotAI changed the title [WIP] Add structured logging and debug directory managementAdd debug directory preference and DebugManager for structured loggingDec 16, 2025
@lachlangroselachlangrose added enhancement New feature or request UI quality labels Dec 17, 2025
@lachlangrose

Copy link
Copy Markdown
Member

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot can you extend _log_params to also save the layers used for the map2loop tools so that the tools can be called outside of qgis environment.

Implemented layer serialization in debug parameter logging so map2loop tool runs now record layer names/ids/providers/sources for use outside QGIS (commit 9148640).

@lachlangrose
lachlangrose changed the base branch from copilot/create-separate-gui-components to dev-0.1.12December 17, 2025 22:49
@lachlangrose
lachlangrose marked this pull request as ready for review December 17, 2025 22:49
@lachlangrose

Copy link
Copy Markdown
Member

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. after any filtering in qgis. It would also be good if you could add a python script into the debug folder that can run the map2loop tools outside of qgis using the params json.

Co-authored-by: lachlangrose <7371904+lachlangrose@users.noreply.github.com>

CopilotAI commented Dec 17, 2025

Copy link
Copy Markdown
ContributorAuthor

@copilot instead of only serializing the path to the layer, can you save the layer in the debug folder? This is important because I want to ensure that the layer used by the plugin is stored e.g. afte...

Layers are now exported to the debug folder (GPKG) during debug runs and referenced in the logged params. A reusable run_map2loop.py script is also written into the debug directory; it loads the params JSON, reopens the exported layers, and can invoke the corresponding map2loop tool outside QGIS (commit 91d94e6).

@lachlangrose
lachlangrose merged commit 400434c into dev-0.1.12Jan 14, 2026
1 check passed
@lachlangrose
lachlangrose deleted the copilot/add-structured-logging-feature branch January 14, 2026 23:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or requestqualityUI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lachlangrose