文件系统模型协议：模仿 QFileSystemModel index() 方法的完整指南

2024-03-09 10:07:58

构建文件系统模型协议以模仿 QFileSystemModel 的 index() 和其重载

问题阐述

我们希望构建一个协议，用来模仿 Qt 框架中的 QFileSystemModel，以便使用该协议定义一个新的自定义类。该协议旨在为新类提供与 QFileSystemModel 相同的行为，特别是它的 index() 方法。然而，在实施过程中，我们遇到了两个 mypy 错误：

协议定义中的 index() 方法无法接受所有可能的参数。
尝试确保从 QFileSystemModel 派生的类满足协议时出现不兼容。

解决方法

CustomFileSystemModel：

由于 CustomFileSystemModel 直接从 QFileSystemModel 继承，因此它已经拥有了 index() 方法。因此，我们无需在 CustomFileSystemModel 中重新实现 index() 方法，只需要继承 QFileSystemModel 中的实现即可。

TableModel：

对于 TableModel，我们必须确保 index() 方法的实现完全遵循协议定义的类型提示。为此，我们将 index() 方法拆分为两个独立的方法：

一个用于处理 (row, column, parent) 参数。
另一个用于处理 (path, column) 参数。

改进后的代码

以下是改进后的代码：

import typing
from PyQt6 import QtCore, QtGui

class FileSystemModelProtocol(typing.Protocol):
    """定义 QFileSystemModel 方法的子集...用于定义具有相同行为的类"""
    def index(self, row: int, column: int, parent: QtCore.QModelIndex = ...) -> QtCore.QModelIndex: ...
    def index_from_path(self, path: typing.Optional[str], column: int = ...) -> QtCore.QModelIndex: ...

class CustomFileSystemModel(QtGui.QFileSystemModel):
    pass

class TableModel(QtCore.QAbstractTableModel, FileSystemModelProtocol):
    def index(self, row: int, column: int, parent: QtCore.QModelIndex = ...) -> QtCore.QModelIndex:
        return super().index(row, column, parent)

    def index_from_path(self, path: typing.Optional[str], column: int = ...) -> QtCore.QModelIndex:
        return QtCore.QModelIndex()  # TODO: lookup with path