Trouble setting up QDataWidgetMapper

aarqon

I'm new to Qt and trying to set some widgets to update when an row in a QTableView is selected. For some reason the selection is not synchronizing between the view's selection model and the data mapper?

files_mapper = QDataWidgetMapper(window)
files_mapper.setModel(files_model)
files_mapper.addMapping(window.ui.dateEdit, FilesModel.Column.DATE)
files_mapper.currentIndexChanged.connect(print)
file_selectionmodel = window.ui.fileTableView.selectionModel()
file_selectionmodel.currentRowChanged.connect(print) file_selectionmodel.currentRowChanged.connect(files_mapper.setCurrentModelIndex)

files_model is a custom QAbstractTableModel subclass (FilesModel).
The signal connection on line 4 never fires, even when the signal on line 6 does fire.
It's very possible that I'm not understanding how all of these pieces work. I feel like the docs do not do a good job of explaining how components are meant to fit together!

aarqon

From a quick test it looks like hiding columns on the QSortFilterProxyModel was stopping the model from returning Date column data to the mapper. Which makes sense, I think? I will need to find another way to filter the table view columns instead.

JonB

@aarqon said in Trouble setting up QDataWidgetMapper:

The signal connection on line 4 never fires, even when the signal on line 6 does fire.

Your code is not legal Python and produces an error at runtime on

file_selectionmodel.currentRowChanged.connect(print) file_selectionmodel.currentRowChanged.connect(files_mapper.setCurrentModelIndex)

You cannot have multiple statements on a single line like this in Python. You would either need a ; (semi-colon) or separate lines, and I don't know which you have. At which point I do not know what your current "even when the signal on line 6 does fire" means exactly? Both of these statements? One of them? Do we know whether the second statement connecting file_selectionmodel to files_mapper is even being executed? If not line #4 is not going to fire.

If that is not it: you are connecting a QItemSelectionModel::currentRowChanged(const QModelIndex &current, const QModelIndex &previous) which sends QModelIndex arguments and passing (the first) index to QDataWidgetMapper::setCurrentModelIndex() which accepts an int index parameter. I think C++ would produce a type compilation error for this where perhaps Python/PySide/PyQt lets it through. This probably means QDataWidgetMapper::currentIndexChanged() does not get fired?

That needs correcting. To start testing you might omit the QItemSelectionModel stuff and verify line #4 works when you do some direct QDataWidgetMapper::setCurrentModelIndex(int index) with an explicit integer index. Always break down your code into simplest steps when testing how something is behaving while developing/debugging.

When you connect() from Python it is your job to look at the parameters sent by the signal against the parameters accepted by the slot. If they do not match correctly for what you want you have to write some code --- either another "intermediate" slot function or a Python lambda with correct parameters which then calls the slot you really wanted. For example, here quite untested by me you might need something like:

file_selectionmodel.currentRowChanged.connect(lambda current = current : files_mapper.setCurrentModelIndex(current.row()))

I have not tried testing the code or the Python syntax as I don't have your model code to copy. I am also uncertain whether the row numbers in the indexes used/returned in a QItemSelectionModel are suitable/identical to those directly into the model (not selection) which you need to pass to the model/QDataWidgetMapper::setCurrentModelIndex(). Try to get it right yourself, if you are stuck say so and I will try actually testing the required Python code.

UPDATE
I think what I have written about your currentRowChanged()/setCurrentModelIndex() parameters is incorrect, I did not look at your code closely enough. I am now trying to get this working correctly in PySide6 and will post when I have it....

JonB

@aarqon
I have crossed out stuff in my initial reply where I did not look correctly at your code.

In a word: your code would work if the QDataWidgetMapper had a flat model, like a list model or a non-hierarchical table model. But your QFileSystemModel is hierarchical (has parents) and so its indexes do not work for QDWM as-is. The key is void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

Sets the root item to index. This can be used to display a branch of a tree. Pass an invalid model index to display the top-most branch.

We need to set that to the parent of the selected item to make the index passed in correct. A complete example of this working is:

import sys
from PySide6 import QtWidgets

def selection_changed(index, _previous):
    dwp.setRootIndex(index.parent())
    dwp.setCurrentModelIndex(index)


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

    window = QtWidgets.QWidget()
    window.setGeometry(100, 100, 400, 400)
    layout = QtWidgets.QVBoxLayout()
    window.setLayout(layout)

    fs = QtWidgets.QFileSystemModel()
    fs.setRootPath("/home/jon")

    tv = QtWidgets.QTreeView(window)
    tv.setModel(fs)
    tv.setRootIndex(fs.index("/home/jon"))
    layout.addWidget(tv)

    dwp = QtWidgets.QDataWidgetMapper()
    dwp.setModel(fs)
    leName = QtWidgets.QLineEdit()
    layout.addWidget(leName)
    dwp.addMapping(leName, 0)

    fsm = tv.selectionModel()
    fsm.currentChanged.connect(selection_changed)

    window.show()
    sys.exit(app.exec())

