pyproject.toml: 2. Add pyproject.toml support for pyside6 tools

This patch adds support for pyproject.toml files to the pyside6-project
tool. A new command argument is added to migrate a .pyproject JSON file
to the new pyproject.toml file:
`pyside6-project migrate-pyproject`

The new features are tested and it is guaranteed that the current
behavior is preserved. A new flag is added to the project creation operations, "--legacy-pyproject", in order to generate a .pyproject file instead of a pyproject.toml file.

Note that the tomlkit library is added to the requirements.txt file.
https://github.com/python-poetry/tomlkit

Task-number: PYSIDE-2714
Change-Id: If33956dea73b79df0a52d4dcda3934c85e57182d
Reviewed-by: Friedemann Kleint <[email protected]>

Author: Jaime Resano

requirements.txt

@@ -9,3 +9,4 @@ patchelf==0.17.2; sys_platform == 'linux'
 numpy<=2.0.2; python_version <= '3.9'
 numpy==2.1.3; python_version > '3.9'
 mypy[faster-cache]>=1.14.0
+tomlkit==0.12.1

sources/pyside-tools/project.py

@@ -7,11 +7,11 @@
 from pathlib import Path
 from argparse import ArgumentParser, RawTextHelpFormatter
 
-from project_lib import (QmlProjectData, check_qml_decorators, is_python_file,
-                         QMLDIR_FILE, MOD_CMD, METATYPES_JSON_SUFFIX,
-                         SHADER_SUFFIXES, TRANSLATION_SUFFIX, requires_rebuild, run_command,
-                         remove_path, ProjectData, resolve_valid_project_file, new_project,
-                         NewProjectTypes, ClOptions, DesignStudioProject)
+from project_lib import (QmlProjectData, check_qml_decorators, is_python_file, migrate_pyproject,
+                         QMLDIR_FILE, MOD_CMD, METATYPES_JSON_SUFFIX, SHADER_SUFFIXES,
+                         TRANSLATION_SUFFIX, requires_rebuild, run_command, remove_path,
+                         ProjectData, resolve_valid_project_file, new_project, NewProjectTypes,
+                         ClOptions, DesignStudioProject)
 
 DESCRIPTION = """
 pyside6-project is a command line tool for creating, building and deploying Qt for Python
@@ -29,6 +29,7 @@
     "qmllint": "Run the qmllint tool on QML files in the project.",
     "deploy": "Create a deployable package of the application including all dependencies.",
     "lupdate": "Update translation files (.ts) with new strings from source files.",
+    "migrate-pyproject": "Migrate a *.pyproject file to pyproject.toml format."
 }
 
 UIC_CMD = "pyside6-uic"
@@ -263,7 +264,8 @@ def lupdate(self):
 
 
 def main(mode: str = None, dry_run: bool = False, quiet: bool = False, force: bool = False,
-         qml_module: bool = None, project_dir: str = None, project_path: str = None):
+         qml_module: bool = None, project_dir: str = None, project_path: str = None,
+         legacy_pyproject: bool = False):
     cl_options = ClOptions(dry_run=dry_run, quiet=quiet,  # noqa: F841
                            force=force, qml_module=qml_module)
 
@@ -281,7 +283,10 @@ def main(mode: str = None, dry_run: bool = False, quiet: bool = False, force: bo
             print("Invalid project name", file=sys.stderr)
             sys.exit(1)
 
-        sys.exit(new_project(project_dir, new_project_type))
+        sys.exit(new_project(project_dir, new_project_type, legacy_pyproject))
+
+    if mode == "migrate-pyproject":
+        sys.exit(migrate_pyproject(project_path))
 
     try:
         project_file = resolve_valid_project_file(project_path)
@@ -325,6 +330,9 @@ def main(mode: str = None, dry_run: bool = False, quiet: bool = False, force: bo
         new_parser.add_argument(
             "project_dir", help="Name or location of the new project", nargs="?", type=str)
 
+        new_parser.add_argument(
+            "--legacy-pyproject", action="store_true", help="Create a legacy *.pyproject file")
+
     # Add subparser for project operation commands
     for op_mode, op_help in OPERATION_HELP.items():
         op_parser = subparsers.add_parser(op_mode, help=op_help)
@@ -333,4 +341,5 @@ def main(mode: str = None, dry_run: bool = False, quiet: bool = False, force: bo
     args = parser.parse_args()
 
     main(args.mode, args.dry_run, args.quiet, args.force, args.qml_module,
-         getattr(args, "project_dir", None), getattr(args, "project_path", None))
+         getattr(args, "project_dir", None), getattr(args, "project_path", None),
+         getattr(args, "legacy_pyproject", None))

sources/pyside-tools/project_lib/__init__.py

@@ -7,9 +7,10 @@
 QTPATHS_CMD = "qtpaths6"
 MOD_CMD = "pyside6-metaobjectdump"
 
+PYPROJECT_TOML_PATTERN = "pyproject.toml"
 PYPROJECT_JSON_PATTERN = "*.pyproject"
 # Note that the order is important, as the first pattern that matches is used
-PYPROJECT_FILE_PATTERNS = [PYPROJECT_JSON_PATTERN]
+PYPROJECT_FILE_PATTERNS = [PYPROJECT_TOML_PATTERN, PYPROJECT_JSON_PATTERN]
 QMLDIR_FILE = "qmldir"
 
 QML_IMPORT_NAME = "QML_IMPORT_NAME"
@@ -48,4 +49,5 @@ class ClOptions(metaclass=Singleton):
                            check_qml_decorators)
 from .newproject import new_project, NewProjectTypes
 from .design_studio_project import DesignStudioProject
+from .pyproject_toml import parse_pyproject_toml, write_pyproject_toml, migrate_pyproject
 from .pyproject_json import parse_pyproject_json

sources/pyside-tools/project_lib/newproject.py

@@ -2,13 +2,14 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 from __future__ import annotations
 
-import json
 import os
 import sys
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
-from typing import Callable
+
+from .pyproject_toml import write_pyproject_toml
+from .pyproject_json import write_pyproject_json
 
 """New project generation code."""
 
@@ -19,23 +20,19 @@
     sys.exit(app.exec())
 """
 
