[Qt] PySide 如何 debug 沒有 stack trace 的 Segmentation Fault

-

雖然 PySide 是 open source 也很好用，但如果我們用 PySide 寫了一些有 bug 的程式，GUI 在做了某個操作後就會無預警 crash 消失不見，只留下哀傷的一行訊息在 console 上：


Segmentation fault

現在是要怎麼 debug? 

最近我就想用 QTableView + QAbstractItemModel 做一個可以動態新增資料的 table，但是以下的程式碼跑起來就會遇到 segmentation fault (完整的程式碼在文章最下面):


from typing import Any, List
import sys

from PySide2 import QtCore, QtWidgets

class DataModel(QtCore.QAbstractItemModel):
    ...

class MainDialog(QtWidgets.QDialog):
    ...

if __name__ == "__main__":
    ...

看了一下我也不知道問題在哪，我也不太曉得 QAbstractItemModel 哪幾個 functions 是一定要 override 的，現在該怎辦?

解法1: 暫時切換成 PyQt

當我們把一開始的 import 全部換成:


from PyQt5 import QtCore, QtWidgets

再跑一次程式，這時候 GUI 不僅不會 crash，console 上還會多一行完整的訊息:


NotImplementedError: QAbstractItemModel.index() is abstract and must be overridden

Oh 原來我忘記要 override "index" function 了。

解法2: 用 gdb 來 debug

如果遇到提示還不夠明顯的狀況，我們可以用 gdb 來 debug。

等等! gdb 不是給 C++ 用的嗎? 和 Python 有什麼關係?

原來 PySide (Qt for Python) 只是像是用 Python 的殼把 Qt C++ 的程式碼包起來，詳細的運作原理可以參考 Qt for Python/Shiboken。簡言之，可以想成 PySide 在 Python 的責任就只有幫你呼叫 C++ Qt 的程式碼，不會在 Python 這邊多做什麼複雜的邏輯。

這個 "Segmentation fault" 錯誤是在 C++ 那邊很常會看到的，當然我們就會想說是不是可以用 gdb 來 debug。剛好在 Python Wiki 就有一個頁面教我們怎麼用 gdb 來 debug，簡單的步驟如下:

  1. gdb python
  2. run test.py

遇到錯誤時 gdb 會停下來可以打字，我們輸入 bt 就可以看到詳細的 backtrace:


(gdb) bt
#0  PyErr_SetObject () at Python/errors.c:84
#1  0x00007ffff7c5b46d in PyErr_SetString () at Python/errors.c:157
#2  0x00007fffe0b791b0 in QAbstractItemModelWrapper::index(int, int, QModelIndex const&) const ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/QtCore.abi3.so
#3  0x00007fffdab63ae5 in QTableView::paintEvent(QPaintEvent*) ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/Qt/lib/libQt5Widgets.so.5
#4  0x00007fffdb530e97 in QTableViewWrapper::paintEvent(QPaintEvent*) ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/QtWidgets.abi3.so
#5  0x00007fffda90b740 in QWidget::event(QEvent*) ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/Qt/lib/libQt5Widgets.so.5
#6  0x00007fffda9b421e in QFrame::event(QEvent*) ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/Qt/lib/libQt5Widgets.so.5
#7  0x00007fffdab182bc in QAbstractItemView::viewportEvent(QEvent*) ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/Qt/lib/libQt5Widgets.so.5
#8  0x00007fffdb536675 in QTableViewWrapper::viewportEvent(QEvent*) ()
   from /xxx/.local/lib/python3.6/site-packages/PySide2/QtWidgets.abi3.so
#9  0x00007fffe056b5a0 in QCoreApplicationPrivate::sendThroughObjectEventFilters(QObject*, QEvent*) ()
---Type <return> to continue, or q <return> to quit---

雖然沒有像 PyQt 直截了當告訴我們錯誤在哪，但我們看到 #2 應該也猜的到我們忘記寫 "QAbstractItemModelWrapper::index" 了。

Python 版本小陷阱

在 Linux 系統上 "python" 有時候指到 python 2 有時候卻是 python 3。

如果你是用 Python 3 去開發，怕 "gdb python" 找錯 Python 版本的話最好是說的更明確一點: "gdb python3"。

失敗方法: 用 faulthandler

如果我們去 Google 搜尋 "python debug segmentation fault" 我們可以在 StackOverflow 上找到一個看起來很簡單的解法，可以加在一開始程式執行的地方或是即將 crash 前:


import faulthandler; faulthandler.enable()

但很遺憾的是針對這次的 buggy code 還是沒有用，他會在 console 上寫:


Fatal Python error: Segmentation fault

Current thread 0x00007ffff7f9c740 (most recent call first):
  File "/xxx/test.py", line 109 in <module>
Segmentation fault

結語

看起來切換成 PyQt 解法可以最快找到問題在哪並且修正。比較複雜的 case 我們也有能力用 gdb 來做 debug。faulthandler 說不定在其他地方能派上用場，只是對 PySide 沒什麼作用。

在用 Python 寫 Qt 比較複雜的功能時我們還是要盡量去看 C++ 的 documentation，避免我們誤用他預期的使用方式。

附錄

GUI

一開始 QTableView 會顯示 2 rows:


點了 "Add more data" 後會多 3 rows:


會 Segmentation Fault 的 PySide2 Code


from typing import Any, List
import sys

from PySide2 import QtCore, QtWidgets


class DataModel(QtCore.QAbstractItemModel):
    def __init__(self, parent=None) -> None:
        super().__init__(parent)

        self._headers: List[str] = ["Column A", "Column B", "Column C"]
        self._data: List[List[str]] = [
            ["item 1", "item 2", "item 3"],
            ["item 4", "item 5", "item 6"],
        ]

    def columnCount(self, parent=QtCore.QModelIndex()) -> int:
        return len(self._headers)

    def rowCount(self, parent=QtCore.QModelIndex()) -> int:
        return len(self._data)

    def headerData(
        self,
        section: int,
        orientation: QtCore.Qt.Orientation,
        role: int = QtCore.Qt.DisplayRole,
    ) -> Any:
        if (
            role == QtCore.Qt.DisplayRole
            and orientation == QtCore.Qt.Horizontal
        ):
            return self._headers[section]

        return None

    def data(
        self, index: QtCore.QModelIndex, role: int = QtCore.Qt.DisplayRole
    ) -> Any:
        if not index.isValid():
            return None

        if role == QtCore.Qt.DisplayRole:
            return self._data[index.row()][index.column()]

        return None

    def append_data(self, new_data: List[List[str]]) -> None:
        parent = QtCore.QModelIndex()
        first = len(self._data)
        last = first + len(new_data) - 1

        self.beginInsertRows(parent, first, last)

        self._data.extend(new_data)

        self.endInsertRows()


class MainDialog(QtWidgets.QDialog):
    def __init__(self, parent=None) -> None:
        super().__init__(parent)

        self._layout = QtWidgets.QHBoxLayout(self)

        self._table_view = QtWidgets.QTableView()
        self._model = DataModel(self._table_view)
        self._table_view.setModel(self._model)

        self._button = QtWidgets.QPushButton()
        self._button.setText("Add more data")
        self._button.clicked.connect(self._add_more_data)

        self._layout.addWidget(self._table_view)
        self._layout.addWidget(self._button)

    def _add_more_data(self) -> None:
        new_data: List[List[str]] = [
            ["item 7", "item 8", "item 9"],
            ["item 10", "item 11", "item 12"],
            ["item 13", "item 14", "item 15"],
        ]
        self._model.append_data(new_data)


if __name__ == "__main__":
    app = QtWidgets.QApplication([])

    dialog = MainDialog()
    dialog.show()

    sys.exit(app.exec_())

修正的 PySide2 Code

在 class DataModel 補上了 "index" 和 "parent" 後就可以正常執行了。

from typing import Any, List
from typing import Any, List
import sys

from PySide2 import QtCore, QtWidgets