You may have to a bit careful if you intend to use this for editing selected files/directories (possibly to cope correctly with an unsaved edit in the line edit when you click elsewhere), but I don't even know whether you intend to allow that. For now this at least shows the selected item in the line edit at the bottom of the window.

aarqon

@JonB Thanks for taking a look Jon.
(The line formatting in my code block up there is a mistake from when I pasted the code in! My bad there.)

But your QFileSystemModel is hierarchical (has parents)

I'm not using a QFileSystemModel.
FilesModel is a list of files with metadata:

class FilesModel(QAbstractTableModel):
    class Column(IntEnum):
        ID = 0
        PATH = auto()
        HASH = auto()
        TAGS = auto()
        TYPE = auto()
        DESCRIPTION = auto()
        SOURCES = auto()
        DATE = auto()
        EXIF = auto()
        PARENT = auto()
    
    def __init__(self, source: list[Files] = []):
        super().__init__()
        self._files = source
        self._thumbs = {x.hash: None for x in source}
        for file in source:
            self._thumbs[file.hash] = QIcon(str(file.path))
    
    def data(self, index, role):
        match role:
            case Qt.ItemDataRole.DisplayRole | Qt.ItemDataRole.EditRole:
                f = self._files[index.row()]
                match index.column():
                    case self.Column.ID:
                        return f.id
                    case self.Column.PATH:
                        return f.path.name
                    case self.Column.HASH:
                        return f.hash
                    case self.Column.TAGS:
                        return f.tags
                    case self.Column.TYPE:
                        return f.type
                    case self.Column.DESCRIPTION:
                        return f.description
                    case self.Column.SOURCES:
                        return f.sources
                    case self.Column.DATE:
                        return f.date
                    case self.Column.EXIF:
                        return f.includeExif
                    case self.Column.PARENT:
                        return f.parent
                    case _:
                        return None
            case Qt.ItemDataRole.DecorationRole:
                match index.column():
                    case self.Column.PATH:
                        return self._thumbs[self._files[index.row()].hash]
                    case _:
                        return None
    
    def rowCount(self, index):
        return len(self._files)

    def columnCount(self, index):
        return len(self.Column)

    def headerData(self, section, orientation, role):
        if orientation == Qt.Orientation.Horizontal:
            if role == Qt.ItemDataRole.DisplayRole:
                return self.Column(section).name.capitalize()

##########
# Referenced in the above:
##########

type Tag = str
type Hash = str     # sha256 hex string
type Date = str     # expecting ISO 8601 YYYY-MM-DD

class FileType(IntEnum):
    IMAGE = 1
    VIDEO = auto()
    TEXT = auto()
    AUDIO = auto()

@dataclass
class File:
    type: FileType = None
    path: Path = None
    hash: Hash = None # sha256
    id: int = None
    tags: list[Tag] = field(default_factory=list)
    description: str = None
    sources: list[str] = field(default_factory=list)
    parent: Hash = None
    date: QDate = None
    includeExif: bool = True

I am also uncertain whether the row numbers in the indexes used/returned in a QItemSelectionModel are suitable/identical to those directly into the model (not selection) which you need to pass to the model/QDataWidgetMapper::setCurrentModelIndex().

I'm a little unsure about that as well however the docs make it very explicit:
https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QDataWidgetMapper.html#PySide6.QtWidgets.QDataWidgetMapper.setCurrentModelIndex

Calls setCurrentIndex() internally. This convenience slot can be connected to the signal currentRowChanged() or currentColumnChanged() of another view’s selection model.

The following example illustrates how to update all widgets with new data whenever the selection of a QTableView named myTableView changes:

mapper = QDataWidgetMapper()
connect(myTableView.selectionModel(), QItemSelectionModel.currentRowChanged,
mapper.setCurrentModelIndex)

The specific connect() call there doesn't seem to be valid (too literally copied from the C++?) but the idea is clear.
(window.ui.fileTableView is a plain QTableView.)

One of the tutorials also uses it in this way:
https://doc.qt.io/qtforpython-6/tutorials/portingguide/chapter3/chapter3.html#python-version

selection_model = self.bookTable.selectionModel()
selection_model.currentRowChanged.connect(mapper.setCurrentModelIndex)

JonB

@aarqon
If you are not using a QFileSystemModel/hierarchical model but a flat list model instead then not sure what your issue is. If you want help please paste a complete but minimal (e.g. preferably simplified/reduced from what you have shown so far) example of whole code in a "blob" showing problem which we can copy & paste.

aarqon

@JonB This seems to work as expected so I will try to figure out what I'm missing in the main project! It might be flags() and setData() in the model class...

################################################################################
# Form generated from reading UI file 'designerqvIwSQ.ui'
##
# Created by: Qt User Interface Compiler version 6.11.2
##
# WARNING! All changes made in this file will be lost when recompiling UI file!
################################################################################

from PySide6.QtCore import (QCoreApplication, QDate, QDateTime, QLocale, QMetaObject, QObject, QPoint,
                            QRect, QSize, QTime, QUrl, Qt, QSortFilterProxyModel, QAbstractTableModel)