-
 _WIDGET_IMPORTS = """import sys
 from PySide6.QtWidgets import QApplication, QMainWindow
 """
 
-
 _WIDGET_CLASS_DEFINITION = """class MainWindow(QMainWindow):
     def __init__(self):
         super().__init__()
 """
 
-
 _WIDGET_SETUP_UI_CODE = """        self._ui = Ui_MainWindow()
         self._ui.setupUi(self)
 """
 
-
 _MAINWINDOW_FORM = """<?xml version="1.0" encoding="UTF-8"?>
 <ui version="4.0">
  <class>MainWindow</class>
@@ -67,7 +64,6 @@ def __init__(self):
 </ui>
 """
 
-
 _QUICK_FORM = """import QtQuick
 import QtQuick.Controls
 
@@ -99,18 +95,17 @@ def __init__(self):
     sys.exit(exit_code)
 """
 
+NewProjectFiles = list[tuple[str, str]]  # tuple of (filename, contents).
+
 
 @dataclass(frozen=True)
 class NewProjectType:
     command: str
     description: str
-    get_files: Callable
-
-
-NewProjectFiles = list[tuple[str, str]]  # tuple of (filename, contents).
+    files: NewProjectFiles
 
 
-def _write_project(directory: Path, files: NewProjectFiles):
+def _write_project(directory: Path, files: NewProjectFiles, legacy_pyproject: bool):
     """
     Create the project files in the specified directory.
 
@@ -123,9 +118,12 @@ def _write_project(directory: Path, files: NewProjectFiles):
         print(f"Wrote {directory.name}{os.sep}{file_name}.")
         file_names.append(file_name)
 
-    pyproject = {"files": files}
-    pyproject_file = f"{directory}.pyproject"
-    (directory / pyproject_file).write_text(json.dumps(pyproject))
+    if legacy_pyproject:
+        pyproject_file = directory / f"{directory.name}.pyproject"
+        write_pyproject_json(pyproject_file, file_names)
+    else:
+        pyproject_file = directory / "pyproject.toml"
+        write_pyproject_toml(pyproject_file, directory.name, file_names)
     print(f"Wrote {pyproject_file}.")
 
 
@@ -153,16 +151,19 @@ def _qml_project() -> NewProjectFiles:
 
 
 class NewProjectTypes(Enum):
-    QUICK = NewProjectType("new-quick", "Create a new Qt Quick project", _qml_project)
-    WIDGET_FORM = NewProjectType("new-ui", "Create a new Qt Widgets Form project", _ui_form_project)
-    WIDGET = NewProjectType("new-widget", "Create a new Qt Widgets project", _widget_project)
+    QUICK = NewProjectType("new-quick", "Create a new Qt Quick project", _qml_project())
+    WIDGET_FORM = NewProjectType("new-ui", "Create a new Qt Widgets Form project",
+                                 _ui_form_project())
+    WIDGET = NewProjectType("new-widget", "Create a new Qt Widgets project", _widget_project())
 
     @staticmethod
     def find_by_command(command: str) -> NewProjectType | None:
         return next((pt.value for pt in NewProjectTypes if pt.value.command == command), None)
 
 
-def new_project(project_dir: Path, project_type: NewProjectType) -> int:
+def new_project(
+    project_dir: Path, project_type: NewProjectType, legacy_pyproject: bool
+) -> int:
     """
     Create a new project at the specified project_dir directory.
 
