Update qrc-rcc

Author: muziing

07-Packaging-资源管理与打包/01-资源管理/01-在PyQt中使用qrc-rcc资源系统.md

@@ -118,48 +118,48 @@ Qt Resource Compiler version 6.4.1
 
 Options:
   -h, --help                            显示关于命令行选项的帮助
-  
+
   --help-all                            显示包括Qt独有选项在内的所有帮助
-  
+
   -v, --version                         显示版本信息
-  
+
   -o, --output <file>                   将输出写入到 <file> 中，而不是 stdout 中
 
   -t, --temp <file>                     为大资源文件使用临时文件 <file>
-  
+
   --name <name>                         用 <name> 创建一个外部初始化函数
-  
+
   --root <path>                         用根目录 <path> 作为资源访问路径的前缀
-  
+
   --compress-algo <algo>                使用 <algo> 算法压缩输入文件([zlib], none)
-  
+
   --compress <level>                    按 <level> 级别压缩输入文件
-  
+
   --no-compress                         禁用所有压缩，等同于 --compress-algo=none
-  
+
   --no-zstd                             禁止使用 zstd 压缩
-  
+
   --threshold <level>                   衡量是否值得进行压缩的阈值
-  
+
   --binary                              输出一个作为动态资源使用的二进制文件
-  
+
   -g, --generator <cpp|python|python2>  选择生成器
-  
+
   --pass <number>                       Pass number for big resources
-  
+
   --namespace                           关闭命名空间宏
-  
+
   --verbose                             启用 verbose 模式
-  
+
   --list                                只列出 .qrc 文件条目，不生成代码
-  
+
   --list-mapping                        只输出 .qrc 中定义的资源路径与文件系统路径的
                                         映射，不生成代码
-                                        
+
   -d, --depfile <file>                  向 <file> 中写入一个包含 .qrc 依赖项的 depfile
 
   --project                             输出一个包含当前目录下所有文件的资源文件
-  
+
   --format-version <number>             写入 RCC 格式的版本
 
 Arguments:
@@ -302,6 +302,15 @@ def get_about_text():
     return about_text
 ```
 
+或者使用本项目提供的 [`OpenQFile`](./open_qfile.py)：
+
+```python
+from open_qfile import OpenQFile
+
+with OpenQFile(":/texts/About_Text", "rt", encoding="utf-8") as f:
+    about_text = f.read()
+```
+
 对于图片，可以在创建 [QIcon](https://doc.qt.io/qt-6/qicon.html)、[QImage](https://doc.qt.io/qt-6/qimage.html)、[QPixmap](https://doc.qt.io/qt-6/qpixmap.html) 对象时将直接资源路径作为参数传入：
 
 ```python

07-Packaging-资源管理与打包/01-资源管理/open_qfile.py

