PyQt5库学习之QFileDialog.getOpenFileName函数

一、简介

QFileDialog.getOpenFileName 是 PyQt5 中的一个函数，它提供了一个标准的文件选择对话框，允许用户选择一个文件。这个函数是 QFileDialog 类的一部分，通常用于打开文件时让用户选择文件路径。

二、语法和参数

语法：

QFileDialog.getOpenFileName(parent, title, directory, filter, selectedFilter, options)

参数：

• parent: 对话框的父窗口。
• title: 对话框的标题。
• directory: 打开对话框时显示的默认目录。
• filter: 文件过滤器，用于限制用户可以选择的文件类型。
• selectedFilter: 返回用户选择的过滤器。
• options: 对话框选项，QFileDialog.Options 类型。

返回值：
返回一个元组，包含用户选择的文件名和用户选择的过滤器。

三、实例

3.1 基本用法

• 代码：

from PyQt5.QtWidgets import QApplication, QFileDialog

app = QApplication([])
fileName, _ = QFileDialog.getOpenFileName(None, "Open File", "", "All Files (*);;Text Files (*.txt)")
print("Selected file:", fileName)

• 输出：

Selected file: /path/to/your/file.txt

3.2 设置默认文件类型

• 代码：

from PyQt5.QtWidgets import QApplication, QFileDialog
from PyQt5.QtWidgets import QMainWindow

class MainWindow(QMainWindow):
    def __init__(self):
        super().__init__()
        self.setWindowTitle("File Dialog Example")
        self.setGeometry(100, 100, 400, 300)
        self.btn_open = self.init_ui()

    def init_ui(self):
        button = QFileDialog.getOpenFileName(self, "Open File", "", 
                                             "Image Files (*.png *.jpg *.bmp);;Text Files (*.txt);;All Files (*)")
        return button

def main():
    app = QApplication([])
    window = MainWindow()
    window.show()
    app.exec_()

if __name__ == '__main__':
    main()

• 输出：

Selected file: /path/to/your/file.jpg

四、filter书写

在 QFileDialog.getOpenFileName 函数中，filter 参数用于指定用户可以选择的文件类型。这个参数是一个字符串，它定义了一个或多个文件类型过滤器，每个过滤器可以包含一个描述和一组相应的文件扩展名。

4.1 编写 filter 参数的格式

filter 参数的格式通常如下：

"Filter Description (*.extension1 *.extension2 ...);;Another Description (*.extension3 *.extension4 ...);;All Files (*)"

• Filter Description: 这是显示给用户的描述性文本，它应该简洁明了地说明过滤器是用于哪种类型的文件。
• *.extension1, *.extension2, …: 这些是文件扩展名，用户将只能选择这些类型的文件。扩展名前的星号是必需的，它是一个通配符，表示匹配任何以该扩展名结尾的文件。
• 分号 ;;: 分号用于分隔不同的过滤器。每个过滤器描述和其对应的文件扩展名都应该以分号结束。
• All Files (*): 通常，你会提供一个选项来选择所有类型的文件。这是通过 “All Files (*)” 实现的，它允许用户选择任何文件，无论其扩展名如何。

4.2 示例

假设你想要提供一个文件选择对话框，让用户可以选择文本文件、图像文件或任何文件，你可以这样编写 filter 参数：

filter = "Text Files (*.txt);;Image Files (*.png *.jpg *.bmp);;All Files (*)"

五、注意事项

1. parent 参数可以是 None，表示对话框没有父窗口。
2. directory 参数可以是默认的文件路径，用户可以从该路径开始浏览。
3. filter 参数定义了文件选择的过滤器，用户可以通过下拉菜单选择不同的文件类型;确保过滤器描述和文件扩展名之间有空格。。
4. selectedFilter 参数在函数返回时会包含用户实际选择的过滤器。
5. options 参数可以是 QFileDialog.Options 的实例，用于设置对话框的各种选项。
6. 如果用户取消选择，getOpenFileName 将返回一个空字符串作为文件名。
7. 在设置 filter 参数时，可以使用分号 ;; 来分隔不同的文件类型。
8. 确保在调用 getOpenFileName 时，应用程序的事件循环已经启动，否则对话框可能无法正确显示。