class DataModel(QtCore.QAbstractItemModel):
    def __init__(self, parent=None) -> None:
        super().__init__(parent)

        self._headers: List[str] = ["Column A", "Column B", "Column C"]
        self._data: List[List[str]] = [
            ["item 1", "item 2", "item 3"],
            ["item 4", "item 5", "item 6"],
        ]

    def index(
        self, row: int, column: int, parent=QtCore.QModelIndex()
    ) -> QtCore.QModelIndex:
        if (
            row >= 0
            and row < len(self._data)
            and column >= 0
            and column < len(self._headers)
        ):
            ptr = self._data[row][column]
            return self.createIndex(row, column, ptr)

        return QtCore.QModelIndex()

    def parent(self, child: QtCore.QModelIndex) -> QtCore.QModelIndex:
        return QtCore.QModelIndex()

    def columnCount(self, parent=QtCore.QModelIndex()) -> int:
        return len(self._headers)

    def rowCount(self, parent=QtCore.QModelIndex()) -> int:
        return len(self._data)

    def headerData(
        self,
        section: int,
        orientation: QtCore.Qt.Orientation,
        role: int = QtCore.Qt.DisplayRole,
    ) -> Any:
        if (
            role == QtCore.Qt.DisplayRole
            and orientation == QtCore.Qt.Horizontal
        ):
            return self._headers[section]

        return None

    def data(
        self, index: QtCore.QModelIndex, role: int = QtCore.Qt.DisplayRole
    ) -> Any:
        if not index.isValid():
            return None

        if role == QtCore.Qt.DisplayRole:
            return self._data[index.row()][index.column()]

        return None

    def append_data(self, new_data: List[List[str]]) -> None:
        parent = QtCore.QModelIndex()
        first = len(self._data)
        last = first + len(new_data) - 1

        self.beginInsertRows(parent, first, last)

        self._data.extend(new_data)

        self.endInsertRows()


class MainDialog(QtWidgets.QDialog):
    def __init__(self, parent=None) -> None:
        super().__init__(parent)

        self._layout = QtWidgets.QHBoxLayout(self)

        self._table_view = QtWidgets.QTableView()
        self._model = DataModel(self._table_view)
        self._table_view.setModel(self._model)

        self._button = QtWidgets.QPushButton()
        self._button.setText("Add more data")
        self._button.clicked.connect(self._add_more_data)

        self._layout.addWidget(self._table_view)
        self._layout.addWidget(self._button)

    def _add_more_data(self) -> None:
        new_data: List[List[str]] = [
            ["item 7", "item 8", "item 9"],
            ["item 10", "item 11", "item 12"],
            ["item 13", "item 14", "item 15"],
        ]
        self._model.append_data(new_data)


if __name__ == "__main__":
    app = QtWidgets.QApplication([])

    dialog = MainDialog()
    dialog.show()

    sys.exit(app.exec_())

留言

發佈留言

此網誌的熱門文章

[試算表] 追蹤台股 Google Spreadsheet (未實現損益/已實現損益)