@@ -0,0 +1,183 @@
+import locale
+import os
+import warnings
+from typing import Optional, Union
+
+from PySide6.QtCore import QFile, QIODevice
+
+
+class OpenQFile:
+    """
+    用于以QFile形式打开文件的上下文管理器 \n
+    使支持 Python 的 with 风格 \n
+    """
+
+    def __init__(self, file: Union[str, bytes, os.PathLike[str]],
+                 mode="r",
+                 encoding: Optional[str] = None):
+        """
+        :param file: 文件路径
+        :param mode: 打开模式（暂时只支持文本读取）
+        :param encoding: 文本文件编码
+        """
+
+        # 分析模式是否合法、返回正确的 FileIo 类实例
+        # https://docs.python.org/zh-cn/3/library/functions.html#open
+        if "b" not in mode:
+            # 文本模式
+            self.io_obj = PyQTextFileIo(file, mode, encoding)
+        else:
+            # 二进制模式（暂不支持）
+            # self.io_obj = PyQByteFileIo(file, mode)
+            raise ValueError("暂不支持该模式")
+
+    def __enter__(self):
+        return self.io_obj
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.io_obj.close()
+
+
+class PyQTextFileIo:
+    """
+    将 QFile 中处理文本文件读写的部分封装成 Python的 io 风格
+    目前只支持读取，不支持写入
+    """
+
+    @classmethod
+    def _parse_mode(cls, py_mode: str) -> QIODevice:
+        """
+        解析文件打开模式，将 Python open() 风格转换至 QIODevice.OpenModeFlag
+        https://docs.python.org/zh-cn/3/library/functions.html#open
+        https://doc.qt.io/qt-6/qiodevicebase.html#OpenModeFlag-enum
+        :return: mode
+        """
+
+        qt_mode: QIODevice = QIODevice.Text
+
+        # 暂不支持写入
+        if "r" in py_mode and "+" not in py_mode:
+            qt_mode = qt_mode | QIODevice.ReadOnly
+        elif "w" in py_mode:
+            qt_mode = qt_mode | QIODevice.WriteOnly
+        elif "+" in py_mode:
+            qt_mode = qt_mode | QIODevice.ReadWrite
+
+        if "x" in py_mode:
+            qt_mode = qt_mode | QIODevice.NewOnly
+
+        return qt_mode
+
+    def __init__(self, file: Union[str, bytes, os.PathLike[str]],
+                 mode,
+                 encoding: Optional[str] = None):
+
+        self._file = QFile(file)  # TODO 处理 QFile 只接受`/`风格路径可能导致 Windows 平台异常的问题
+
+        if encoding is not None:
+            self.encoding = encoding
+        else:
+            # 用户未指定编码，则使用当前平台默认编码
+            self.encoding = locale.getencoding()
+
+        self.mode = self._parse_mode(mode)
+        self._file.open(self.mode)
+
+    def readable(self) -> bool:
+        """
+        当前文件是否可读 \n
+        :return: isReadable
+        """
+        return self._file.isReadable()
+
+    def read(self, size: int = -1) -> str:
+        """
+        从流中读取至多 size 个字符并以单个 str 的形式返回。 如果 size 为负值或 None，则读取至 EOF。 \n
+        https://docs.python.org/3/library/io.html#io.TextIOBase.read
+        :param size: 读取的字符数，负值或 None 表示一直读取直到 EOF
+        :return: 文件中读出的文本内容
+        """
+
+        if not self.readable():
+            raise OSError(f"File '{self._file.fileName()}' is not Readable.")
+
+        if size < 0 or size is None:
+            # 读取文件，并将 QByteArray 转为 str
+            text = str(self._file.readAll(), encoding=self.encoding)
+        else:
+            # 已知问题：性能太差
+            # PySide6.QtCore.QIODevice.read(maxlen) 以字节而非字符方式计算长度，行为不一致
+            # 而 QTextStream 对字符编码支持太差，许多编码并不支持
+            text = str(self._file.readAll(), encoding=self.encoding)[0:size]  # 性能太差
+
+        return text
+
+    def readline(self, size: int = - 1, /) -> str:
+        """
+        模仿 io.TextIOBase.readline 的行为，读取文件中的一行。 \n
+        https://docs.python.org/3/library/io.html#io.TextIOBase.readline
+        :param size: 如果指定了 size ，最多将读取 size 个字符。
+        :return: 单行文本
+        """
+
+        if not self.readable():
+            raise OSError(f"File '{self._file.fileName()}' is not Readable.")
+
+        if self._file.atEnd():
+            warnings.warn(f"Trying to read a line at the end of the file '{self._file.fileName()}'.")
+            return ""
+        else:
+            if size == 0:
+                return ""
+            else:
+                line = str(self._file.readLine(), encoding=self.encoding)
+                if size < 0:
+                    return line
+                else:
+                    return line[0:size]
+
+    def readlines(self, hint: int = -1, /) -> list[str]:
+        """
+        模仿 Python 中 io.IOBase.readlines() 的行为，返回由所有行组成的字符串列表。 \n
+        Known issue： slower than `readline()` \n
+        https://docs.python.org/3/library/io.html#io.IOBase.readlines
+        :param hint: 要读取的字符数
+        :return: 文本内容所有行组成的列表
+        """
+
+        if not self.readable():
+            raise OSError(f"File '{self._file.fileName()}' is not Readable.")
+
+        if hint <= 0 or hint is None:
+            temp = str(self._file.readAll(), encoding=self.encoding)
+            all_lines = temp.splitlines(keepends=True)
+        else:
+            all_lines = []
+            char_num = 0
+            while char_num <= hint and not self._file.atEnd():
+                new_line = self.readline()
+                all_lines.append(new_line)
+                char_num += len(new_line)
+
+        return all_lines
+
+    def close(self):
+        self._file.close()
+
+
+if __name__ == "__main__":
+    with OpenQFile(b"./test.txt", "rt", encoding="gbk") as f:
+        print(f.read(11))
+        # print(f.readline())
+        # lines = f.readlines()
+        # print(lines)
+
+    print("-----------")
+
+    with open("./test.txt", "rt", encoding="gbk") as f:
+        print(f.read(11))
+        # print(f.readline())
+        # lines = f.readlines()
+        # print(lines)
+
+    # f.read()  # 离开 with 语句块后文件已经被关闭，无法再读