@@ -176,15 +177,13 @@ def new_project(project_dir: Path, project_type: NewProjectType) -> int:
         return 1
     project_dir.mkdir(parents=True, exist_ok=True)
 
-    files = project_type.get_files()
-
     try:
-        _write_project(project_dir, files)
+        _write_project(project_dir, project_type.files, legacy_pyproject)
     except Exception as e:
         print(f"Error creating project file: {str(e)}", file=sys.stderr)
         return 1
 
     if project_type == NewProjectTypes.WIDGET_FORM:
         print(f'Run "pyside6-project build {project_dir}" to build the project')
-    print(f'Run "pyside6-project run {project_dir}{os.sep}main.py" to run the project')
+    print(f'Run "pyside6-project run {project_dir / "main.py"}" to run the project')
     return 0

sources/pyside-tools/project_lib/project_data.py

@@ -7,9 +7,10 @@
 import subprocess
 import sys
 from pathlib import Path
-from . import (METATYPES_JSON_SUFFIX, PYPROJECT_JSON_PATTERN,
+from . import (METATYPES_JSON_SUFFIX, PYPROJECT_JSON_PATTERN, PYPROJECT_TOML_PATTERN,
                PYPROJECT_FILE_PATTERNS, TRANSLATION_SUFFIX, qt_metatype_json_dir, MOD_CMD,
                QML_IMPORT_MAJOR_VERSION, QML_IMPORT_MINOR_VERSION, QML_IMPORT_NAME, QT_MODULES)
+from .pyproject_toml import parse_pyproject_toml
 from .pyproject_json import parse_pyproject_json
 
 
@@ -40,6 +41,8 @@ def __init__(self, project_file: Path) -> None:
 
         if project_file.match(PYPROJECT_JSON_PATTERN):
             project_file_data = parse_pyproject_json(project_file)
+        elif project_file.match(PYPROJECT_TOML_PATTERN):
+            project_file_data = parse_pyproject_toml(project_file)
         else:
             print(f"Unknown project file format: {project_file}", file=sys.stderr)
             sys.exit(1)

sources/pyside-tools/project_lib/pyproject_json.py

@@ -6,6 +6,21 @@
 from .pyproject_parse_result import PyProjectParseResult
 
 
+def write_pyproject_json(pyproject_file: Path, project_files: list[str]):
+    """
+    Create or update a *.pyproject file with the specified content.
+
+    :param pyproject_file: The *.pyproject file path to create or update.
+    :param project_files: The relative paths of the files to include in the project.
+    """
+    # The content of the file is fully replaced, so it is not necessary to read and merge any
+    # existing content
+    content = {
+        "files": sorted(project_files),
+    }
+    pyproject_file.write_text(json.dumps(content), encoding="utf-8")
+
+
 def parse_pyproject_json(pyproject_json_file: Path) -> PyProjectParseResult:
     """
     Parse a pyproject.json file and return a PyProjectParseResult object.