Add Qt 6.10 support (added many property flags, and line numbers)

Author: matsjoyce-refeyn

.github/workflows/test.yml

@@ -17,12 +17,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        pyside6_version: [6.8.3]
+        pyside6_version: [6.10.0]
         include:
           - os: ubuntu-latest
-            pyside6_version: 6.7.3
+            pyside6_version: 6.8.3
           - os: ubuntu-latest
             pyside6_version: 6.9.3
+          - os: ubuntu-latest
+            pyside6_version: 6.10.0
             build_wheel: true
     runs-on: ${{ matrix.os }}
     name: "Test on ${{ matrix.os }} with PySide6 ${{ matrix.pyside6_version }}"

pyside6_qml_stubgen/__init__.py

@@ -33,7 +33,7 @@ def parse_module(
         ret.append(
             qmlregistrar_types.Module(
                 classes=[parse_class(cls, depends_on, extra_info)],
-                outputRevision=68,
+                outputRevision=69,
                 QML_IMPORT_MAJOR_VERSION=major,
                 QML_IMPORT_MINOR_VERSION=minor,
                 QT_MODULES=sorted(
@@ -65,6 +65,7 @@ def parse_class(
         className=meta.className(),
         qualifiedClassName=cls.__qualname__,
         object=True,
+        lineNumber=extra_info.find_line_number(cls),
         superClasses=[
             qmlregistrar_types.SuperClass(
                 access="public", name=meta.superClass().className()
@@ -112,7 +113,7 @@ def parse_enum(enum: QtCore.QMetaEnum) -> qmlregistrar_types.Enum:
         isClass=enum.isScoped(),
         isFlag=enum.isFlag(),
         name=str(enum.enumName()),
-        type="quint16",
+        lineNumber=0,  # TODO: Bit tricky as we don't get a reference to the class or module+name anywhere
         values=[str(enum.key(i)) for i in range(enum.keyCount())],
     )
 
@@ -142,9 +143,20 @@ def parse_property(
     return qmlregistrar_types.Property(
         name=str(prop.name()),
         type=resolve_type_name(
-            prop.typeName(), t, depends_on, extra_info  # type: ignore[arg-type]
+            prop.typeName(),
+            t,
+            depends_on,
+            extra_info,  # type: ignore[arg-type]
         ),
         index=prop.propertyIndex(),
+        lineNumber=extra_info.find_line_number(p.fget),
+        constant=prop.isConstant(),
+        designable=prop.isDesignable(),
+        final=prop.isFinal(),
+        required=prop.isRequired(),
+        scriptable=prop.isScriptable(),
+        stored=prop.isStored(),
+        user=prop.isUser(),
         notify=(
             bytes(prop.notifySignal().name().data()).decode()
             if prop.hasNotifySignal()
@@ -170,6 +182,9 @@ def parse_method(
     return qmlregistrar_types.Method(
         access="public",
         name=bytes(meth.name().data()).decode(),
+        index=meth.methodIndex(),
+        lineNumber=extra_info.find_line_number(m),
+        isConst=meth.isConst(),
         arguments=[
             qmlregistrar_types.Argument(
                 name=bytes(meth.parameterNames()[i].data()).decode() or n,

pyside6_qml_stubgen/pyside_patching.py

@@ -28,6 +28,9 @@ class ExtraCollectedInfo:
     module_dependencies: typing.DefaultDict[str, set[str]] = dataclasses.field(
         default_factory=lambda: collections.defaultdict(set)
     )
+    line_numbers: dict[QtCore.Signal | typing.Callable | type, int] = dataclasses.field(
+        default_factory=dict
+    )
 
     def lookup_cls_module(self, cls: type[QtCore.QObject]) -> str | None:
         for (uri, major, minor), clses in self.registered_classes.items():
@@ -41,8 +44,10 @@ def add_cls(
         version_major: int,
         version_minor: int,
         type_obj: type[QtCore.QObject],
+        line_number: int,
     ) -> None:
         self.registered_classes[uri, version_major, version_minor].add(type_obj)
+        self.line_numbers[type_obj] = line_number
         for base_cls in type_obj.__mro__:
             if isinstance(base_cls, type) and issubclass(base_cls, QtCore.QObject):
                 self.delayed_registrations[type_obj].add(base_cls)
@@ -57,6 +62,21 @@ def resolve_delayed(self) -> None:
                     self.registered_classes[module].add(linked_cls)
         self.delayed_registrations.clear()
 
+    def find_line_number(self, obj: QtCore.Signal | typing.Callable | type) -> int:
+        if obj in self.line_numbers:
+            return self.line_numbers[obj]
+        elif isinstance(obj, types.FunctionType):
+            return obj.__code__.co_firstlineno
+        elif isinstance(obj, type):
+            if lineno := getattr(obj, "__firstlineno__", None):
+                return lineno
+            try:
+                return inspect.getsourcelines(obj)[1]
+            except OSError:
+                return 0
+        else:
+            return 0
+
 
 def patch_with(mod: types.ModuleType) -> typing.Callable[[typing.Callable], None]:
     def w(fn: typing.Callable) -> None:
@@ -67,6 +87,18 @@ def w(fn: typing.Callable) -> None:
     return w
 
 
+def go_up(frame: types.FrameType | None, levels: int) -> types.FrameType | None:
+    if levels == 0:
+        return frame
+    return go_up(frame.f_back, levels - 1) if frame else None
+
+
+def get_line_number(stack_levels: int = 3) -> int:
+    frame = go_up(inspect.currentframe(), stack_levels)
+    assert frame is not None, "No caller frame"
+    return frame.f_lineno
+
+
 def patch_functions(info: ExtraCollectedInfo) -> None:
     @patch_with(QtQml)
     def qmlRegisterSingletonInstance(
@@ -81,7 +113,7 @@ def qmlRegisterSingletonInstance(
     ) -> None:
         info.extra_class_infos[type_obj].append(("QML.Singleton", "true"))
         info.extra_class_infos[type_obj].append(("QML.Element", qml_name))
-        info.add_cls(uri, version_major, version_minor, type_obj)
+        info.add_cls(uri, version_major, version_minor, type_obj, get_line_number())
         old_fn(type_obj, uri, version_major, version_minor, qml_name, callback)
 
     @patch_with(QtQml)
@@ -97,7 +129,7 @@ def qmlRegisterSingletonType(
     ) -> None:
         info.extra_class_infos[type_obj].append(("QML.Singleton", "true"))
         info.extra_class_infos[type_obj].append(("QML.Element", qml_name))
-        info.add_cls(uri, version_major, version_minor, type_obj)
+        info.add_cls(uri, version_major, version_minor, type_obj, get_line_number())
         old_fn(
             type_obj,
             uri,
@@ -118,7 +150,7 @@ def qmlRegisterType(
         old_fn: typing.Callable,
     ) -> None:
         info.extra_class_infos[type_obj].append(("QML.Element", qml_name))
-        info.add_cls(uri, version_major, version_minor, type_obj)
+        info.add_cls(uri, version_major, version_minor, type_obj, get_line_number())
         old_fn(type_obj, uri, version_major, version_minor, qml_name)
 
     @patch_with(QtQml)
@@ -148,16 +180,11 @@ def qmlRegisterUncreatableType(
         info.extra_class_infos[type_obj].append(("QML.Creatable", "false"))
         info.extra_class_infos[type_obj].append(("QML.UncreatableReason", message))
         info.extra_class_infos[type_obj].append(("QML.Element", qml_name))
-        info.add_cls(uri, version_major, version_minor, type_obj)
+        info.add_cls(uri, version_major, version_minor, type_obj, get_line_number())
         old_fn(type_obj, uri, version_major, version_minor, qml_name, message)
 
 
 def patch_class_decorators(info: ExtraCollectedInfo) -> None:
-    def go_up(frame: types.FrameType | None, levels: int) -> types.FrameType | None:
-        if levels == 0:
-            return frame
-        return go_up(frame.f_back, levels - 1) if frame else None
-
     def get_module(stack_levels: int = 3) -> tuple[str, int, int]:
         frame = go_up(inspect.currentframe(), stack_levels)
         assert frame is not None, "No caller frame"
@@ -192,7 +219,7 @@ def QmlElement(
     ) -> type[T_TypeQObject]:
         info.extra_class_infos[cls].append(("QML.Element", "auto"))
         mod_info = get_module()
-        info.add_cls(*mod_info, cls)
+        info.add_cls(*mod_info, cls, get_line_number())
         with module_in_globals(*mod_info):
             return old_fn(cls)
 
@@ -202,7 +229,7 @@ def QmlAnonymous(
     ) -> type[T_TypeQObject]:
         info.extra_class_infos[cls].append(("QML.Element", "anonymous"))
         mod_info = get_module()
-        info.add_cls(*mod_info, cls)
+        info.add_cls(*mod_info, cls, get_line_number())
         with module_in_globals(*mod_info):
             return old_fn(cls)
 
@@ -213,7 +240,7 @@ def QmlNamedElement(
         def w(cls: type[T_TypeQObject]) -> type[T_TypeQObject]:
             info.extra_class_infos[cls].append(("QML.Element", name))
             mod_info = get_module(stack_levels=2)
-            info.add_cls(*mod_info, cls)
+            info.add_cls(*mod_info, cls, get_line_number(stack_levels=2))
             with module_in_globals(*mod_info):
                 return old_fn(name)(cls)
 
@@ -242,7 +269,7 @@ def w(cls: type[T_TypeQObject]) -> type[T_TypeQObject]:
             except KeyError:
                 info.delayed_registrations[cls].add(type_obj)
             else:
-                info.add_cls(*module, cls)
+                info.add_cls(*module, cls, get_line_number(stack_levels=4))
             info.extra_class_infos[cls].append(
                 ("QML.Foreign", type_obj.staticMetaObject.className())  # type: ignore[attr-defined]
             )
@@ -260,7 +287,7 @@ def w(cls: type[T_TypeQObject]) -> type[T_TypeQObject]:
             except KeyError:
                 info.delayed_registrations[cls].add(type_obj)
             else:
-                info.add_cls(*module, cls)
+                info.add_cls(*module, cls, get_line_number(stack_levels=4))
             info.extra_class_infos[cls].append(
                 ("QML.Extended", type_obj.staticMetaObject.className())  # type: ignore[attr-defined]
             )
@@ -278,7 +305,7 @@ def w(cls: type[T_TypeQObject]) -> type[T_TypeQObject]:
             except KeyError:
                 info.delayed_registrations[cls].add(type_obj)
             else:
-                info.add_cls(*module, cls)
+                info.add_cls(*module, cls, get_line_number(stack_levels=4))
             info.extra_class_infos[cls].append(
                 ("QML.Attached", type_obj.staticMetaObject.className())  # type: ignore[attr-defined]
             )
@@ -344,6 +371,7 @@ def __subclasscheck__(self, subclass: type) -> bool:
         def __call__(self, *types: type | str, **kwargs: typing.Any) -> QtCore.Signal:
             sig = QtSignal(*types, **kwargs)  # type: ignore[arg-type]
             info.signal_types[sig] = (types, None)
+            info.line_numbers[sig] = get_line_number(stack_levels=2)
 
             return sig
 

pyside6_qml_stubgen/qmlregistrar_types.py

@@ -17,13 +17,25 @@ class Method:
     name: str
     arguments: typing.Sequence[Argument]
     returnType: str
+    index: int
+    lineNumber: int
+    isConst: bool
 
 
 @dataclasses.dataclass(frozen=True)
 class Property:
+    constant: bool
+    designable: bool
+    final: bool
+    index: int
+    lineNumber: int
     name: str
+    required: bool
+    scriptable: bool
+    stored: bool
     type: str
-    index: int
+    user: bool
+    bindable: str | None = None
     notify: str | None = None
     read: str | None = None
     write: str | None = None
@@ -34,8 +46,9 @@ class Enum:
     isClass: bool
     isFlag: bool
     name: str
-    type: str
+    lineNumber: int
     values: typing.Sequence[str]
+    type: str | None = None
 
 
 @dataclasses.dataclass(frozen=True)
@@ -55,6 +68,7 @@ class Class:
     className: str
     qualifiedClassName: str
     object: bool
+    lineNumber: int
     superClasses: typing.Sequence[SuperClass]
     classInfos: typing.Sequence[ClassInfo]
     enums: typing.Sequence[Enum]
@@ -66,7 +80,7 @@ class Class:
 @dataclasses.dataclass(frozen=True)
 class Module:
     classes: typing.Sequence[Class]
-    outputRevision: typing.Literal[68]
+    outputRevision: typing.Literal[69]
     QML_IMPORT_MAJOR_VERSION: int
     QML_IMPORT_MINOR_VERSION: int
     QT_MODULES: typing.Sequence[str]

tests/reference/6.10.0/metadata.json

@@ -0,0 +1,88 @@
+{
+    "modules": {
+        "in.advanced": {
+            "modification_time": 1763380832.973606,
+            "path": "C:\\Users\\matthew.joyce\\AppData\\Local\\Temp\\pytest-of-matthew.joyce\\pytest-973\\test_run_and_compare0\\in\\advanced.py",
+            "dependencies": [
+                "PySide6",
+                "PySide6.QtCore",
+                "PySide6.QtQml"
+            ]
+        },
+        "PySide6": {
+            "modification_time": 1763377813.7888794,
+            "path": "C:\\Users\\matthew.joyce\\Repos\\pyside6-qml-stubgen\\venv\\lib\\site-packages\\PySide6\\__init__.py",
+            "dependencies": []
+        },
+        "PySide6.QtCore": {
+            "modification_time": 1763377799.6107633,
+            "path": "C:\\Users\\matthew.joyce\\Repos\\pyside6-qml-stubgen\\venv\\lib\\site-packages\\PySide6\\QtCore.pyd",
+            "dependencies": []
+        },
+        "PySide6.QtQml": {
+            "modification_time": 1763377799.7451968,
+            "path": "C:\\Users\\matthew.joyce\\Repos\\pyside6-qml-stubgen\\venv\\lib\\site-packages\\PySide6\\QtQml.pyd",
+            "dependencies": []
+        },
+        "in.advanced2": {
+            "modification_time": 1763380832.9740903,
+            "path": "C:\\Users\\matthew.joyce\\AppData\\Local\\Temp\\pytest-of-matthew.joyce\\pytest-973\\test_run_and_compare0\\in\\advanced2.py",
+            "dependencies": [
+                "PySide6",
+                "PySide6.QtCore",
+                "PySide6.QtQml"
+            ]
+        },
+        "in.clses": {
+            "modification_time": 1763380832.974605,
+            "path": "C:\\Users\\matthew.joyce\\AppData\\Local\\Temp\\pytest-of-matthew.joyce\\pytest-973\\test_run_and_compare0\\in\\clses.py",
+            "dependencies": [
+                "PySide6",
+                "PySide6.QtCore",
+                "PySide6.QtGui",
+                "PySide6.QtQml",
+                "enum"
+            ]
+        },
+        "enum": {
+            "modification_time": 1680655642.0,
+            "path": "C:\\Program Files\\Python310\\lib\\enum.py",
+            "dependencies": []
+        },
+        "PySide6.QtGui": {
+            "modification_time": 1763377799.6517696,
+            "path": "C:\\Users\\matthew.joyce\\Repos\\pyside6-qml-stubgen\\venv\\lib\\site-packages\\PySide6\\QtGui.pyd",
+            "dependencies": []
+        },
+        "in.clses2": {
+            "modification_time": 1763380832.9750905,
+            "path": "C:\\Users\\matthew.joyce\\AppData\\Local\\Temp\\pytest-of-matthew.joyce\\pytest-973\\test_run_and_compare0\\in\\clses2.py",
+            "dependencies": [
+                "PySide6",
+                "PySide6.QtCore",
+                "PySide6.QtQml"
+            ]
+        },
+        "in.submodule": {
+            "modification_time": 1763380832.9750905,
+            "path": "C:\\Users\\matthew.joyce\\AppData\\Local\\Temp\\pytest-of-matthew.joyce\\pytest-973\\test_run_and_compare0\\in\\submodule.py",
+            "dependencies": [
+                "PySide6",
+                "PySide6.QtCore",
+                "PySide6.QtQml",
+                "in",
+                "in.clses"
+            ]
+        },
+        "in": {
+            "modification_time": 1763380832.97559,
+            "path": "C:\\Users\\matthew.joyce\\AppData\\Local\\Temp\\pytest-of-matthew.joyce\\pytest-973\\test_run_and_compare0\\in\\__init__.py",
+            "dependencies": [
+                "in",
+                "in.clses",
+                "in.clses2"
+            ]
+        }
+    },
+    "generating_version": "0.1.0a9.dev0+g9d7de2861.d20251020"
+}