from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor, QFont, QFontDatabase, QGradient,
                           QIcon, QImage, QKeySequence, QLinearGradient, QPainter, QPalette, QPixmap, QRadialGradient, QTransform)
from PySide6.QtWidgets import (QApplication, QDateEdit, QGridLayout, QHeaderView,
                               QMainWindow, QMenuBar, QSizePolicy, QStatusBar, QTableView, QVBoxLayout, QWidget, QDataWidgetMapper)

from dataclasses import dataclass, field
from enum import IntEnum, auto
import sys
from pathlib import Path


class Ui_MainWindow(object):
    def setupUi(self, MainWindow):
        if not MainWindow.objectName():
            MainWindow.setObjectName(u"MainWindow")
        MainWindow.resize(800, 600)
        self.centralwidget = QWidget(MainWindow)
        self.centralwidget.setObjectName(u"centralwidget")
        self.gridLayout = QGridLayout(self.centralwidget)
        self.gridLayout.setObjectName(u"gridLayout")
        self.verticalLayout = QVBoxLayout()
        self.verticalLayout.setObjectName(u"verticalLayout")
        self.tableView = QTableView(self.centralwidget)
        self.tableView.setObjectName(u"tableView")

        self.verticalLayout.addWidget(self.tableView)

        self.dateEdit = QDateEdit(self.centralwidget)
        self.dateEdit.setObjectName(u"dateEdit")

        self.verticalLayout.addWidget(self.dateEdit)

        self.gridLayout.addLayout(self.verticalLayout, 0, 0, 1, 1)

        MainWindow.setCentralWidget(self.centralwidget)
        self.menubar = QMenuBar(MainWindow)
        self.menubar.setObjectName(u"menubar")
        self.menubar.setGeometry(QRect(0, 0, 800, 33))
        MainWindow.setMenuBar(self.menubar)
        self.statusbar = QStatusBar(MainWindow)
        self.statusbar.setObjectName(u"statusbar")
        MainWindow.setStatusBar(self.statusbar)

        self.retranslateUi(MainWindow)

        QMetaObject.connectSlotsByName(MainWindow)
    # setupUi

    def retranslateUi(self, MainWindow):
        MainWindow.setWindowTitle(QCoreApplication.translate(
            "MainWindow", u"MainWindow", None))
    # retranslateUi

@dataclass
class File:
    path: Path = None
    id: int = None
    date: QDate = None

class FilesModel(QAbstractTableModel):
    class Column(IntEnum):
        ID = 0
        PATH = auto()
        DATE = auto()

    def __init__(self, source: list[Files] = []):
        super().__init__()
        self._files = source

    def data(self, index, role):
        match role:
            case Qt.ItemDataRole.DisplayRole | Qt.ItemDataRole.EditRole:
                f = self._files[index.row()]
                match index.column():
                    case self.Column.ID:
                        return f.id
                    case self.Column.PATH:
                        return f.path.name
                    case self.Column.DATE:
                        return f.date
                    case _:
                        return None

    def rowCount(self, index):
        return len(self._files)

    def columnCount(self, index):
        return len(self.Column)

    def headerData(self, section, orientation, role):
        if orientation == Qt.Orientation.Horizontal:
            if role == Qt.ItemDataRole.DisplayRole:
                return self.Column(section).name.capitalize()
    
    def flags(self, index):
        return (
            Qt.ItemFlag.ItemIsSelectable
            | Qt.ItemFlag.ItemIsEnabled
            | Qt.ItemFlag.ItemIsEditable
        )

    def setData(self, index, value, role):
        if role == Qt.ItemDataRole.EditRole:
            f = self._files[index.row()]
            match index.column():
                case self.Column.ID:
                    f.id = value
                    return True
                case self.Column.PATH:
                    f.path = value
                    return True
                case self.Column.DATE:
                    f.date = value
                    return True
                case _:
                    return False


class MainWindow(QMainWindow):
    def __init__(self):
        super(MainWindow, self).__init__()
        self.ui = Ui_MainWindow()
        self.ui.setupUi(self)


if __name__ == "__main__":
    app = QApplication(sys.argv)

    window = MainWindow()
    files_model = FilesModel([
        File(path=Path("test path 1"), id=0, date="2026-01-03"),
        File(path=Path("test path 2"), id=1, date="2025-02-14"),
        File(path=Path("test path 3"), id=2, date="2026-09-25")
    ])
    files_proxymodel = QSortFilterProxyModel()
    files_proxymodel.setSourceModel(files_model)
    window.ui.tableView.setModel(files_proxymodel)

    mapper = QDataWidgetMapper()
    mapper.setModel(files_proxymodel)
    mapper.addMapping(window.ui.dateEdit, FilesModel.Column.DATE)
    window.ui.tableView.selectionModel().currentRowChanged.connect(
        lambda c,p: mapper.setCurrentModelIndex(c)
    )

    window.show()
    sys.exit(app.exec())

aarqon

From a quick test it looks like hiding columns on the QSortFilterProxyModel was stopping the model from returning Date column data to the mapper. Which makes sense, I think? I will need to find another way to filter the table view columns instead.