1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
.. _pyside6-qml:
pyside6-qml
===========
``pyside6-qml`` mimics some capabilities of Qt's `qml <qml_runtime>`_ runtime utility by directly
invoking QQmlEngine/QQuickView. It enables prototyping with QML/QtQuick without the need to write
any Python code that loads the QML files either through `QQmlApplicationEngine <qqmlappengine>`_ or
the `QQuickView <qquickview>`_ class. The tool also detects the QML classes implemented in Python
and registers them with the QML type system.
Usage
-----
Consider the example `Extending QML - Plugins Example <extending_qml_example>`_. This example does
not have a Python file with a ``main`` function that initializes a QmlEngine to load the QML file
``app.qml``. You can run the example by running
.. code-block:: bash
pyside6-qml examples/qml/tutorials/extending-qml/chapter6-plugins/app.qml -I examples/qml/tutorials/extending-qml/chapter6-plugins/Charts
The ``-I`` flag is used to point ``pyside6-qml`` to the folder containing Python files that
implement QML classes.
Command Line Options
--------------------
Here are all the command line options of ``pyside6-qml``:
Arguments
^^^^^^^^^
* **file**: This option refers to the QML file to be loaded by ``pyside6-qml``. This option does not
have a name or a flag. Therefore, this option should be the first option supplied to
``pyside6-qml``. For example,
.. code-block:: bash
pyside6-qml /path/to/test.qml
Options
^^^^^^^
* **--module-paths/-I**: Specify space-separated folder/file paths which point to the Python files
that implement QML classes. By default, the parent directory of the QML file supplied to
``pyside6-qml`` is searched recursively for all Python files and they are imported. Otherwise,
only the paths given in module paths are searched.
* **--verbose/-v**: Run ``pyside6-qml`` in verbose mode. When run in this mode, pyside6-qml prints
log messages during various stages of processing.
Options that align with `QML <qml_runtime>`_ runtime utility
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* **--app-typ/-a**: Specifies which application class to use. It takes one of the three values -
``core, gui, widget``. The default value is *gui*.
* **--config/-c**: Load the given built-in configuration. It takes one of two values - ``default,
resizeToItem``. This option is only relevant for a QtQuick application. If ``default`` is used,
the view resizes to the size of the root item in the QML. If ``resizeToItem`` is used, the view
automatically resizes the root item to the size of the view.
* **--list-conf**: List the built-in configurations. ``pyside6-qml`` has two built-in configurations
- ``default`` and ``resizeToItem``. See the option ``--config`` for more information.
* **--rhi/-r**: Specifies the backend for the Qt graphics abstraction (RHI). It takes one of the
four values - ``vulkan, metal, d3dll, gl``.
* **--verbose/-v**: List the built-in configurations. ``pyside6-qml`` has two built-in
configurations - *default* and *resizeToItem*. See the option ``--config`` for more information.
* **--gles**: Force use of GLES (AA_UseOpenGLES).
* **--desktop**: Force use of desktop OpenGL (AA_UseDesktopOpenGL).
* **--software**: Force use of software rendering(AA_UseSoftwareOpenGL).
* **--disable-context-sharing**: Disable the use of a shared GL context for QtQuick Windows".
.. _`qml_runtime`: https://doc.qt.io/qt-6/qtquick-qml-runtime.html
.. _`qqmlappengine`: https://doc.qt.io/qt-6/qqmlapplicationengine.html
.. _`qquickview`: https://doc.qt.io/qt-6/qquickview.html
.. _`extending_qml_example`: https://doc.qt.io/qtforpython-6/examples/example_qml_tutorials_extending-qml_chapter6-plugins.html
|
