-
Notifications
You must be signed in to change notification settings - Fork 2
Add catch-all CLI exception handler #41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
wpak-ai
merged 5 commits into
cppalliance:develop
from
henry0816191:cli-catch-all-handler
May 28, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| """Crash log utilities for unhandled CLI exceptions.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import platform | ||
| import sys | ||
| import traceback | ||
| from datetime import datetime, timezone | ||
| from pathlib import Path | ||
|
|
||
| from localci import __version__ | ||
| from localci.utils.paths import localci_home | ||
|
|
||
| CRASH_LOG_NAME = "crash.log" | ||
|
|
||
|
|
||
| def crash_log_path() -> Path: | ||
| """Return the path to the crash log file (``~/.localci/crash.log``).""" | ||
| return localci_home() / CRASH_LOG_NAME | ||
|
|
||
|
|
||
| def crash_log_display_path() -> str: | ||
| """Return a short user-facing path for the crash log (e.g. ``~/.localci/crash.log``).""" | ||
| path = crash_log_path() | ||
| # Canonical layout: always show ~/.localci/crash.log (avoids long paths / terminal wrap). | ||
| if path.name == CRASH_LOG_NAME and path.parent.name == ".localci": | ||
| return f"~/.localci/{CRASH_LOG_NAME}" | ||
| try: | ||
| rel = path.relative_to(Path.home()) | ||
| return "~/" + rel.as_posix() | ||
| except ValueError: | ||
| return str(path) | ||
|
|
||
|
|
||
| def _build_crash_report(exc: BaseException) -> str: | ||
| return "".join( | ||
| [ | ||
| f"timestamp: {datetime.now(timezone.utc).isoformat()}\n", | ||
| f"localci_version: {__version__}\n", | ||
| f"python_version: {sys.version}\n", | ||
| f"platform: {platform.platform()}\n", | ||
| "\n", | ||
| "traceback:\n", | ||
| *traceback.format_exception(type(exc), exc, exc.__traceback__), | ||
| ] | ||
| ) | ||
|
|
||
|
|
||
| def log_crash(exc: BaseException) -> Path | None: | ||
| """Write a full crash report for *exc* and return the log file path. | ||
|
|
||
| On write failure, prints the report to stderr and returns ``None``. | ||
| """ | ||
| path = crash_log_path() | ||
| report = _build_crash_report(exc) | ||
| try: | ||
| path.write_text(report, encoding="utf-8") | ||
| return path | ||
| except OSError: | ||
| sys.stderr.write(f"Could not write crash log to {path}:\n") | ||
| sys.stderr.write(report) | ||
| return None |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.