-
圖片
在 Dcard 上發了一篇文結果引起超多網友回應想要看試算表，我就來整理一下我追蹤台股用的 Google 試算表給大家。 這個試算表我目標是以 "簡單" 為主，底下我也會講解公式的運作原理，希望大家能以此試算表輕鬆擴充自己想要的功能。 功能 未實現損益 (Unrealized Gain/Loss 表) 不管同一支股票是不是有部分已經賣出，只要你還持有未賣出的股票這邊都看的到。 已實現損益 (Realized Profit/Loss 表) 我過去的績效如何? 在這個表一目了然。 未實現損益: 詳細資料 (Unrealized Stats 表) 我還持有多少股? 每股市值多少? 每股的成本是多少? 在這個表可以快速追蹤。 手機友善 (Mobile Friendly) 我為了在手機上也可以快速看我想看的資訊，把 "Unrealized Gain/Loss" 做成比較窄的版型。 只要下載 Google Sheets app 打開試算表就可以了。 Google Spreadsheet 連結 Google Drive 連結 Stock Tracking 使用方式 請先點 "檔案" -> "建立副本"，copy 一份試算表到你自己的 Google Drive 將 "Current Price" 表單中填上你想要追蹤的股票代號和名稱 將 "Transactions" 表單中刪除範例資料，但請務必留下第 2 列 (因為有公式)，然後慢慢往下填入你的資料 Step 1: 檔案 -> 建立副本 Step 2: 新增/刪除股票代號和名稱 (紅框圈起處)，灰色底欄位代表有公式 Step 3: 在 "Transactions" 表填入資料到白色底欄位 (紅框圈起處)，灰色底欄位代表要讓公式自動計算 未實現損益的正確算法 其實在發 Dcard 文之前我自己也像 另外一個表單 犯了同樣的錯誤，就是只有在股票全部賣光光 (持有 0 股) 後計算的未實現損益才會正確。還沒全部賣光怎麼辦? 難道就不顯示了嗎? 飲料的例子 只要股票中途賣出一部分，目前還持有部分股票的話，感覺計算就突然變得很複雜。但不用怕，我們來用飲料當作股票舉個超簡單的例子 (1 杯=1...
閱讀更多

[Side Project] 互動式教學神經網路反向傳播 Interactive Computational Graph

-
圖片
成品 互動式網頁連結:  Interactive Computational Graph 微積分課經典的範例 df/dx sin(x) / x: 2 個 inputs, 1 個 output, 沒有 hidden layer 的 fully connected neural network: 為何要做這套工具 以前在學 machine learning 的時候覺得最難理解的部分就是 backpropagation，也就是神經網路到底是怎麼用數學來做訓練的。 我們知道神經網路就是長這樣子: Source: Wikipedia 但實際上每個 neuron (圓圈圈) 裡面有許多基本的數學運算，像是 sum 還有 activation function: Source:  Neural Networks and Machine Learning 當我們把所有東西綜合在一起，腦袋就會打結，到底 chain rule 是怎麼在這麼複雜的神經網路之間套用的? 就算了解基礎也很難相信實際上到底怎麼運作的。我又沒有要真的使用的話，網路上的教學就覺得看看就好 Source:  A Step by Step Backpropagation Example 但決心要了解 backpropagation 細節之後，不少教學都提到了 computational graph，從基礎的數學運算當作 nodes 來去理解似乎是比較簡單的方式。 後來找到了這篇文章  Calculus on Computational Graphs: Backpropagation  把 chain rule 講解的簡單至極，於是就在想，為何我不做一個網頁，讓大家可以自由地組合想要的 graph，然後看一下 chain rule 是怎麼流通的。 失敗作經驗 在做這次 side project 前，其實早在一年前我就開始作另一個 side project 是想展現神經網路的訓練過程。名稱叫做 explain-derivatives，是被 TensorFlow 的一個網頁 A Neural Network Playground 啟發的。 但由於一開始欠缺規劃，想到什麼就加什麼功能進去，造成架構一直修改，最後由於程式碼架構太過複雜就放棄了。 這個 project 是用 Cy...
閱讀更多

[插件] 在 Chrome 網頁做區分大小寫的搜尋

-
圖片
寫軟體的時候最常用到的功能就是上網查 API 文件，但是常常會遇到一個困擾就是，搜尋的文字在 Chrome 裡面是不區分大小寫 (case-insensitive) 的。有的時候是還好，多按一些 F3 就找到了，可是有時候實在是太多大小寫的東西混在一起，這時候我們有一些快速的解法: 用 Firefox 搜尋 (Firefox 的搜尋框裡面預設就提供有 match case 的功能了) 開 DevTools 按 Ctrl + Shift + F 進行全部東西的搜尋 (不過大概會發瘋) 用插件的解法算是意外發現的，原本只是在找有沒有可以用 regex 搜尋的插件，沒想到意外發現  regex 的插件也是可以拿來做區分大小寫 (case-sensitive) 的一般搜尋。 用 Chrome Regex Search 來做區分大小寫的搜尋 先裝好 Chrome Regex Search 之後，按 Ctrl + Shift + F 或是點工具列的圖示，打上想找的文字就可以了。 例如我最近在看 Qt QTextCursor 的文件，但是我只想找 "cursor"，很不幸的如果用 Chrome 預設搜尋他會把一大堆 QText Cursor 也會找到: 如果用 Chrome Regex Search 就會侷限在小寫的 "cursor": 用 Regex 的陷阱 如果你不知道 regex 是什麼，那你很有可能會發現在搜尋一些含特殊符號的東西會搜尋到怪怪的東西，不然就是搜尋會失敗。 這是因為 regex 本來就是偏工程師在用的東西，有一些符號是有特殊涵意的，所以如果搜尋的字包含以下任何特殊符號記得要在前面加一個反斜線 \ ( ref ): . + * ? ^ $ ( ) [ ] { } | \ 例如我想搜尋 1+1=(2-1)+1*1 ，那其實要打 1\+1=\(2-1\)\+1\*1  才會正確找的到。 是不是很麻煩? 不過如果你要找的東西有特殊符號的話，其實用一般 Chrome 的搜尋通常是不會有太多搜尋結果的，那就用一般搜尋就好。 Chrome 什麼時候要支援大小寫搜尋? 其實上面弄了那麼麻煩，還不如開個 Firefox 搜尋更快。那我就滿好奇，這麼基本的功能怎麼 Chrome 一直都沒做? 找了一下才發現 Super User 有人...
閱讀更多