Qt Wiki - User contributions [en]

Qt for Python/Tutorial

2018-05-27T15:22:22Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
'''(Page under construction)'''

== Examples ==
The best way to start learning about Qt for Python is to start coding examples.
Here we try to provide a set of simple examples that will help you understand all the main topics behind every Qt for Python application.

* [[Qt for Python Tutorial HelloWorld|Hello World (QLabel)]]
* [[Qt for Python Tutorial HelloQML|Hello World (QML)]]
* [[Qt for Python Tutorial HelloQMessageBox|Hello World (QMessageBox)]]
* [[Qt for Python Tutorial ClickableButton|Simple clickable button]]
* [[Qt for Python Tutorial SimpleDialog|Simple Dialog]]

== Concepts ==

* [[Qt for Python Signals and Slots|Signals and Slots]]
* [[Qt for Python UsingQtProperties|Using Qt Properties]]
* [[Qt for Python DBusIntegration| DBUS Integration]]
* [[Qt for Python UiFiles|Using ui files]]

Qt for Python/GettingStarted/MacOS

2018-05-27T15:22:09Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
==== Requirements ====
* [https://developer.apple.com/xcode/ Xcode] 8.2 (macOS 10.11), 8.3.3 (macOS 10.12) or 9 (macOS 10.13)
* A Python interpreter (version '''Python 3.6''' or '''Python 2.7'''). One possibility is to to use a package from https://www.python.org/downloads/ , it is also possible to use a Homebrew / MacPorts provided python.
** System Python usage is discouraged, because package installation will attempt to write into system folders and might fail in different ways because of system permissions (unless you use a virtualenv)
* [http://download.qt.io/official_releases/online_installers/qt-unified-mac-x64-online.dmg Qt 5.6+]
* [http://download.qt.io/development_releases/prebuilt/libclang/ libclang 3.9 or 4.0] (for 5.9+ branches)
* CMake from https://cmake.org/download/ ('''>= 3.1''')
* Git ('''>=2''')
* virtualenv ('''strongly recommended''', but optional)
* Python sphinx package for documentation (optional, pip install sphinx) - documentation generation currently does not work on maCOS
* '''No''' OpenSSL is required because Qt uses [https://developer.apple.com/documentation/security/secure_transport Secure Transport (Apple)] instead.

=== Building from sources ===
==== Setting up CLANG ====
* Download [http://download.qt.io/development_releases/prebuilt/libclang/ libclang], e.g.
wget http://download.qt.io/development_releases/prebuilt/libclang/libclang-release_39-mac.7z
* Extract the files, e.g.
7z x libclang-release_39-mac.7z
* Export the installation path to the path you choosed to place the files
export CLANG_INSTALL_DIR=$PWD/libclang
==== Getting PySide2 ====
* Clone the official repository
git clone --recursive https://code.qt.io/pyside/pyside-setup
* Check out the version you want to build, e.g. 5.9 (Keep in mind you need to use the same version as your Qt installation)
cd pyside-setup && git checkout 5.9

==== Building PySide2 ====
* Check your Qt installation path, to specifically use that version of ''qmake'' to build PySide2:
which qmake
* Strongly consider using a virtualenv (to avoid permission issues when building and installing)
virtualenv testenv; source testenv/bin/activate
* Check which Python interpreter is being picked up in PATH (system one, homebrew one, MacPorts one, virtualenv one, or some other) because this influences where the PySide2 package will be installed:
which python
* Build can take a few minutes, so it is recommended to use more than one CPU core (e.g. 8). Remember to replace the paths to your current ''qmake'' path:
python setup.py build --qmake=/path/to/qmake --build-tests --ignore-git --jobs=8

==== Installing PySide2 ====
* To install the PySide2 package into the currently active Python environment (regular, or virtualenv), just run:
python setup.py install --qmake=/path/to/qmake --build-tests --ignore-git --jobs=8

==== Test installation ====
* You can execute one of the examples to verify the process is properly working.
* Remember to properly set the environment variables for Qt and PySide2.
python examples/examples/widgets/widgets/tetrix.py
== Development ==
Development happens in the 5.9 and dev branches of the [http://code.qt.io/cgit/pyside/pyside-setup.git/ pyside-setup repository].
The top level repository has the following submodules:
* sources/pyside2-tools: uic, rcc tools
* examples/ (5.6 only, examples are no longer a submodule in 5.9+)
Contributions follow the [[Qt_Project_Guidelines|standard process]].
It is helpful to have debug binaries and/or symbols for Python available.
On macOS you will need to build the Python interpreter with debug symbols by hand.
It is also recommended to use a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ Virtual Environment] for testing to be able to always start from a clean base and avoid issues with write permissions in installations.
On macOS, the command
virtualenv -p /usr/bin/python3-dbg testenv
creates a Virtual Environment named ''testenv'' for debugging purposes.
Before building the first time, the module [http://www.sphinx-doc.org/en/1.4.9/ Sphinx] should be installed into the virtual environment:
pip install sphinx

Qt for Python/es

2018-05-27T15:21:50Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
{{LangSwitch}}
== Qt para Python ==
El proyecto '''Qt para Python''' tiene como fin proveer un port completo del module [[PySide]] para Qt 5. El desarrollo comenzó en [https://github.com/PySide GitHub] en Mayo del 2015. El proyecto finalizó el primer port a Qt 5.3, 5.4 & 5.5. Durante Abril del 2016 The Qt Company decidió apoyar el port (ver [https://groups.google.com/forum/#!topic/pyside-dev/pqwzngAGLWE detalles] ).

Esta página wiki monitorea el progreso del proyecto '''Qt para Python''' y provee información adicional relacionada el esfuerzo detrás de él.

'''Qt para Python''' estará disponible bajo las licencias GPL, LGPL y commercial.

== Comenzando ==
* [[Qt_for_Python_GettingStarted|Guia para comenzar en macOS, Windows y Linux]]
* [[Qt_for_Python_Tutorial|Tutoriales (en construcción)]]
* [https://bugreports.qt.io/browse/PYSIDE Bug tracker] para reportar problemas.
* [https://codereview.qt-project.org CodeReview] y [https://codereview.qt-project.org/#/q/project:%255Epyside.%252B,n,z PySide2 parches abiertos]
* Repositorio Git (la rama 5.9 es la que actualmente se utiliza como objectivo)
** ssh://codereview.qt-project.org/pyside/pyside-setup
* [[PySide2_Development_Getting_Started|Desarrollo: comenzando]]
* [https://doc-snapshots.qt.io/qtforpython/ Documentación oficial (''en construcción'')]

== Como luce '''Qt para Python'''? ==

<syntaxhighlight lang="python" line='line'>
import sys
from PySide2.QtWidgets import QApplication, QLabel

if __name__ == "__main__":
app = QApplication([])
label = QLabel("Hola Mundo")
label.show()
sys.exit(app.exec_())
</syntaxhighlight>

Más ejemplos se pueden encontrar en el [http://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples respositorio del proyecto] dentro del directorio '''examples'''.
== Comunidad ==

* Canal IRC oficial en FreeNode '''#qt-pyside'''
* [http://lists.qt-project.org/mailman/listinfo/pyside Lista de correo ofiical]
* Keybase: [https://keybase.io/team/pyside keybase.io/team/pyside]
* Gitter: [http://gitter.im/PySide/pyside2 gitter.im/PySide/pyside2]

== Estado del desarrollo ==

=== Progreso del desarrollo semanal ===
El resumen del progreso del desarrollo se encuentra en [https://wiki.qt.io/Qt_for_Python_Development_Notes las notas de desarrollo por fecha.]

=== Notas de desarrollo ===

La mejor forma de ver el desarrollo del proyecto es a través de Jira:

# [https://bugreports.qt.io/secure/IssueNavigator.jspa?mode=hide&requestId=17825 Bugs sin resolver]
# [https://bugreports.qt.io/secure/IssueNavigator.jspa?mode=hide&requestId=18025 Todos los bugs (incluyendo los resueltos)]

El segundo enlace es útil para monitorear el progreso en retrospectiva.
La mejor manera de hacer esto es ordenando la lista por la columna "Updated".
Un historial mas extenso se puede encontrar bajo la categoría "User Stories" en Jira.

=== Bindings pendientes ===

La lista de los actuales bindings pendientes se pueden encontrar en la página [[Qt_for_Python_Missing_Bindings|Bindings pendientes en PySide2]]

== Preguntas frecuentes ==

* P: ¿PySide? ¿Qt para Python? ¿Cuál es el nombre?
** R: El nombre del proyecto es '''Qt para Python''' y el nombre del módulo es '''PySide2'''.
* P: ¿Por qué PySide2 y no PySide?
** R: Ya que PySide se desarrolló para Qt4, cuando se decidió hacer el port a Qt5, el nombre fue cambiado a PySide2 para denotar que correspondía a una nueva versión.
* P: ¿Dónde puedo encontrar información acerca del antiguo proyecto PySide?
** R: La página wiki antigua del proyecto está disponible en [[PySide]], '''pero''' el software está deprecado, y no hay un soporte oficial. Recomendamos no utilizarlo y preferir PySide2.
* P: Mi proyecto usa PySide, ¿Qué tan dificil es adaptarlo para usar PySide2?
** R: Los cambios son los mismo del cambio entre [https://doc.qt.io/qt-5/qt5-intro.html Qt4 y Qt5], los cambios mayoritariamente corresponden solo a cambiar las delcaraciones ''import'', ya que muchas clases se movieron de QtGui a QtWidgets.
::''Qt 5 es altamente compatible con Qt 4. Es posible para desarrolladores de aplicaciones que usan Qt 4 cambiarse a Qt 5 muy facilmente con la misma funcionalidad y gradualmente desarrollar nuevas cosas que incluyan todas las nuevas características de Qt 5.
''
== Contribuyendo a la wiki de Qt para Python ==

Esta wiki es una area comunitaria en la cual cualquier persona puede contribuir facilmente, y que además peude contener información que cambia muy rápido.
Por favor comenzar cualquier página wiki nueva relacionada con la categoria "QtForPython", agregando el siguiente texto al comienzo de la página wiki:
<code>
[[Category:Qt for Python]]
</code>

Cuando una nueva página wiki se crea, por favor comenzar el nombre con el prefijo "Qt_for_Python", para que todas las páginas tengan la misma estructura en su nombre.

Qt for Python/Development Getting Started

2018-05-27T15:21:25Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]

== Overview ==
The Qt for Python (PySide2) project is supported by [https://qt.io The Qt Company] and the developers who use Qt for Python.
This means that anyone who shares an interest in the project can join the community, participate in its decision making processes, and contribute to its development.
This page will summarize the key points around how you can contribute to the project.
Qt for Python follows the same development process as the Qt project, it's in your best interest to read the [http://wiki.qt.io/Main_Page Qt Project Wiki].

== Reporting Bugs ==
Bugs should be reported to the Qt bug tracker at https://bugreports.qt.io/browse/PYSIDE Please include details on how to reproduce your problem and consider contributing a fix for it.

== Contributing Patches ==

Because PySide2 is a Qt project, all patches must be submitted through [https://codereview.qt.io Qt's Gerrit code integration system].
Make sure you go through [https://wiki.qt.io/Gerrit_Introduction Gerrit's introduction page] before starting contributing.
All developers need a user account on Gerrit and to agree to the Qt Contributor Agreement. Patches submitted via the bug tracked, mailing list, or pull requests cannot be accepted.

A bug tracker (JIRA) account is needed before a Gerrit account can be created:

* '''JIRA account'''
** Go to [https://bugreports.qt.io bugreports.qt.io] and click on '''Sign Up'''
** Fill out the details
* '''Gerrit account'''
** Go to [https://codereview.qt-project.org codereview.qt-project.org] and click on '''Sign In'''
** Login with the username/password you created with JIRA
*** '''NOTE:''' Gerrit usernames are case-sensitive, but JIRA usernames are not. If you attempt to log into Gerrit with different capitalizations, you will end up with multiple accounts.
** Enter your '''full name''' and click '''Save Changes'''
** Skip the SSH part for now and scroll all the way down and click '''"New Contributor Agreement"'''
*** Select '''Individual''' or '''Corporate''', then scroll down and type '''I AGREE''' then '''submit'''
*** To check if your agreement was submitted, click on '''Settings''' then '''Agreements'''

=== Configuring local directories for Gerrit ===

After cloning the project's repository:

git clone --recursive https://codereview.qt-project.org/pyside/pyside-setup pyside

be sure you are on the desired branch you want to contribute.
Most of the work is being done under *5.9*, but you can submit patches to 5.11 and dev
branches.

Please follow the [[Setting-up-Gerrit | Qt Setting up Gerrit]] instructions, particularly the Local Setup and Configuring Git sections. Add a gerrit remote to local project directory with:

git remote add gerrit ssh://codereview.qt-project.org/pyside/pyside-setup

=== Pushing changes to Gerrit ===

After you have committed your changes locally, you can push them to Gerrit like this:

git push gerrit HEAD:refs/for/<branch>

where '''<branch>''' is the branch you were working at the moment of doing changes in the code.

Qt for Python

2018-05-27T15:20:44Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
{{LangSwitch}}
http://doc-snapshots.qt.io/qtforpython/_static/pysidelogo.png
== Qt for Python ==
The '''Qt for Python''' project aims to provide a complete port of the [[PySide]] module to Qt 5. The development started on [https://github.com/PySide GitHub] in May 2015. The project managed to port Pyside to Qt 5.3, 5.
4 & 5.5. During April 2016 The Qt Company decided to properly support the port (see [https://groups.google.com/forum/#!topic/pyside-dev/pqwzngAGLWE details] ).

This wiki page tracks the progress of the '''Qt for Python''' project development and provides further information concerning the effort.

'''Qt for Python''' will be available under GPL, LGPL and commercial license.

== Getting Started ==
* [[Qt_for_Python/GettingStarted|Getting started guide for macOS, Windows and Linux]] '''(Download and Install/Build)'''
* [[Qt_for_Python/Tutorial|Tutorials]]
* [https://bugreports.qt.io/browse/PYSIDE Bug tracker] to report any issue.
* [https://codereview.qt-project.org CodeReview] and [https://codereview.qt-project.org/#/q/project:%255Epyside.%252B,n,z PySide2 open patches]
* Git repository (5.9 branch is the branch currently worked on for PySide2)
** ssh://codereview.qt-project.org/pyside/pyside-setup
* [[Qt_for_Python/Development_Getting_Started|Development: Getting started]]
* [https://doc-snapshots.qt.io/qtforpython/ Official documentation] (snapshot)

== How does '''Qt for Python''' look like? ==

<syntaxhighlight lang="python" line='line'>
import sys
from PySide2.QtWidgets import QApplication, QLabel

if __name__ == "__main__":
app = QApplication([])
label = QLabel("Hello World")
label.show()
sys.exit(app.exec_())
</syntaxhighlight>

More examples can be found in the [http://code.qt.io/cgit/pyside/pyside-setup.git/tree/examples project's repository] inside the '''examples''' directory.
== Community ==

* Official IRC channel on FreeNode '''#qt-pyside'''
* [http://lists.qt-project.org/mailman/listinfo/pyside Official Mailing list]
* Keybase:
** [https://keybase.io/team/pyside keybase.io/team/pyside]
** [https://keybase.io/team/pyside keybase.io/team/theqtcompany] (subteam ''theqtcompany.pyside'')
* Gitter: [http://gitter.im/PySide/pyside2 gitter.im/PySide/pyside2]

== Development Status ==

=== Weekly development progress ===
The summary of the development progress can be found in [https://wiki.qt.io/Qt_for_Python_Development_Notes Development Notes by date]

=== Pyside Development Progress Notes ===

The most current view of the progress can be found in Jira:

# [https://bugreports.qt.io/secure/IssueNavigator.jspa?mode=hide&requestId=17825 Unresolved issues]
# [https://bugreports.qt.io/secure/IssueNavigator.jspa?mode=hide&requestId=18025 All issues (including resolved)]

The second link is useful to monitor the progress of the backlog. The best way to achieve this is to sort the list by the "Updated" column.
Larger backlog/feature items are filed as "User Stories" in Jira.

=== Missing PySide2 bindings ===

The list of the current missing bindings can be found in [[Qt_for_Python_Missing_Bindings|Missing PySide2 bindings]]

=== Outstanding tasks for release ===

# Determine PySide2 package number
# Ensure multi target packages can be created (long standing - reduced Python API usage )
# General Doc changes required for release
## Getting started
## Some examples documented
## pyinstaller usage
## Class documentation polish
## snapshot generation on http://doc-snapshot.qt-project.org/

== Frequently Asked Questions ==

* Q: PySide? Qt for Python? what is the name?
** A: The name of the project is '''Qt for Python''' and the name of the module is '''PySide2'''.
* Q: Why PySide2 and not just PySide?
** A: Since PySide was developed for Qt4, when the port was made to support Qt5, the name was changed to PySide2 to infer that is was a newer version.
* Q: Where I can find information about the old PySide project?
** A: The old wiki page of the project is available on [[PySide]], '''but''' the project is deprecated and there is no official support for it. We highly recommend not to use it.
* Q: My project is using PySide, how hard would it be to adapt it to PySide2?
** A: The changes are the same as between [https://doc.qt.io/qt-5/qt5-intro.html Qt4 and Qt5], and for PySide users it mostly means adapting the ''import'' statements since many classes were moved from QtGui to QtWidgets.
::''Qt 5 is highly compatible with Qt 4. It is possible for developers of Qt 4 applications to seamlessly move to Qt 5 with their current functionality and gradually develop new things, leveraging all the great items Qt 5 makes possible.
''

== Contributing to the Qt for Python Wiki ==

This Wiki is a community area where you can easily contribute, and which may contain rapidly changing information.
Please put any wiki pages related to Qt for Python into the "QtForPython" category by adding the following text to the top of the page:
<code>
[[Category:Qt for Python]]
</code>

When creating a new wiki page, please start the name with the prefix "Qt_for_Python/", so all the wiki page names will have the same structure and breadcrumbs are generated for easier navigation.

Qt for Python UsingQtProperties

2018-05-27T15:19:14Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]

PySide2 provides a ''Property'' function which allows for declaring properties that simultaneously behave both as Qt and Python properties, and have their setters and getters defined as Python functions.

A short example illustrating defining and accessing a Qt property from Python is given below:

<syntaxhighlight lang="python" line='line'>
from PySide2.QtCore import QObject, Property

class MyObject(QObject):
def __init__(self,startval=42):
QObject.__init__(self)
self.ppval = startval

def readPP(self):
return self.ppval

def setPP(self,val):
self.ppval = val

pp = Property(int, readPP, setPP)

obj = MyObject()
obj.pp = 47
print(obj.pp)
</syntaxhighlight>

== Properties in QML expressions ==

If you are using properties of your objects in QML expressions, QML requires the property to be NOTIFYable. This can be done using a simple signal:

<syntaxhighlight lang="python" line='line'>
from PySide2.QtCore import QObject, Signal, Property

class Person(QObject):
def __init__(self, name):
QObject.__init__(self)
self._person_name = name

def _name(self):
return self._person_name

@Signal
def name_changed(self):
pass

name = Property(str, _name, notify=name_changed)
</syntaxhighlight>

Qt for Python/GettingStarted/X11

2018-05-27T15:17:44Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
==== Requirements ====
* '''GCC''' (Linux)
* A Python interpreter (version '''Python 3.6''' or '''Python 2.7'''). One possibility is to to use a package from https://www.python.org/downloads/ , a system installed package with an appropriate version should work as well.
* [http://download.qt.io/official_releases/online_installers/qt-unified-linux-x64-online.run Qt 5.6+]
* [http://download.qt.io/development_releases/prebuilt/libclang/ libclang 3.9 or 4.0] (for 5.9+ branches)
* CMake from https://cmake.org/download/ ('''>= 3.1''')
* Git ('''>=2''')
* virtualenv ('''strongly recommended''', but optional)
* Python sphinx package for documentation (optional, pip install sphinx)

=== Building from sources ===

==== Setting up CLANG ====

* Download [http://download.qt.io/development_releases/prebuilt/libclang/ libclang], e.g.
wget http://download.qt.io/development_releases/prebuilt/libclang/libclang-release_39-linux-Rhel7.2-gcc5.3-x86_64.7z

* Extract the files, e.g.
7z x libclang-release_39-linux-Rhel7.2-gcc5.3-x86_64.7z

* Export the installation path to the path you choosed to place the files
export CLANG_INSTALL_DIR=$PWD/libclang

==== Getting PySide2 ====

* Clone the official repository:
git clone --recursive https://code.qt.io/pyside/pyside-setup
* Check out the version you want to build, e.g. 5.9. Keep in mind that you must use the same version as your Qt installation.
cd pyside-setup && git checkout 5.9

==== Building PySide2 ====

* Check your Qt installation path, to specifically use that version of ''qmake'' to build PySide2:
which qmake

* Build can take a few minutes, so it is recommended to use more than one CPU core (e.g. 8). Remember to replace the paths to your current ''qmake'' path:
python setup.py build --qmake=/path/to/qmake --build-tests --ignore-git --jobs=8

==== Installing PySide2 ====

* To install on the current directory, just run:
python setup.py install --qmake=/path/to/qmake --openssl=/path/to/openssl --build-tests --ignore-git --jobs=8

==== Test installation ====
* You can execute one of the examples to verify the process is properly working.
* Remember to properly set the environment variables for Qt and PySide2.
python examples/examples/widgets/widgets/tetrix.py

== Development ==

Development happens in the 5.9 and dev branches of the [http://code.qt.io/cgit/pyside/pyside-setup.git/ pyside-setup repository].

The top level repository has the following submodules:
* sources/pyside2-tools: uic, rcc tools
* examples/ (5.6 only, examples are no longer a submodule in 5.9+)

Contributions follow the [[Qt_Project_Guidelines|standard process]].

It is helpful to have debug binaries or symbols for Python available.
Debug packages can be installed separately in some Linux distributions
(e.g.: Ubuntu, the packages python3-dbg, libpython3-dbg provide a debug binary python3-dbg)

If your distribution does not include them, you can [https://www.python.org/downloads/ download python] sources
and compile it by yourself, e.g.
./configure --prefix=/where/to/install/python/path CFLAGS="-O0 -fno-inline -fno-omit-frame-pointer -g" LDFLAGS="-O0" CPPFLAGS="-O0" OPT="-O0 -g"
make
make install

It is also recommended to use a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ Virtual Environment] for testing to be able to always start from a clean base and avoid issues with write permissions in installations.

A new virtual environment can be created as follows:
virtualenv -p /usr/bin/python3-dbg testenv
Please take into consideration that the binary name might be different in your system,
and that you can choose a different name for the environment instead of ''testenv''.

==== Troubleshooting ====

* '''Wrong RUNPATH / rpath'''
If you choose to build Python from sources in shared library configuration, it might be the case that the rpath is not set properly, which means that the built python binary might use the system python shared library, instead of the custom build shared library.
You can ''patch'' the interpreter rpath values with a binary that PySide2 provides:
cd pyside-setup
./patchelf --set-rpath /path/to/your/local/python/lib /path/to/your/python/virtualenv/binary/python
And then you can proceed to re-install PySide2.
(you can check if the patch worked with ''readelf -d /path/to/your/python/virtualenv/binary/python'')

* '''Missing libICU causes linking problems'''
From 5.9+ you can get a copy of libICU by specifying ''--standalone'' (but not including ''--iculib-url'') as an argument to ''setup.py'' execution.

Qt for Python UiFiles

2018-05-27T15:17:32Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]

This page describes the use of Qt Creator to create Graphical Interfaces for your PySide Software.
You will need Qt Creator to design and modify your interface (ui file)

If you don't know how to use Qt Creator, please go to [http://doc.qt.io/qtcreator/creator-using-qt-designer.html Using Qt Designer].

At Qt Creator, create a new Qt Design Form, choose "Main Window" for template.
And save as "mainwindow.ui".
Add a Qlabel to the center of the centralwidget.

Your file (mainwindow.ui) should look something like this:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>MainWindow</class>
<widget class="QMainWindow" name="MainWindow">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>82</width>
<height>64</height>
</rect>
</property>
<property name="windowTitle">
<string>MainWindow</string>
</property>
<widget class="QWidget" name="centralwidget">
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="0">
<widget class="QLabel" name="label">
<property name="text">
<string>Hello World!</string>
</property>
</widget>
</item>
</layout>
</widget>
<widget class="QMenuBar" name="menubar">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>82</width>
<height>21</height>
</rect>
</property>
</widget>
<widget class="QStatusBar" name="statusbar"/>
</widget>
<resources/>
<connections/>
</ui>
</source>

Now, using PySide2 we will load the ui file and start our application:

<syntaxhighlight lang="python" line='line'>
# main.py
import sys
from PySide2.QtUiTools import QUiLoader
from PySide2.QtWidgets import QApplication
from PySide2.QtCore import QFile

if __name__ == "__main__":
app = QApplication(sys.argv)

file = QFile("mainwindow.ui")
file.open(QFile.ReadOnly)

loader = QUiLoader()
window = loader.load(file)
window.show()

sys.exit(app.exec_())
</syntaxhighlight>

And to run it, just a <code>python main.py</code> will do the job.

Qt for Python/GettingStarted/Windows

2018-05-27T15:16:12Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
The Qt library has to be built with the same version of MSVC as Python and PySide2, this can be selected when using the online installer.

==== Requirements ====
* Qt package from https://www.qt.io or a custom build of Qt (preferably '''Qt 5.9''')
* A Python interpreter (version '''Python 3.6''' or '''Python 2.7'''). One possibility is to use a package from https://www.python.org/downloads/
* [http://landinghub.visualstudio.com/visual-cpp-build-tools MSVC2015] (for Python 3 on Windows), MSVC2008 (for Python 2 on Windows)
* CMake from https://cmake.org/download/ ('''>= 3.1''')
* Git from https://git-scm.com/download/win ('''>= 2''')
* libclang (required for the 5.9 and dev branches) from [http://download.qt.io/development_releases/prebuilt/libclang/ download.qt.io] ('''3.9 or 4.0''')
* [https://sourceforge.net/projects/openssl/ OpenSSL] (optional for SSL support, Qt must have been configured using the same SSL library)
* virtualenv (strongly recommended, but optional)
* Python sphinx package for documentation (optional, pip install sphinx)

=== Building from sources on Windows 10 ===
The following steps are performed on the command prompt (''cmd'') that is included with the MSVC2015 package, to include the proper compiler configuration.
A 64bit infrastructure is assumed in the procedure, but if the host is a 32bit environment it is possible to just download the proper architecture packages.
The packages used on this process are:
* 7zip (''7z1700-x64'')
* Git (''Git-2.15.1.2-64'')
* CMake (''cmake-3.10.2-win64-x64'')
* Python (''python-3.6.4-amd64'')
* MSVC2015 (''visualcppbuildtools_full'')
* CLANG (''libclang-release_39-windows-vs2015_64.7z'')
* Qt 5.9.4 (''qt-unified-windows-x86-3.0.2-online'')
==== Setting up CLANG ====
* Download [http://download.qt.io/development_releases/prebuilt/libclang/ libclang], e.g.
[http://download.qt.io/development_releases/prebuilt/libclang/libclang-release_39-windows-vs2015_64.7z http://download.qt.io/development_releases/prebuilt/libclang/libclang-release_39-windows-vs2015_64.7z]
* Extract the files, e.g. using [http://www.7-zip.org/ 7zip]
* Move the directory ''libclang'' to any desired path, e.g ''c:\'', and then set these two required environment variables:
set LLVM_INSTALL_DIR=c:\libclang
set PATH=C:\libclang\bin;%PATH%
==== Getting PySide2 ====
* You must [https://git-scm.com/download/win download git] in order to clone the repository.
* Cloning the official repository
git clone --recursive https://code.qt.io/pyside/pyside-setup
* Checking out the version that we want to build, e.g. 5.9 (Keep in mind you need to use the same version as your Qt installation)
cd pyside-setup && git checkout 5.9

==== Building PySide2 ====
* You must [https://www.python.org/downloads/windows/ download Python] to build PySide2 (3.6 is recommended)
* Check your Qt installation path, to specifically use that version of ''qmake'' to build PySide2.
e.g. ''E:\Qt\5.9.4\msvc2015_64\bin\qmake.exe''
* Build can take a few minutes, so it is recommended to use more than one CPU core (e.g. 8). Remember to replace the paths to your current ''qmake'' path:
python setup.py build --qmake=E:\Qt\5.9.4\msvc2015_64\bin\qmake.exe --openssl=C:\Dev\qtdev\OpenSSL-Win64\bin --build-tests --ignore-git --jobs=8
==== Installing PySide2 ====
* To install on the current directory, just run:
python setup.py install --qmake=E:\Qt\5.9.4\msvc2015_64\bin\qmake.exe --openssl=C:\Dev\qtdev\OpenSSL-Win64\bin --build-tests --ignore-git --jobs=8
==== Test installation ====
* You can execute one of the examples to verify the process is properly working.
* Remember to properly set the environment variables for Qt and PySide2.
python examples/examples/widgets/widgets/tetrix.py
== Build considerations ==
Building PySide2 on Windows is a bit special in the sense that some rules have to be followed:
* The MSVC version used to build Python, Qt and PySide2 '''must''' be the same.
** In practice this means that if you use the official Python 3.x package from [https://www.python.org/downloads/] which is built with MSVC 2015, you need to use a Qt package built with MSVC 2015.
** Using the official Python 2.x package will not be feasible, due to it being built with MSVC 2008, and there being no official prebuilt Qt package for the same MSVC version.
* The build configuration (debug or release) has to be the same for Python, Qt and PySide2.
* The above considerations are necessary to ensure that only a '''single''' MSVC runtime library is loaded, otherwise this can cause '''memory corruption, crashes or undefined behavior'''.

== Development ==
Development happens in the 5.9 and dev branches of the [http://code.qt.io/cgit/pyside/pyside-setup.git/ pyside-setup repository].
The top level repository has the following submodules:
* sources/pyside2-tools: uic, rcc tools
* sources/pyside2-examples (5.6 only, examples are no longer a submodule in 5.9+)
Contributions follow the [[Qt_Project_Guidelines|standard process]].
It is helpful to have debug binaries and/or symbols for Python available.
On Windows, this is done by choosing ''Customized Installation'' when installing Python and ticking the respective check boxes.
It is also recommended to use a [http://docs.python-guide.org/en/latest/dev/virtualenvs/ Virtual Environment] for testing to be able to always start from a clean base and avoid issues with write permissions in installations.
On Windows an installation step may be required:
python -m pip install virtualenv
python -m virtualenv testenv
The Virtual Environment is activated by·
CALL testenv\Scripts\activate.bat
Before building the first time, the module [http://www.sphinx-doc.org/en/1.4.9/ Sphinx] should be installed into the virtual environment:·
pip install sphinx

Qt for Python Missing Bindings

2018-05-27T15:15:58Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
= PySide2 bindings for Qt 5.11 =
Using Qt version 5.11 documentation to find public API Qt types and test if the types are present in the PySide2 package.
Similar report:
https://gist.github.com/ethanhs/6c626ca4e291f3682589699296377d3a

This report was generated by running the following command:
python missing_bindings.py --qt-version 5.11 -w all
on the following date:
2018-05-22 11:27:08 GMT

===== QtCore =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtcore-module.html

''Could not load PyQt5.QtCore for comparison. Received error: No module named PyQt5.''

Number of types in QtCore:''' 175'''

Missing types in QtCore:

QAbstractNativeEventFilter
QAtomicInt
QAtomicInteger
QAtomicPointer
QBEInteger
QByteArrayList
QCache
QContiguousCache
QDeadlineTimer
QEventLoopLocker
QException
QFuture
QFutureSynchronizer
QFutureWatcher
QIdentityProxyModel
QJsonObject
QKeyValueIterator
QLEInteger
QLibrary
QLockFile
QLoggingCategory
QMessageAuthenticationCode
QMessageLogger
QMetaType
QObjectCleanupHandler
QOperatingSystemVersion
QSharedMemory
QSignalBlocker
QStaticByteArrayMatcher
QStringView
QThreadStorage
QUnhandledException
QVariant
QWinEventNotifier

Number of missing types:''' 34'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtGui =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtgui-module.html

''Could not load PyQt5.QtGui for comparison. Received error: No module named PyQt5.''

Number of types in QtGui:''' 193'''

Missing types in QtGui:

QAccessibleEditableTextInterface
QAccessibleObject
QAccessibleStateChangeEvent
QAccessibleTableCellInterface
QAccessibleTableModelChangeEvent
QAccessibleTextCursorEvent
QAccessibleTextInsertEvent
QAccessibleTextInterface
QAccessibleTextRemoveEvent
QAccessibleTextSelectionEvent
QAccessibleTextUpdateEvent
QAccessibleValueChangeEvent
QAccessibleValueInterface
QGlyphRun
QIconEngine.ScaledPixmapArgument
QInputMethod
QInputMethodQueryEvent
QNativeGestureEvent
QOpenGLPaintDevice
QOpenGLTextureBlitter
QPlatformSurfaceEvent
QPointingDeviceUniqueId
QRasterPaintEngine
QRgba64
QScrollEvent
QScrollPrepareEvent
QSupportedWritingSystems
QVulkanDeviceFunctions
QVulkanFunctions
QVulkanInstance
QVulkanWindow
QVulkanWindowRenderer

Number of missing types:''' 32'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtMultimedia =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtmultimedia-module.html

''Could not load PyQt5.QtMultimedia for comparison. Received error: No module named PyQt5.''

Number of types in QtMultimedia:''' 95'''

Missing types in QtMultimedia:

QAbstractPlanarVideoBuffer
QAudioBuffer.StereoFrame
QAudioSystemPlugin
QCameraExposure
QCameraFeedbackControl
QCameraFlashControl
QCameraFocus
QCameraFocusControl
QCameraImageProcessing
QMediaMetaData
QMediaService
QMediaServiceCameraInfoInterface
QMediaServiceDefaultDeviceInterface
QMediaServiceFeaturesInterface
QMediaServiceProviderPlugin
QMediaServiceSupportedDevicesInterface
QMediaServiceSupportedFormatsInterface
QMediaStreamsControl
QMediaTimeInterval
QMediaVideoProbeControl
QMetaDataReaderControl
QMetaDataWriterControl

Number of missing types:''' 22'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtMultimediaWidgets =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtmultimediawidgets-module.html

''Could not load PyQt5.QtMultimediaWidgets for comparison. Received error: No module named PyQt5.''

Number of types in QtMultimediaWidgets:''' 4'''

Number of missing types:''' 0'''

===== QtNetwork =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtnetwork-module.html

''Could not load PyQt5.QtNetwork for comparison. Received error: No module named PyQt5.''

Number of types in QtNetwork:''' 48'''

Missing types in QtNetwork:

QSctpServer
QSctpSocket
QSslEllipticCurve

Number of missing types:''' 3'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtQml =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtqml-module.html

''Could not load PyQt5.QtQml for comparison. Received error: No module named PyQt5.''

Number of types in QtQml:''' 24'''

Missing types in QtQml:

QQmlContext.PropertyPair
QQmlListProperty

Number of missing types:''' 2'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtQuick =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtquick-module.html

''Could not load PyQt5.QtQuick for comparison. Received error: No module named PyQt5.''

Number of types in QtQuick:''' 45'''

Missing types in QtQuick:

QQuickItem.ItemChangeData
QSGFlatColorMaterial
QSGImageNode
QSGMaterial
QSGMaterialShader
QSGMaterialShader.RenderState
QSGOpaqueTextureMaterial
QSGRectangleNode
QSGRenderNode
QSGRendererInterface
QSGSimpleMaterial
QSGSimpleMaterialShader
QSGTextureMaterial
QSGVertexColorMaterial

Number of missing types:''' 14'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtSql =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtsql-module.html

''Could not load PyQt5.QtSql for comparison. Received error: No module named PyQt5.''

Number of types in QtSql:''' 15'''

Number of missing types:''' 0'''

===== QtTest =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qttest-module.html

''Could not load PyQt5.QtTest for comparison. Received error: No module named PyQt5.''

Number of types in QtTest:''' 5'''

Missing types in QtTest:

QAbstractItemModelTester
QSignalSpy
QTestEventList

Number of missing types:''' 3'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtWidgets =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtwidgets-module.html

''Could not load PyQt5.QtWidgets for comparison. Received error: No module named PyQt5.''

Number of types in QtWidgets:''' 200'''

Missing types in QtWidgets:

QAccessibleWidget
QFormLayout.TakeRowResult
QMacCocoaViewContainer
QMacNativeWidget
QProxyStyle
QScroller
QScrollerProperties

Number of missing types:''' 7'''

Number of missing types that are present in PyQt5:''' 0'''

===== Qt3DCore =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt3dcore-module.html

''Could not load PyQt5.Qt3DCore for comparison. Received error: No module named PyQt5.''

Number of types in Qt3DCore:''' 37'''

Missing types in Qt3DCore:

Qt3DCore.QBackendNodeMapper
Qt3DCore.QNodeCreatedChange
Qt3DCore.Quick
Qt3DCore.Quick.QQmlAspectEngine

Number of missing types:''' 4'''

Number of missing types that are present in PyQt5:''' 0'''

===== Qt3DInput =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt3dinput-module.html

''Could not load PyQt5.Qt3DInput for comparison. Received error: No module named PyQt5.''

Number of types in Qt3DInput:''' 24'''

Missing types in Qt3DInput:

Qt3DInput.QPhysicalDeviceCreatedChangeBase

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 0'''

===== Qt3DLogic =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt3dlogic-module.html

''Could not load PyQt5.Qt3DLogic for comparison. Received error: No module named PyQt5.''

Number of types in Qt3DLogic:''' 3'''

Number of missing types:''' 0'''

===== Qt3DRender =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt3drender-module.html

''Could not load PyQt5.Qt3DRender for comparison. Received error: No module named PyQt5.''

Number of types in Qt3DRender:''' 110'''

Number of missing types:''' 0'''

===== Qt3DAnimation =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt3danimation-module.html

''Could not load PyQt5.Qt3DAnimation for comparison. Received error: No module named PyQt5.''

Number of types in Qt3DAnimation:''' 23'''

Missing types in Qt3DAnimation:

Qt3DAnimation.QAnimationClip
Qt3DAnimation.QAnimationClipData
Qt3DAnimation.QAnimationClipLoader
Qt3DAnimation.QCallbackMapping
Qt3DAnimation.QChannelMapper
Qt3DAnimation.QChannelMapping
Qt3DAnimation.QClipBlendValue

Number of missing types:''' 7'''

Number of missing types that are present in PyQt5:''' 0'''

===== Qt3DExtras =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt3dextras-module.html

''Could not load PyQt5.Qt3DExtras for comparison. Received error: No module named PyQt5.''

Number of types in Qt3DExtras:''' 46'''

Number of missing types:''' 0'''

===== QtConcurrent =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtconcurrent-module.html

''Could not load PyQt5.QtConcurrent for comparison. Received error: No module named PyQt5.''

Number of types in QtConcurrent:''' 1'''

Number of missing types:''' 0'''

===== QtNetworkAuth =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtnetworkauth-module.html

''Could not load PySide2.QtNetworkAuth. Received error: module PySide2 has no attribute QtNetworkAuth. Skipping.''

===== QtHelp =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qthelp-module.html

''Could not load PyQt5.QtHelp for comparison. Received error: No module named PyQt5.''

Number of types in QtHelp:''' 11'''

Number of missing types:''' 0'''

===== QtLocation =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtlocation-module.html

''Could not load PyQt5.QtLocation for comparison. Received error: No module named PyQt5.''

Number of types in QtLocation:''' 40'''

Missing types in QtLocation:

QLocation

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtPrintSupport =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtprintsupport-module.html

''Could not load PyQt5.QtPrintSupport for comparison. Received error: No module named PyQt5.''

Number of types in QtPrintSupport:''' 8'''

Number of missing types:''' 0'''

===== QtSCXML =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtscxml-module.html

''Could not load PySide2.QtSCXML. Received error: module PySide2 has no attribute QtSCXML. Skipping.''

===== QtSpeech =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtspeech-module.html

''Could not load PySide2.QtSpeech. Received error: module PySide2 has no attribute QtSpeech. Skipping.''

===== QtSvg =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtsvg-module.html

''Could not load PyQt5.QtSvg for comparison. Received error: No module named PyQt5.''

Number of types in QtSvg:''' 4'''

Number of missing types:''' 0'''

===== QtUiTools =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtuitools-module.html

''Could not load PyQt5.QtUiTools for comparison. Received error: No module named PyQt5.''

Number of types in QtUiTools:''' 1'''

Number of missing types:''' 0'''

===== QtWebChannel =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtwebchannel-module.html

''Could not load PyQt5.QtWebChannel for comparison. Received error: No module named PyQt5.''

Number of types in QtWebChannel:''' 2'''

Number of missing types:''' 0'''

===== QtWebEngine =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtwebengine-module.html

''Could not load PySide2.QtWebEngine. Received error: module PySide2 has no attribute QtWebEngine. Skipping.''

===== QtWebEngineWidgets =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtwebenginewidgets-module.html

''Could not load PyQt5.QtWebEngineWidgets for comparison. Received error: No module named PyQt5.''

Number of types in QtWebEngineWidgets:''' 12'''

Missing types in QtWebEngineWidgets:

QWebEngineContextMenuData
QWebEngineFullScreenRequest
QWebEngineHistory
QWebEngineScriptCollection
QWebEngineSettings

Number of missing types:''' 5'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtWebSockets =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtwebsockets-module.html

''Could not load PyQt5.QtWebSockets for comparison. Received error: No module named PyQt5.''

Number of types in QtWebSockets:''' 5'''

Number of missing types:''' 0'''

===== QtMacExtras =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtmacextras-module.html

''Could not load PySide2.QtMacExtras. Received error: module PySide2 has no attribute QtMacExtras. Skipping.''

===== QtX11Extras =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtx11extras-module.html

''Could not load PyQt5.QtX11Extras for comparison. Received error: No module named PyQt5.''

Number of types in QtX11Extras:''' 1'''

Number of missing types:''' 0'''

===== QtWinExtras =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtwinextras-module.html

''Could not load PySide2.QtWinExtras. Received error: module PySide2 has no attribute QtWinExtras. Skipping.''

===== QtXml =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtxml-module.html

''Could not load PyQt5.QtXml for comparison. Received error: No module named PyQt5.''

Number of types in QtXml:''' 31'''

Number of missing types:''' 0'''

===== QtXmlPatterns =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtxmlpatterns-module.html

''Could not load PyQt5.QtXmlPatterns for comparison. Received error: No module named PyQt5.''

Number of types in QtXmlPatterns:''' 15'''

Missing types in QtXmlPatterns:

QSimpleXmlNodeModel

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtCharts =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qt-charts-module.html

''Could not load PyQt5.QtCharts for comparison. Received error: No module named PyQt5.''

Number of types in QtCharts:''' 48'''

Missing types in QtCharts:

QAbstractAxis
QAbstractBarSeries
QAbstractSeries
QAreaLegendMarker
QAreaSeries
QBarCategoryAxis
QBarLegendMarker
QBarSeries
QBarSet
QBoxPlotLegendMarker
QBoxPlotSeries
QBoxSet
QCandlestickLegendMarker
QCandlestickModelMapper
QCandlestickSeries
QCandlestickSet
QCategoryAxis
QChart
QChartView
QDateTimeAxis
QHBarModelMapper
QHBoxPlotModelMapper
QHCandlestickModelMapper
QHPieModelMapper
QHXYModelMapper
QHorizontalBarSeries
QHorizontalPercentBarSeries
QHorizontalStackedBarSeries
QLegend
QLegendMarker
QLineSeries
QLogValueAxis
QPercentBarSeries
QPieLegendMarker
QPieSeries
QPieSlice
QPolarChart
QScatterSeries
QSplineSeries
QStackedBarSeries
QVBarModelMapper
QVBoxPlotModelMapper
QVCandlestickModelMapper
QVPieModelMapper
QVXYModelMapper
QValueAxis
QXYLegendMarker
QXYSeries

Number of missing types:''' 48'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtDataVisualization =====
Documentation link: http://doc-snapshots.qt.io/qt5-5.11/qtdatavisualization-module.html

''Could not load PyQt5.QtDataVisualization for comparison. Received error: No module named PyQt5.''

Number of types in QtDataVisualization:''' 36'''

Missing types in QtDataVisualization:

Q3DBars
Q3DCamera
Q3DInputHandler
Q3DLight
Q3DObject
Q3DScatter
Q3DScene
Q3DSurface
Q3DTheme
QAbstract3DAxis
QAbstract3DGraph
QAbstract3DInputHandler
QAbstract3DSeries
QAbstractDataProxy
QBar3DSeries
QBarDataItem
QBarDataProxy
QCategory3DAxis
QCustom3DItem
QCustom3DLabel
QCustom3DVolume
QHeightMapSurfaceDataProxy
QItemModelBarDataProxy
QItemModelScatterDataProxy
QItemModelSurfaceDataProxy
QLogValue3DAxisFormatter
QScatter3DSeries
QScatterDataItem
QScatterDataProxy
QSurface3DSeries
QSurfaceDataItem
QSurfaceDataProxy
QTouch3DInputHandler
QValue3DAxis
QValue3DAxisFormatter

Number of missing types:''' 35'''

Number of missing types that are present in PyQt5:''' 0'''

===== Summary =====
Total number of missing types:''' 219'''

Total number of missing types that are present in PyQt5:''' 0'''

Total number of missing modules:''' 6'''

= PySide2 bindings for Qt 5.9 =
Using Qt version 5.9 documentation to find public API Qt types and test if the types are present in the PySide2 package.
Similar report:
https://gist.github.com/ethanhs/6c626ca4e291f3682589699296377d3a

This report was generated by running the following command:
python missing_bindings.py --qt-version 5.9 -w all
on the following date:
2018-05-22 11:03:26 GMT

===== QtCore =====
Documentation link: http://doc.qt.io/qt-5.9/qtcore-module.html

Number of types in QtCore:''' 169'''

Missing types in QtCore:

QAbstractNativeEventFilter (is present in PyQt5)
QAtomicInt
QAtomicInteger
QAtomicPointer
QByteArrayList
QCache
QContiguousCache
QDeadlineTimer (is present in PyQt5)
QEventLoopLocker (is present in PyQt5)
QException
QFuture
QFutureSynchronizer
QFutureWatcher
QJsonObject
QLibrary (is present in PyQt5)
QLoggingCategory
QMessageLogger (is present in PyQt5)
QMetaType (is present in PyQt5)
QObjectCleanupHandler (is present in PyQt5)
QSharedMemory (is present in PyQt5)
QStaticByteArrayMatcher
QThreadStorage
QUnhandledException
QVariant (is present in PyQt5)
QWinEventNotifier

Number of missing types:''' 25'''

Number of missing types that are present in PyQt5:''' 9'''

===== QtGui =====
Documentation link: http://doc.qt.io/qt-5.9/qtgui-module.html

Number of types in QtGui:''' 189'''

Missing types in QtGui:

QAccessibleImageInterface
QGlyphRun (is present in PyQt5)
QIconEngine.ScaledPixmapArgument (is present in PyQt5)
QOpenGLPaintDevice (is present in PyQt5)
QPlatformSurfaceEvent (is present in PyQt5)
QRasterPaintEngine
QRgba64 (is present in PyQt5)
QSupportedWritingSystems

Number of missing types:''' 8'''

Number of missing types that are present in PyQt5:''' 5'''

===== QtMultimedia =====
Documentation link: http://doc.qt.io/qt-5.9/qtmultimedia-module.html

Number of types in QtMultimedia:''' 94'''

Missing types in QtMultimedia:

QAbstractPlanarVideoBuffer
QAudioBuffer.StereoFrame
QAudioSystemPlugin
QCameraExposure (is present in PyQt5)
QCameraFlashControl
QCameraFocus (is present in PyQt5)
QCameraFocusControl
QCameraImageProcessing (is present in PyQt5)
QMediaMetaData (is present in PyQt5)
QMediaServiceProviderPlugin

Number of missing types:''' 10'''

Number of missing types that are present in PyQt5:''' 4'''

===== QtMultimediaWidgets =====
Documentation link: http://doc.qt.io/qt-5.9/qtmultimediawidgets-module.html

Number of types in QtMultimediaWidgets:''' 4'''

Number of missing types:''' 0'''

===== QtNetwork =====
Documentation link: http://doc.qt.io/qt-5.9/qtnetwork-module.html

Number of types in QtNetwork:''' 48'''

Missing types in QtNetwork:

QSctpServer
QSctpSocket
QSslEllipticCurve (is present in PyQt5)

Number of missing types:''' 3'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtQml =====
Documentation link: http://doc.qt.io/qt-5.9/qtqml-module.html

Number of types in QtQml:''' 23'''

Missing types in QtQml:

QQmlListProperty (is present in PyQt5)

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtQuick =====
Documentation link: http://doc.qt.io/qt-5.9/qtquick-module.html

Number of types in QtQuick:''' 45'''

Missing types in QtQuick:

QQuickItem.ItemChangeData (is present in PyQt5)
QSGFlatColorMaterial (is present in PyQt5)
QSGImageNode (is present in PyQt5)
QSGMaterial (is present in PyQt5)
QSGMaterialShader (is present in PyQt5)
QSGMaterialShader.RenderState (is present in PyQt5)
QSGOpaqueTextureMaterial (is present in PyQt5)
QSGRectangleNode (is present in PyQt5)
QSGRenderNode (is present in PyQt5)
QSGRendererInterface (is present in PyQt5)
QSGSimpleMaterial
QSGSimpleMaterialShader
QSGTextureMaterial (is present in PyQt5)
QSGVertexColorMaterial (is present in PyQt5)

Number of missing types:''' 14'''

Number of missing types that are present in PyQt5:''' 12'''

===== QtSql =====
Documentation link: http://doc.qt.io/qt-5.9/qtsql-module.html

Number of types in QtSql:''' 15'''

Number of missing types:''' 0'''

===== QtTest =====
Documentation link: http://doc.qt.io/qt-5.9/qttest-module.html

Number of types in QtTest:''' 4'''

Missing types in QtTest:

QSignalSpy (is present in PyQt5)
QTestEventList

Number of missing types:''' 2'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtWidgets =====
Documentation link: http://doc.qt.io/qt-5.9/qtwidgets-module.html

Number of types in QtWidgets:''' 201'''

Missing types in QtWidgets:

QFormLayout.TakeRowResult (is present in PyQt5)
QMacCocoaViewContainer
QMacNativeWidget

Number of missing types:''' 3'''

Number of missing types that are present in PyQt5:''' 1'''

===== Qt3DCore =====
Documentation link: http://doc.qt.io/qt-5.9/qt3dcore-module.html

''Could not load PyQt5.Qt3DCore for comparison. Received error: module PyQt5 has no attribute Qt3DCore.''

Number of types in Qt3DCore:''' 31'''

Missing types in Qt3DCore:

Qt3DCore.QBackendNodeMapper
Qt3DCore.QNodeCreatedChange
Qt3DCore.Quick
Qt3DCore.Quick.QQmlAspectEngine

Number of missing types:''' 4'''

Number of missing types that are present in PyQt5:''' 0'''

===== Qt3DInput =====
Documentation link: http://doc.qt.io/qt-5.9/qt3dinput-module.html

''Could not load PyQt5.Qt3DInput for comparison. Received error: module PyQt5 has no attribute Qt3DInput.''

Number of types in Qt3DInput:''' 23'''

Number of missing types:''' 0'''

===== Qt3DLogic =====
Documentation link: http://doc.qt.io/qt-5.9/qt3dlogic-module.html

''Could not load PyQt5.Qt3DLogic for comparison. Received error: module PyQt5 has no attribute Qt3DLogic.''

Number of types in Qt3DLogic:''' 3'''

Number of missing types:''' 0'''

===== Qt3DRender =====
Documentation link: http://doc.qt.io/qt-5.9/qt3drender-module.html

''Could not load PyQt5.Qt3DRender for comparison. Received error: module PyQt5 has no attribute Qt3DRender.''

Number of types in Qt3DRender:''' 100'''

Missing types in Qt3DRender:

Qt3DRender.AssimpImporter

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 0'''

===== Qt3DAnimation =====
Documentation link: http://doc.qt.io/qt-5.9/qt3danimation-module.html

''Could not load PyQt5.Qt3DAnimation for comparison. Received error: module PyQt5 has no attribute Qt3DAnimation.''

Number of types in Qt3DAnimation:''' 16'''

Number of missing types:''' 0'''

===== Qt3DExtras =====
Documentation link: http://doc.qt.io/qt-5.9/qt3dextras-module.html

''Could not load PyQt5.Qt3DExtras for comparison. Received error: module PyQt5 has no attribute Qt3DExtras.''

Number of types in Qt3DExtras:''' 32'''

Missing types in Qt3DExtras:

Qt3DExtras.QNormalDiffuseMapAlphaMaterial
Qt3DExtras.QTexturedMetalRoughMaterial

Number of missing types:''' 2'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtConcurrent =====
Documentation link: http://doc.qt.io/qt-5.9/qtconcurrent-module.html

''Could not load PyQt5.QtConcurrent for comparison. Received error: module PyQt5 has no attribute QtConcurrent.''

Number of types in QtConcurrent:''' 1'''

Number of missing types:''' 0'''

===== QtNetworkAuth =====
Documentation link: http://doc.qt.io/qt-5.9/qtnetworkauth-module.html

''Could not load PySide2.QtNetworkAuth. Received error: module PySide2 has no attribute QtNetworkAuth. Skipping.''

===== QtHelp =====
Documentation link: http://doc.qt.io/qt-5.9/qthelp-module.html

Number of types in QtHelp:''' 11'''

Number of missing types:''' 0'''

===== QtLocation =====
Documentation link: http://doc.qt.io/qt-5.9/qtlocation-module.html

Number of types in QtLocation:''' 40'''

Missing types in QtLocation:

QLocation (is present in PyQt5)

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtPrintSupport =====
Documentation link: http://doc.qt.io/qt-5.9/qtprintsupport-module.html

Number of types in QtPrintSupport:''' 8'''

Number of missing types:''' 0'''

===== QtSCXML =====
Documentation link: http://doc.qt.io/qt-5.9/qtscxml-module.html

''Could not load PySide2.QtSCXML. Received error: module PySide2 has no attribute QtSCXML. Skipping.''

===== QtSpeech =====
Documentation link: http://doc.qt.io/qt-5.9/qtspeech-module.html

''Could not load PySide2.QtSpeech. Received error: module PySide2 has no attribute QtSpeech. Skipping.''

===== QtSvg =====
Documentation link: http://doc.qt.io/qt-5.9/qtsvg-module.html

Number of types in QtSvg:''' 4'''

Number of missing types:''' 0'''

===== QtUiTools =====
Documentation link: http://doc.qt.io/qt-5.9/qtuitools-module.html

''Could not load PyQt5.QtUiTools for comparison. Received error: module PyQt5 has no attribute QtUiTools.''

Number of types in QtUiTools:''' 1'''

Number of missing types:''' 0'''

===== QtWebChannel =====
Documentation link: http://doc.qt.io/qt-5.9/qtwebchannel-module.html

Number of types in QtWebChannel:''' 2'''

Number of missing types:''' 0'''

===== QtWebEngine =====
Documentation link: http://doc.qt.io/qt-5.9/qtwebengine-module.html

''Could not load PySide2.QtWebEngine. Received error: module PySide2 has no attribute QtWebEngine. Skipping.''

===== QtWebEngineWidgets =====
Documentation link: http://doc.qt.io/qt-5.9/qtwebenginewidgets-module.html

Number of types in QtWebEngineWidgets:''' 12'''

Missing types in QtWebEngineWidgets:

QWebEngineContextMenuData (is present in PyQt5)
QWebEngineFullScreenRequest (is present in PyQt5)
QWebEngineHistory (is present in PyQt5)
QWebEngineScriptCollection (is present in PyQt5)
QWebEngineSettings (is present in PyQt5)

Number of missing types:''' 5'''

Number of missing types that are present in PyQt5:''' 5'''

===== QtWebSockets =====
Documentation link: http://doc.qt.io/qt-5.9/qtwebsockets-module.html

Number of types in QtWebSockets:''' 5'''

Number of missing types:''' 0'''

===== QtMacExtras =====
Documentation link: http://doc.qt.io/qt-5.9/qtmacextras-module.html

''Could not load PySide2.QtMacExtras. Received error: module PySide2 has no attribute QtMacExtras. Skipping.''

===== QtX11Extras =====
Documentation link: http://doc.qt.io/qt-5.9/qtx11extras-module.html

Number of types in QtX11Extras:''' 1'''

Number of missing types:''' 0'''

===== QtWinExtras =====
Documentation link: http://doc.qt.io/qt-5.9/qtwinextras-module.html

''Could not load PySide2.QtWinExtras. Received error: module PySide2 has no attribute QtWinExtras. Skipping.''

===== QtXml =====
Documentation link: http://doc.qt.io/qt-5.9/qtxml-module.html

Number of types in QtXml:''' 31'''

Number of missing types:''' 0'''

===== QtXmlPatterns =====
Documentation link: http://doc.qt.io/qt-5.9/qtxmlpatterns-module.html

Number of types in QtXmlPatterns:''' 16'''

Missing types in QtXmlPatterns:

QSimpleXmlNodeModel (is present in PyQt5)

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtCharts =====
Documentation link: http://doc.qt.io/qt-5.9/qt-charts-module.html

''Could not load PyQt5.QtCharts for comparison. Received error: module PyQt5 has no attribute QtCharts.''

Number of types in QtCharts:''' 48'''

Missing types in QtCharts:

QAbstractAxis
QAbstractBarSeries
QAbstractSeries
QAreaLegendMarker
QAreaSeries
QBarCategoryAxis
QBarLegendMarker
QBarSeries
QBarSet
QBoxPlotLegendMarker
QBoxPlotSeries
QBoxSet
QCandlestickLegendMarker
QCandlestickModelMapper
QCandlestickSeries
QCandlestickSet
QCategoryAxis
QChart
QChartView
QDateTimeAxis
QHBarModelMapper
QHBoxPlotModelMapper
QHCandlestickModelMapper
QHPieModelMapper
QHXYModelMapper
QHorizontalBarSeries
QHorizontalPercentBarSeries
QHorizontalStackedBarSeries
QLegend
QLegendMarker
QLineSeries
QLogValueAxis
QPercentBarSeries
QPieLegendMarker
QPieSeries
QPieSlice
QPolarChart
QScatterSeries
QSplineSeries
QStackedBarSeries
QVBarModelMapper
QVBoxPlotModelMapper
QVCandlestickModelMapper
QVPieModelMapper
QVXYModelMapper
QValueAxis
QXYLegendMarker
QXYSeries

Number of missing types:''' 48'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtDataVisualization =====
Documentation link: http://doc.qt.io/qt-5.9/qtdatavisualization-module.html

''Could not load PyQt5.QtDataVisualization for comparison. Received error: module PyQt5 has no attribute QtDataVisualization.''

Number of types in QtDataVisualization:''' 36'''

Missing types in QtDataVisualization:

Q3DBars
Q3DCamera
Q3DInputHandler
Q3DLight
Q3DObject
Q3DScatter
Q3DScene
Q3DSurface
Q3DTheme
QAbstract3DAxis
QAbstract3DGraph
QAbstract3DInputHandler
QAbstract3DSeries
QAbstractDataProxy
QBar3DSeries
QBarDataItem
QBarDataProxy
QCategory3DAxis
QCustom3DItem
QCustom3DLabel
QCustom3DVolume
QHeightMapSurfaceDataProxy
QItemModelBarDataProxy
QItemModelScatterDataProxy
QItemModelSurfaceDataProxy
QLogValue3DAxisFormatter
QScatter3DSeries
QScatterDataItem
QScatterDataProxy
QSurface3DSeries
QSurfaceDataItem
QSurfaceDataProxy
QTouch3DInputHandler
QValue3DAxis
QValue3DAxisFormatter

Number of missing types:''' 35'''

Number of missing types that are present in PyQt5:''' 0'''

===== Summary =====
Total number of missing types:''' 163'''

Total number of missing types that are present in PyQt5:''' 41'''

Total number of missing modules:''' 6'''

= Stalled version =
== PySide2 bindings for Qt 5.6 ==

Using Qt version 5.6 documentation to find public API Qt types, to test if they are present in PySide2.

Similar report: https://gist.github.com/ethanhs/6c626ca4e291f3682589699296377d3a

This report was generated by running the following command:
python missing_bindings.py --qt-version 5.6 -w all
on the following date:
2017-09-04 08:38:07 CET

===== QtCore =====
Documentation link: http://doc.qt.io/qt-5.6/qtcore-module.html

Number of types in QtCore:''' 166'''

Missing types in QtCore:

QAbstractNativeEventFilter (is present in PyQt5)
QAtomicInt
QAtomicInteger
QAtomicPointer
QByteArrayList
QCache
QContiguousCache
QEventLoopLocker (is present in PyQt5)
QException
QFuture
QFutureSynchronizer
QFutureWatcher
QIdentityProxyModel (is present in PyQt5)
QJsonObject
QLibrary (is present in PyQt5)
QLockFile (is present in PyQt5)
QLoggingCategory
QMessageAuthenticationCode (is present in PyQt5)
QMessageLogger (is present in PyQt5)
QMetaType (is present in PyQt5)
QObjectCleanupHandler (is present in PyQt5)
QRegularExpression (is present in PyQt5)
QRegularExpressionMatch (is present in PyQt5)
QRegularExpressionMatchIterator (is present in PyQt5)
QSharedMemory (is present in PyQt5)
QSignalBlocker (is present in PyQt5)
QStringListModel (is present in PyQt5)
QThreadStorage
QUnhandledException
QUrlQuery (is present in PyQt5)
QUuid (is present in PyQt5)
QVariant (is present in PyQt5)
QVersionNumber (is present in PyQt5)
QWinEventNotifier

Number of missing types:''' 34'''

Number of missing types that are present in PyQt5:''' 19'''

===== QtGui =====
Documentation link: http://doc.qt.io/qt-5.6/qtgui-module.html

Number of types in QtGui:''' 188'''

Missing types in QtGui:

QAbstractOpenGLFunctions (is present in PyQt5)
QAccessibleEditableTextInterface
QAccessibleImageInterface
QAccessibleObject
QAccessibleStateChangeEvent
QAccessibleTableCellInterface
QAccessibleTableModelChangeEvent
QAccessibleTextCursorEvent
QAccessibleTextInsertEvent
QAccessibleTextInterface
QAccessibleTextRemoveEvent
QAccessibleTextSelectionEvent
QAccessibleTextUpdateEvent
QAccessibleValueChangeEvent
QAccessibleValueInterface
QGlyphRun (is present in PyQt5)
QInputMethod (is present in PyQt5)
QInputMethodQueryEvent (is present in PyQt5)
QNativeGestureEvent (is present in PyQt5)
QOffscreenSurface (is present in PyQt5)
QOpenGLContextGroup (is present in PyQt5)
QOpenGLDebugLogger (is present in PyQt5)
QOpenGLDebugMessage (is present in PyQt5)
QOpenGLFramebufferObjectFormat (is present in PyQt5)
QOpenGLPaintDevice (is present in PyQt5)
QOpenGLShaderProgram (is present in PyQt5)
QOpenGLTexture (is present in PyQt5)
QOpenGLTimeMonitor (is present in PyQt5)
QOpenGLTimerQuery (is present in PyQt5)
QOpenGLVersionProfile (is present in PyQt5)
QOpenGLVertexArrayObject (is present in PyQt5)
QOpenGLVertexArrayObject.Binder (is present in PyQt5)
QOpenGLWindow (is present in PyQt5)
QPlatformGraphicsBuffer
QPlatformSurfaceEvent (is present in PyQt5)
QPlatformSystemTrayIcon
QRasterPaintEngine
QRgba64 (is present in PyQt5)
QScrollEvent (is present in PyQt5)
QScrollPrepareEvent (is present in PyQt5)
QSupportedWritingSystems

Number of missing types:''' 41'''

Number of missing types that are present in PyQt5:''' 23'''

===== QtWidgets =====
Documentation link: http://doc.qt.io/qt-5.6/qtwidgets-module.html

Number of types in QtWidgets:''' 200'''

Missing types in QtWidgets:

QAccessibleWidget
QColormap
QMacCocoaViewContainer (is present in PyQt5)
QMacNativeWidget
QProxyStyle (is present in PyQt5)
QScroller (is present in PyQt5)
QScrollerProperties (is present in PyQt5)

Number of missing types:''' 7'''

Number of missing types that are present in PyQt5:''' 4'''

===== QtMultimedia =====
Documentation link: http://doc.qt.io/qt-5.6/qtmultimedia-module.html

Number of types in QtMultimedia:''' 90'''

Missing types in QtMultimedia:

QAbstractPlanarVideoBuffer
QAudioBuffer.StereoFrame
QCameraExposure (is present in PyQt5)
QCameraFeedbackControl
QCameraFlashControl
QCameraFocus (is present in PyQt5)
QCameraFocusControl
QCameraImageProcessing (is present in PyQt5)
QMediaMetaData (is present in PyQt5)
QMediaService (is present in PyQt5)
QMediaServiceCameraInfoInterface
QMediaServiceDefaultDeviceInterface
QMediaServiceFeaturesInterface
QMediaServiceProviderPlugin
QMediaServiceSupportedDevicesInterface
QMediaServiceSupportedFormatsInterface
QMediaStreamsControl
QMediaTimeInterval (is present in PyQt5)
QMediaVideoProbeControl
QMetaDataReaderControl
QMetaDataWriterControl

Number of missing types:''' 21'''

Number of missing types that are present in PyQt5:''' 6'''

===== QtMultimediaWidgets =====
Documentation link: http://doc.qt.io/qt-5.6/qtmultimediawidgets-module.html

Number of types in QtMultimediaWidgets:''' 4'''

Number of missing types:''' 0'''

===== QtNetwork =====
Documentation link: http://doc.qt.io/qt-5.6/qtnetwork-module.html

Number of types in QtNetwork:''' 43'''

Missing types in QtNetwork:

QDnsDomainNameRecord (is present in PyQt5)
QDnsHostAddressRecord (is present in PyQt5)
QDnsLookup (is present in PyQt5)
QDnsMailExchangeRecord (is present in PyQt5)
QDnsServiceRecord (is present in PyQt5)
QDnsTextRecord (is present in PyQt5)
QHttpMultiPart (is present in PyQt5)
QHttpPart (is present in PyQt5)
QSslCertificateExtension (is present in PyQt5)
QSslEllipticCurve (is present in PyQt5)
QSslPreSharedKeyAuthenticator (is present in PyQt5)

Number of missing types:''' 11'''

Number of missing types that are present in PyQt5:''' 11'''

===== QtQml =====
Documentation link: http://doc.qt.io/qt-5.6/qtqml-module.html

Number of types in QtQml:''' 23'''

Missing types in QtQml:

QQmlListProperty (is present in PyQt5)

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtQuick =====
Documentation link: http://doc.qt.io/qt-5.6/qtquick-module.html

Number of types in QtQuick:''' 43'''

Missing types in QtQuick:

QQuickItem.ItemChangeData (is present in PyQt5)
QSGFlatColorMaterial (is present in PyQt5)
QSGMaterial (is present in PyQt5)
QSGMaterialShader (is present in PyQt5)
QSGMaterialShader.RenderState (is present in PyQt5)
QSGOpaqueTextureMaterial (is present in PyQt5)
QSGSimpleMaterial
QSGSimpleMaterialShader
QSGTextureMaterial (is present in PyQt5)
QSGVertexColorMaterial (is present in PyQt5)

Number of missing types:''' 10'''

Number of missing types that are present in PyQt5:''' 8'''

===== QtSql =====
Documentation link: http://doc.qt.io/qt-5.6/qtsql-module.html

Number of types in QtSql:''' 15'''

Number of missing types:''' 0'''

===== QtTest =====
Documentation link: http://doc.qt.io/qt-5.6/qttest-module.html

Number of types in QtTest:''' 4'''

Missing types in QtTest:

QSignalSpy (is present in PyQt5)
QTestEventList

Number of missing types:''' 2'''

Number of missing types that are present in PyQt5:''' 1'''

===== QtConcurrent =====
Documentation link: http://doc.qt.io/qt-5.6/qtconcurrent-module.html

''Could not load PyQt5.QtConcurrent for comparison. Received error: module object has no attribute QtConcurrent ''

Number of types in QtConcurrent:''' 1'''

Number of missing types:''' 0'''

===== QtHelp =====
Documentation link: http://doc.qt.io/qt-5.6/qthelp-module.html

''Could not load PySide2.QtHelp. Received error: module object has no attribute QtHelp. Skipping.''

===== QtOpenGL =====
Documentation link: http://doc.qt.io/qt-5.6/qtopengl-module.html

Number of types in QtOpenGL:''' 1'''

Number of missing types:''' 0'''

===== QtLocation =====
Documentation link: http://doc.qt.io/qt-5.6/qtlocation-module.html

''Could not load PySide2.QtLocation. Received error: module object has no attribute QtLocation. Skipping.''

===== QtPrintSupport =====
Documentation link: http://doc.qt.io/qt-5.6/qtprintsupport-module.html

Number of types in QtPrintSupport:''' 8'''

Number of missing types:''' 0'''

===== QtScript =====
Documentation link: http://doc.qt.io/qt-5.6/qtscript-module.html

''Could not load PyQt5.QtScript for comparison. Received error: module object has no attribute QtScript ''

Number of types in QtScript:''' 13'''

Missing types in QtScript:

QScriptSyntaxCheckResult

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 0'''

===== QtScriptTools =====
Documentation link: http://doc.qt.io/qt-5.6/qtscripttools-module.html

''Could not load PyQt5.QtScriptTools for comparison. Received error: module object has no attribute QtScriptTools ''

Number of types in QtScriptTools:''' 1'''

Number of missing types:''' 0'''

===== QtSvg =====
Documentation link: http://doc.qt.io/qt-5.6/qtsvg-module.html

Number of types in QtSvg:''' 4'''

Number of missing types:''' 0'''

===== QtUiTools =====
Documentation link: http://doc.qt.io/qt-5.6/qtuitools-module.html

''Could not load PySide2.QtUiTools. Received error: module object has no attribute QtUiTools. Skipping.''

===== QtWebChannel =====
Documentation link: http://doc.qt.io/qt-5.6/qtwebchannel-module.html

Number of types in QtWebChannel:''' 2'''

Number of missing types:''' 0'''

===== QtWebEngineWidgets =====
Documentation link: http://doc.qt.io/qt-5.6/qtwebenginewidgets-module.html

Number of types in QtWebEngineWidgets:''' 11'''

Missing types in QtWebEngineWidgets:

QWebEngineFullScreenRequest (is present in PyQt5)
QWebEngineHistory (is present in PyQt5)
QWebEngineScriptCollection (is present in PyQt5)
QWebEngineSettings (is present in PyQt5)

Number of missing types:''' 4'''

Number of missing types that are present in PyQt5:''' 4'''

===== QtWebSockets =====
Documentation link: http://doc.qt.io/qt-5.6/qtwebsockets-module.html

Number of types in QtWebSockets:''' 5'''

Number of missing types:''' 0'''

===== QtX11Extras =====
Documentation link: http://doc.qt.io/qt-5.6/qtx11extras-module.html

''Could not load PySide2.QtX11Extras. Received error: module object has no attribute QtX11Extras. Skipping.''

===== QtXml =====
Documentation link: http://doc.qt.io/qt-5.6/qtxml-module.html

Number of types in QtXml:''' 31'''

Number of missing types:''' 0'''

===== QtXmlPatterns =====
Documentation link: http://doc.qt.io/qt-5.6/qtxmlpatterns-module.html

Number of types in QtXmlPatterns:''' 16'''

Missing types in QtXmlPatterns:

QSimpleXmlNodeModel (is present in PyQt5)

Number of missing types:''' 1'''

Number of missing types that are present in PyQt5:''' 1'''

===== Summary =====
Total number of missing types:''' 133'''

Total number of missing types that are present in PyQt5:''' 78'''

Total number of missing modules:''' 4'''

Qt for Python/pt

2018-05-27T15:13:17Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

{{LangSwitch}}
[[Category:Qt for Python]]
== Qt para Python ==

O Projeto PySide2 tem como objetivo portar completamente o [[PySide]] para Qt 5.x. O desenvolvimento iniciou no [https://github.com/PySide GitHub] em Maio de 2015. O projeto conseguiu portar o PySide para o Qt 5.3, 5.4 e 5.5. Durante o mês de abril de 2016, a The Qt Company decidiu fornecer apoio adequado ao projeto (ver [https://groups.google.com/forum/#!topic/pyside-dev/pqwzngAGLWE detalhes]).

Esta página wiki acompanha o progresso do desenvolvimento do PySide para Qt 5.x e fornece mais informações sobre o esforço.

== Primeiros passos ==

* [[PySide2_GettingStarted|Guia dos Primeiros passospara macOS, Windows e Linux]]
* [https://bugreports.qt.io/browse/PYSIDE Bug tracker] para reportar qualquer problema.
* [https://codereview.qt-project.org CodeReview] e [https://codereview.qt-project.org/#/q/project:%255Epyside.%252B,n,z PySide2 remendos abertos]
* Repositório Git (Ramo 5.9 é o ramo atualmente em trabalho no PySide2)
** ssh://codereview.qt-project.org/pyside/pyside-setup
* [[PySide2_Development_Getting_Started|Desenvolvimento: Primeiros passos]]

== Comunidade ==

* Canal oficial IRC no FreeNode '''#qt-pyside'''
* [http://lists.qt-project.org/mailman/listinfo/pyside Lista de emails oficial]
* Keybase: [https://keybase.io/team/pyside keybase.io/team/pyside]
* Gitter: [http://gitter.im/PySide/pyside2 gitter.im/PySide/pyside2]

== Status do desenvolvimento ==

=== Progresso de desenvolvimento semanal ===
O resumo do progresso do desenvolvimento pode ser encontrado em [https://wiki.qt.io/PySide2_Development_Notes Notas de desenvolvimento por data]

=== Notas de progresso do Desenvolvimento do Pyside ===

A visão mais atual do progresso pode ser encontrada em Jira:

# [https://bugreports.qt.io/secure/IssueNavigator.jspa?mode=hide&requestId=17825 Problemas não resolvidos]
# [https://bugreports.qt.io/secure/IssueNavigator.jspa?mode=hide&requestId=18025 Todos problemas (incluindo os resolvidos)]

O segundo link é útil para monitorar o progresso. A melhor maneira de conseguir isso é ordenar a lista pela coluna "Updated".
Maiores itens de lista de pendências/recursos são arquivados como "User Stories" no Jira.

Qt for Python/GettingStarted

2018-05-27T15:13:02Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
== Getting Started ==
You can install PySide2 by building the source package yourself.

After cloning the official repository you must follow the instructions for
your specific system.
=== Platform Requirements ===
* '''Python''':
** Python 3 (version >= 3.5 recommended) and Python 2 (version >= 2.7 recommended).
* '''Qt''':
** 5.6 onward are supported, but 5.9 (recommended).
* '''libclang''':
** The libclang library (C-bindings), version 3.9 or higher is required for building using the PySide 5.9 branch.
** Prebuilt versions of it can be downloaded from [http://download.qt.io/development_releases/prebuilt/libclang/ download.qt.io].
* '''CMake (version >= 3.1 required) ''':
** The build system required by for building PySide2.
=== Wheels ===

Pre-release wheels are available at http://download.qt.io/snapshots/ci/pyside/
You can install Qt for Python via pip, for example to install the latest 5.9 wheel:

pip install --index-url=http://download.qt.io/snapshots/ci/pyside/5.9/latest/ pyside2 --trusted-host download.qt.io

=== Building PySide2 ===
The building processes are covered in the platform pages.
* [[Qt_for_Python_GettingStarted/Windows|Windows]]
* [[Qt_for_Python_GettingStarted/X11|Linux/X11]]
* [[Qt_for_Python_GettingStarted/MacOS|macOS]]
==== setup.py build script ====
The script ''setup.py'' in the [http://code.qt.io/cgit/pyside/pyside-setup.git/ top level repository] is used to build and install the PySide2 package. It takes a mode argument (''build'' or ''install'') and several options (more options are documented in setup.py itself).·
The main options are:
* ''--qmake=/path/to/qmake'': Path to ''qmake'' of the Qt library to be used
* ''--cmake=/path/to/cmake'': Path to ''cmake'' binary
* ''--build-tests'': Builds tests along with some helper packages
* ''--ignore-git'': Prevents ''setup.py'' from cloning and checking out the git submodules.
* ''--debug'': Build in Debug mode (some restrictions apply to Windows, see [[Qt_for_Python_GettingStarted/Windows#Build_considerations|Build considerations]])
* ''--reuse-build'': Rebuilds only modified files
* ''--openssl=C:\Dev\qtdev\OpenSSL-Win64\bin'': Path to OpenSSL's bindir which contains dlls (Only required for Windows PySide2 packages)
* ''--jobs=#'': Number of # processes to use when building
* ''--standalone'': Copies over the Qt libraries (and other library dependencies) into the PySide2 package to make it work on other machines (on Windows all builds are standalone, even without specifying the command line argument).
* "--verbose": Prints all compiler invocations when building the package.
A typical invocation looks like:
python setup.py install --build-tests --jobs=4
A successful build can be tested by running an example:
python sources/examples/widgets/widgets/tetrix.py
You can search for working examples by typing
cd sources/examples
git grep "PySide2 port"

=== Running Tests ===
To perform all the available tests, just execute:
python testrunner.py test > testlog.txt

Note that to successfully run the tests on Windows you need to point the PATH environment variable to the Qt libdir:
set PATH=E:\Qt\5.9\msvc2015_64\bin;%PATH%

Run only one test(qpainter_test):
ctest -R qpainter_test --verbose

=== Building the Documentation ===

This is currently unexplored terrain [https://bugreports.qt.io/browse/PYSIDE-363 PYSIDE-363], and works at least somewhat only on Linux.
* The sources are in pyside2/doc
* libXML2 and libXSLT should be present when building PySide2 (Ubuntu: apt-get install libxml2-dev libxslt1-dev)
* graphviz + dot should be installed
* QT_SRC_DIR needs to be set
* sphinx should be installed (pip install sphinx)
* qdoc3 is used to generate it

=== Using Qt Creator as a project explorer ===
Qt Creator 4.0+ can be used to open the PySide and Shiboken CMakeLists.txt files as projects, and thus provide usual IDE features for developing PySide - project file navigation, code completion (C++ only), following symbols under cursor (C++ only), syntax highlighting, locator usage, debugging, etc.

Currently there is a limitation that Shiboken has to be built first using the terminal, because the installed shiboken CMake packages will have to be specified for the PySide project in Qt Creator.

The steps for opening the projects in Qt Creator are:
# Open pyside-setup/sources/shiboken2/CMakeLists.txt, and specify a 5.6 Qt Kit to be used
# Build the project as usual (by pressing the build icon for instance)
# Open pyside-setup/sources/pyside2/CMakeLists.txt, and specify the same 5.6 Qt Kit
# Go to projects tab, and under the Build / CMake section find the Shiboken2_DIR setting. You have to specify the path to the folder where the Shiboken CMake package was installed when you compiled Shiboken from the terminal·
# An example path under MacOS is /Users/user/Dev/pyside2-setup/pyside_install/py2.7-qt5.6.1-64bit-debug/lib/cmake/Shiboken2-2.0.0. The path has to be adjusted depending on the user folder name, the version of python and qt, etc
# (Optional) On MacOS you also have to set the ALTERNATIVE_QT_INCLUDE_DIR setting to the Qt kit include path (e.g. /Users/user/Dev/qt56_source/include)
# Apply the CMake configuration changes (by pressing the button), and you should be able to build PySide

Now you can use the project explorer to look through the source cpp files, python files, use the locator feature to open files and file classes / methods, and other features that Qt Creator provides.

== Troubleshooting / Known Issues ==

* Qt 5.9 does not work with OpenSSL 1.1
** When doing a custom Qt build (some unspecified versions for now), It is necessary to have an OpenSSL version of 1.0.x, since there are compatibility issues with newer versions of OpenSSL ([https://wiki.openssl.org/index.php/OpenSSL_1.1.0_Changes#Qt see details])
* PySide2 looks at the system installation if the local Qt version does not have a required module
**The only workaround is to uninstall any module from the system, then PySide2 can look at only the Qt path currently being use.
* Qt packages that directly link to OpenSSL (as opposed to runtime discovery) are not currently supported.
* Make sure that the Python environment location where the PySide2 package will be installed is writable (otherwise you might get various permission denied errors). The install location can be found with 99% probability by running:
python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"

Qt for Python Development Notes

2018-05-27T15:12:44Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]
== 2018 ==

==== 24. May 2018 ====

- discuss details of pypi uploads (accounts, processes and limits)
- need package size extension from pypi
- naming issues for packages
- download.qt.io will be backup distribution source
- need to verify pypi working
- package finalization and testing (limits on changes?)
- entering code freeze mode very soon (limited commitment for time being)
- pep changes
-> 1 test failure, 1 build failure
-> attribution and doc improvements still to be done
- ByteArray changes (interdependence with PEP)
- potential doc changes
-> tab browser example to be finished
-> latest logo files need to be pushed
- final release testing
- TP blog post

==== 17. May 2018 ====
- updated icons/images for Qt for Python project
- PEP updates
- completed the feature implementation but some bug fixing still open
- discussed how heap type change and PEP changes could be easily reviewed/merged (huge patch set series)
- coin
- 5.11 & 5.6 broken, 5.9 & dev working
- waiting for larger coin update which will enable QtForPython to be more independent from Qt CI configurations
- Win32 (VS2015 only) pip received some changes but not quite available yet (subject to coin update)
- Temporary Win32 wheels tests looked promising
- missing bindings for QtCore/Network/Multimedia/GUI/widgets added (https://wiki.qt.io/Qt_for_Python_Missing_Bindings needs updating)
- bindings for QtScxml in the works
- known issue when dealing with unicode data/strings (seg faults)
- various documentation fixes
- dynamic System clang builds with Linux supported
- small build fixes
- Decreased wheel sizes
- more work on blog posts and examples.

==== 10. May 2018 ====
- skipped due to public holidays

==== 03. May 2018 ====
- coin
- 5.6 still blocked, 5.9/5.11/dev working
- Win32 pip still on backlog
- documentation
- references to Shiboken being worked on
- dot images finally working on https://doc-snapshots.qt.io/qtforpython/index.html
- various fixes to non-class related docs
- PEP updates
- integration attempts have revealed some issues with shiboken, private ctors/dtors
- one patchset series for PEP support and Heap Type changes pending
- license updates
- working on Python 2 & 3 type differences (avoiding developers having to deal with these differences)
- Tab Browser example merged

==== 26. April 2018 ====
- New icons for project in work
- 5.9 branch working (5.11 branch is broken due to issues on the Qt side)
- snapshot tool for Windows broken (crashing) -> fix pending but blocked by CI
- in the mean time only mac and Linux snapshots working at the moment
- 5.6 branch broken as well as 5.9 changes for qt5.git need to be merged to 5.6 too
- delivery of 32bit Windows binaries not started
- tiny bug fixes and other types of cleanups (e.g. build scripts) left and right
- General replacement of Pyside name against Qt for Python (module name remains as Pyside)
- APIExtractor documentation still being merged to git
- style sheet issues being addressed
- QtWebEngineCore bindings finally merged
- PEP work ongoing (and coin to work)

==== 19. April 2018 ====
- COIN finally back in working shape
- Further fixes for documentation, module pages, experimentally tried to show in Qt Assistant
- Tab Browser example further improved
- Qt for Python blog posts being worked on
- Continued working on WebEngine issues
- Some investigation and preparations to make WebEngine apps work with PyInstaller (very early phase, still doesn't work)
- Pending patch for QtWebEngineCore bindings
- Installation adjustments for standalone builds on Windows
- Heap types are complete. Starting integration with PEP 384.
- Finished the integration between ApiExtractor and Shiboken documentation.
- Worked on a couple of blog posts.
- Wiki structure and started to write the Tutorials

==== 12. April 2018 ====
- Getting Started guide under works by doc engineer
- focus on fixing coin on Mac & RedHat 7.4 (looks promising so far)
- shiboken documentation and diagrams being updated
- old and unused docs dir shall be cleaned out
- Tab Browser example improved
- License page generated based on attribution files
- lots of discussion when to release Qt for Python TP
- after Qt 5.11 release (scheduled for 31.5.)
- likely to be mid June (stay tuned)
- WebEngine issues
- needs updated qt.conf files to be deployed for apps
- Heap types (work in progress)
- still more work in pipeline to get code PEP 384 ready (Heap types are prerequisite)
- Qt for Python blog posts being worked on

==== 5. April 2018 ====
- first doc snapshot is up and running: https://doc-snapshots.qt.io/qtforpython/
- more work to be done to automate generation of snapshots
- briefly talked about technical blog post opportunities
- pdb files from Windows wheels removed (reducing the wheel size)
- improving the tab browser example
- coin currently not accepting changes
- currently lots of pending patches start to create backlog
- Heap type taking longer than expected
- qApp macro reference leaks finally resolved
- quite a few formatting changes to enforce a common coding style
- lots of smaller fixes

==== 29. March 2018 ====
- skipped due to Easter holidays

==== 22. March 2018 ====
- Release process (do we follow Qt?)
- Release manager provides packages
- RTA testing to be setup -> for each package we run RTA
- Request to be put on mailing list
- Current Test setup proposal
- Win10 (Python 3.6)
- Linux (Python 3.6/2.7)
- Mac (Python 3.6/2.7)
- To be defined a test set (//TODO)
- Testing information to be collected in wiki
- Documentation
- QML advanced tutorial documentation updated
- Landing page in the works
- snapshot still delayed by other qdoc bugs
- style sheet update considered
- so far only dealt with class docs, started to include unrelated doc pages
- snapshot testing (angle & webengine not properly packaged on Windows)
- enum support improved (dealing with scoped enums and enum values)
- general bugfixing to increase stability and address mem leaks
- Talks to PyData submitted
- Qt Charts examples ported
- Proper support for QFlags being worked on
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595] fixed
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595] first heap type protoype under review proving that concept works
- [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560] depends on PYSIDE-595
- CI side
- coin did Python updates which temporarily broke Linux wheels
- briefly discussed manylinux request on mailing list (Qt forms bottom line, no point to extend beyond scope of Qt)
- final list of wheels for release (win, linux, mac) x 2 (2.7 & 3.x Python)

==== 15. March 2018 ====
- Fix to create 3.6 Linux wheels under review.
- Fix scriptableapplication build on Windows, and other small bugs.
- Two QtCharts examples were ported and abstracts were written to submit PyData talks
- Updating the QML advanced tutorial and adding index.rst and gettingstarted.rst
- Tried the wheel pkgs for python 27 on Linux. Works OK except the webengine example, which gives random crashes.
- Docs: [https://bugreports.qt.io/browse/PYSIDE-620 PYSIDE-620 Shadow build issue] fixed, fixed usage of deprecated Sphinx API,
- Continued on [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560], currently Windows problem with Linkage
- Debugging on [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595], final stages
- Fixed [https://bugreports.qt.io/browse/PYSIDE-258 PYSIDE-258]

==== 08. March 2018 ====
- msvcrt.dll to be shipped on Windows
- wheel snapshots are automatically generated
- start with public availability under http://download.qt.io/snapshots/ci/
- snapshots to public pypi server under discussions
- discussion on how to increase value of official pyside mailing list http://lists.qt-project.org/mailman/listinfo/pyside
- looking at build issues on Windows (improving error handling)
- Participation in Python User Group meeting in Berlin (https://www.meetup.com/Python-Users-Berlin-PUB/events/xhqwhpyxfblb/)
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595] - Heap Type conversions ongoing
- test bed created for easier development
- [https://bugreports.qt.io/browse/PYSIDE-363 Documentation]
-> Managed to make libxml, libxsl an optional dependency falling back to QtXmlPatterns (despite [https://bugreports.qt.io/browse/QTBUG-66925 QTBUG-66925])
-> Small fixes to doc modifications
-> Fix class inheritance diagrams for nested classes

==== 01. March 2018 ====
- automatic snapshot process almost in place (pending reviews) (RTA to follow)
- general bug fixing (including build and version problems)
- most community Pyside1 pages point to official Pyside 2 (Qt for Python) wiki pages
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595] - Heap Type conversions ongoing
- documentation improving
-> class diagrams being generated
-> missing links and references
-> dependencies to qdoc bugs
-> snapshot process in works
- added support for scoped enums in pyside
- Important things discussed:
- PySide2 versioning (current proposal WIP patch at https://codereview.qt-project.org/#/c/221767/)
- Do official releases follow Qt branch names? -
-> yes (minor release of Pyside is bound to same minor release of Qt
-> patch level version may differ
- Will we have snapshots, and if so, will they be uploaded to pip? How will we handle snapshot versions?
-> tentative yes, if public pip server supports snapshots Pyside should be good citizen
- alpha / beta / RC versioning?
-> Pyside should follow the Qt schema
- Probably need to take into account PEPs for versions pushed to Pypi.
- Shiboken / PySide2 versions in sync?
-> yes, they should be in sync
- Will we specify a version for 5.6 branch?
-> yes, but no packages being made
- Are we sticking to the package name PySide2, but follow Qt 5.x versions as PySide2 versions?
-> Pyside2_5.11.0 as in https://codereview.qt-project.org/#/c/221767/
- Do we want to deploy msvcrt dlls into Windows packages?
-> needs more research - is it really needed ?
- Do we want to ship debug symbols for Qt inside the PySide2 packages?
-> not for now
- Do we want to ship debug Qt shared libraries for macOS packages? (not possible on Windows, not applicable on Linux afaik).
-> not for now
- How will the pip upload process look like? Manual uploads? Who takes care of it?
-> Qt release team will take care of it
- Current branching policies:
-> 5.6 branch stops being merged into 5.9 (after pending patches have merged) -> cherry-pick mode
-> 5.9 is base line for patches and being forward merged to 5.11
-> no packages from 5.9 & 5.6 (interested parties need to get it from git)
-> 5.11 becomes branch for first TP
-> dev is feature development
-> all first TP release related patches go to 5.9 (and 5.11 subsequently)

==== 22. February 2018 ====
- dev branch is still/again broken in CI, seems like pyside issues
- changes to create automatic snapshots out of CI is still under review
- Numerous small fixes to the [https://bugreports.qt.io/browse/PYSIDE-363 doc] generation, significantly bringing down the number of documentation warnings
- Massaged build rules to improve built packages
- Removed unnecessary _utils.py file [https://bugreports.qt.io/browse/PYSIDE-600 PYSIDE-600]
- Changed wheel package names to contain both PySide2 version and Qt version against which it was built [https://bugreports.qt.io/browse/PYSIDE-613 PYSIDE-613]
- Finally got libclang to be deployed into packages
- Improved build process not to copy unnecessary symlinks and duplicating libraries when creating wheel (so that you don't get 3x size increase because of 3x number of WebEngine libraries) [https://bugreports.qt.io/browse/PYSIDE-495 PYSIDE-495]
- Fixed wheel package names to contain correct minimum deployment target with which macOS was built with (on further analysis, this will need further improvement) [https://bugreports.qt.io/browse/PYSIDE-612 PYSIDE-612]
- Fixed rpath handling for QtWebEngineProcess when creating standalone packages on macOS [https://bugreports.qt.io/browse/PYSIDE-605 PYSIDE-605]
- Added CMake build rules for scriptable application example [https://bugreports.qt.io/browse/PYSIDE-597 PYSIDE-597]
- Investigated and fixed a heap corruption bug in a test that caused constant crashes on macOS CI runs
- Reduced number of warnings when running shiboken to create user bindings (like scriptable application example) [https://bugreports.qt.io/browse/PYSIDE-587 PYSIDE-587]
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595]: Making slow progress, still debugging. It's a difficult process, but assumption is that it will work.
- Havent's merge [https://codereview.qt-project.org/#/c/220083/ this new patch] because we should be 200% sure it's properly working.
- Working on a few bugs [https://bugreports.qt.io/browse/PYSIDE-106 PYSIDE-106] [https://bugreports.qt.io/browse/PYSIDE-570 PYSIDE-570]
- One of the bugs [https://bugreports.qt.io/browse/PYSIDE-611 PYSIDE-611] was valid only for 5.6, but I noticed a strange behaviour on 5.9, so I will keep working on it, even after we move 5.6 to cherry pick mode.

==== 15. February 2018 ====
- CI broken, 5.6 & dev branch broken, 5.9 just got working again
- first TP will be 5.11 based (needs 5.11 git branches, 5.6 branch goes into cherry-pick mode, 5.9 branch remains main target)
- more modules added to doc, qt3d & qtquick has some special handling
- snippet work ongoing
- snapshot generation on the agenda
- lots of bug fixing e.g.: [https://bugreports.qt.io/browse/PYSIDE-104 PYSIDE-104]
- [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560]

==== 8. February 2018 ====
- Looking through previous EuroPython talks to write a proposal for this year.
- Working on a few bugs (fixed a couple related to objects references),
- that sadly will open new issues with memory management. A further analysis on this matter could improve the current memory leaks on PySide.
- Trying to "organise" a little the typesystem XML files.
- Working on [https://bugreports.qt.io/browse/PYSIDE-104 PYSIDE-104] that ended up being a general issue on PySide about a proper verification between slots and signals arguments, to find the best match.
- Merged a few build related changes in 5.6
- Pending change for [https://bugreports.qt.io/browse/PYSIDE-593 PYSIDE-593]
- Pending change for [https://bugreports.qt.io/browse/PYSIDE-605 PYSIDE-605]
- Merged changes for [https://bugreports.qt.io/browse/PYSIDE-603 PYSIDE-603] and [https://bugreports.qt.io/browse/PYSIDE-604 PYSIDE-604]
- Investigated and attached minimal reproducible example for [https://bugreports.qt.io/browse/PYSIDE-585 PYSIDE-585]
- Investigated some macOS build related aspects for package release
- 5.6 CI is unblocked, but 5.9 CI is blocked due to qtbase issues (version bumping)
- [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560] waiting for view
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595] work ongoing, not ready yet
- [https://bugreports.qt.io/browse/PYSIDE-363 PYSIDE-363] Documentation: Fixed images, fix handling of qdocconf files that contain several modules. Looking at snippet resolution.
- Problems with Qt3D due to refactoring of Qt3Dextras in 5.10. Pushed [https://codereview.qt-project.org/#/c/219105/ patch] suggestion.

==== 1. February 2018 ====
- Continued work on documentation [https://bugreports.qt.io/browse/PYSIDE-363 PYSIDE-363], fixed static pages, add more modules, fixed parameters to qdoc, images
- The GettingStarted wiki is getting better, besides a cleaning it a bit
- moved the topics around to have guidelines by supported platform (''a la Qt'')
- have received feedback and trying to add more information
- Addressed bugs:
- [https://bugreports.qt.io/browse/PYSIDE-34 PYSIDE-34]
- [https://bugreports.qt.io/browse/PYSIDE-264 PYSIDE-264]
- cleaning a bit Shiboken's XML files.
- [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560]
- ported to 5.9, extended to 18 header files
- solved unicode problem
- reduced the patches to be minimal (avoid many #ifdef's, use a verbose macro name if possible)
- made everything compile but one announced file: "object.h" depends on the heaptypes solution ([https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595]). Removed WIP status,review pending.
- [https://bugreports.qt.io/browse/PYSIDE-595 PYSIDE-595]
- Started experimenting
- turned out that the signature extension barfed because it could no longer find the type "__name__". The function PyType_Type.tp_new needs to be called to provide the "ht_name" attribute that is used in heaptypes.
- solving the attribution file issues.
- Pending patches to fix libICU issues
- Pending patches to fix OpenSSL issues [https://bugreports.qt.io/browse/PYSIDE-599 PYSIDE-599]
- Pending patches to deploy libclang library for shiboken
- Improved documentation about OpenSSL dependency
- Pending patches for cleaning up build scripts a bit (logging and refactoring)
- Pending patches to reduce barrage of warnings [https://bugreports.qt.io/browse/PYSIDE-587 PYSIDE-587]
- Pending patch for adding CMake build rules for the scriptable_application example (useful as a reference on how to use shiboken for custom bindings) [https://bugreports.qt.io/browse/PYSIDE-597 PYSIDE-597]
- Old 5.6 CI integration issue fix, but a new issue appeared that was fixed for 5.9 and dev, but still blocks 5.6
- Updated the qml basics tutorial

==== 25. January 2018 ====
- Pyside not renamed
- Releasing preparation
- pip packages created by coin
- Automated release testing (RTA) (installing pip, launching an example)
- final selection of release package targets to be define closer to release (depending on current stable ABI work)
- Investigation doc issues when using prefix & shadow builds
- Need to identify prime demos/examples
- Started to rework [[PySide2 GettingStarted|Getting Started Guide]] wiki
- Addressed cmake build issues
- Handling libICU issues (causing linker issues when importing QtCore)
- Continued work on [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560]

==== 18. January 2018 ====
- macOS framework fix (should ignore qt4 system headers)
- another patch on top to fix OpenGL integer types on mac / Linux (GLuint64, GLint64)
- Fixed so that PySide 5.6/5.9 is not linked against the Python shared / static library (this was wrong because the symbols need to be picked up by the dynamic loader from the python interpreter itself). http://bugreports.qt.io/browse/PYSIDE-522
- Completed move of examples from pyside-examples.git to pyside-setup
- added additional OpenGL2 core example
- fixed testrunner (these silently failed since forever) https://codereview.qt-project.org/#/c/216732/
- fixed issues whereby wrong QObject ctors were selected
- removed webkit from Pyside2 build
- talk about Windows specific instructions for [[PySide2 GettingStarted|Getting Started Guide]]
- Qt3D issues in Qt 5.10 fixes
- clazy warning fixes
- Stable ABI work (started to convert implementations) (see [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560])
- requires adoption of HeapTypes
- QML tutorial updates
- Doc snapshots being prepared

==== 11. January 2018 ====
- multi pyside packages (not easy to do)
- unlikely to achieve until TP
- a package per python release (3.4, 3.5, 3.6, 2.7)
- package per platform (win 32bit|64bit, mac, linux)
- long term task to convert to reduced Python API (to support multi 3x packages)
=> have to cut some targets: one 3x and 2.7 release
-> create doc howto to encourage custom builds for not covered platform combo
-> do we need commercial for release
- pysinstaller is an installer
-> deployqt tool not necessary
-> documentation required stating the option
- rename import options
- rename via alias possible
-> still an issue when looking up particular types but probably manageable
- renaming option: Qt4Pyton, QtPy, QtPython, Python4Qt, Qt
- example shift
- https://codereview.qt-project.org/#/c/215900/
- Basics for doc generation toolchain
- Issues where cmake picks up platform Qt references where it should use a Qt custom install
- Qt3D bindings still under progress
- [https://bugreports.qt.io/browse/PYSIDE-34 PYSIDE-34] & [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560]
- Documentation
- minor doc fixes
- documenting examples

==== 4. January 2018 ====
- multi pyside packages (not easy to do)
- renaming Pyside to "Qt for Python"
- quite challenging due to implied import and lib changes
- alias for existing imports would be beneficial
- discussion around existing function test
-> working assumption is that we ignore added function and check for existing base line only
-> effort too large to maintain every single new addition
- discussed issues around concurrent existing Qt builds while building pyside (potential cross leakage)
- various fixes to doc generation steps (see [https://bugreports.qt.io/browse/PYSIDE-363 PYSIDE-363])
- discussed need for good examples as part of documentation
-> considered options to cleanup and remove need for submodule

== 2017 ==

<div class="mw-collapsible mw-collapsed" style="overflow:auto;">

==== 21. December 2017 ====
- Issues building for Windows for Python 2 and 3 (on coin)
- discussing potential pyside demo/example for RTA purposes
- Continued work on macOS / Qt 4 header issues, progress is there
- breaks GL signature test on Linux, needs further investigation
- Investigated PyInstaller (potential option to deploy apps written with Pyside)
- seems to work almost out-of-the-box for deploying PySide apps
- Investigated building one package compatible with multiple Python 3.x minor versions
- not possible currently, will require a lot of work, possibly not feasible
=> we need to build 3.4,3.5,3.6 * win, linux, mac packages = 9 packages
=> 3 more for each platform and Python 2.x
=> commercial packages?
- lots of discussions and fixing of doc tool chain (qdoc in dev currently broken)
- adding documentation has begun in earnest
- continued work on PYSIDE-578

==== 7. December 2017 ====
- pip wheel installation
- adding support for simultaneously python 2 and 3 builds
- open issues: test installation towards multi python 3 versions
- delivery channel for Pyside binaries (pip server? local install from qt account download?)
- investigate options to have sth like pyinstallqt (pysinstaller is a possibility)
- final keyword support by shiboken
- Qt3D bindings patch close to completion - > requires some Qt changes in 5.9.4 or later Qt
- fixing pyside build issues when encountering Qt 4 headers on macOS
- PYSIDE-578 (testing procedure/testrunner) -> adds heuristic to adapt to failure rates (flakiness handling)
- concerns that running all tests 5 times adds too much load on the CI (test runs needed)

==== 30. November 2017 ====
- packaging related coin changes
- last weeks merges between 5.6 and 5.9+ blocking coin have been fixed (in particular on RHEL)
- 5.9 + 5.6 are passing, dev has some private Qt changes which will affect pyside/dev
- lots of coin infrastructure issues
- RTA test wheels added (install and launch single example)
- crash bugs in 5.6 branch reported but not details known yet (waiting for more details)
- some discussion what changes should be put to 5.6 vs 5.9 branch
- Qt3D bindings started
- some changes in qt3d/5.9 required)
- shiboken bugs discovered in the process (virtual function guessing & some comparison operators for namespace generated)
- small regression related to rpath handling on Linux
- open pip wheel issues:
- handling of multi Python version wheels
- testrunner bugs addressed and reducing flakiness
- issues in Pyside when building with gcc 7.x
- qdoc from qt5/dev is required for pyside due to webxml support
- it is a problem for the pyside/5.9 branch

==== 23. November 2017 ====
- pip wheel support issues on Linux solved (not yet verified)
-> libICU usage on Linux should be enabled via pyside setup script
-> downloaded from qt account download area
- discussion how to do wheel builds for different Qt base lines -> implies to different wheel packages
- need to evaluate how different python versions on various Linux distros impact wheel binaries
- target: 6 wheels (2 per platform for 2.7 & 3.5+ Python)
- OpenGL example
- merge 5.6-> 5.9 attempted
- signature update to match Qt 5.9 ABI/signatures
- plenty of testing flakiness and also test crashes
- improvements to signature tests

==== 16. November 2017 ====
- Build system cleanup. It is now possible to build only a subset of Qt modules per cmd line option
- this is not complete and may need further patches
- Added QAxContainer, more classes from 5.10
- Preparing to add Qt3D
- Removed flaky test
- further research on how pip wheels might be used for Pyside
- seems to work well on win & macOS
- problems on Linux related to libICU (or in general due to different system libraries)
- implemented and tested --standalone feature for the main Qt platforms [https://bugreports.qt.io/browse/PYSIDE-558 PYSIDE-558]
- open question remains how 3rdparty Pyside deployment path might look like
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510]

==== 9. November 2017 ====
- Work on simplifying the build system, made it possible to specify a module subset to build
- [https://bugreports.qt.io/browse/PYSIDE-558 PYSIDE-558] Fixing rpaths and making --standalone work on the 3 platforms. Result: Self-contained binary wheels. Needs Review.
- Trying to setup the project for building the docs. I managed to build the rsts from the patch in gerrit but running sphinx on those rsts results in errors about python 2 style code.
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] work continued

==== 2. November 2017 ====
- Releasing:
- continued work on macOS installer
- binaries must be patched during the install from repo (rpath setting)
- adopting the scripts from Qt for Pyside
- made pip install work on Mac -> would be alternative to online installer approach
- two deployment choices available
- discussions on how void* pointer should be handled, two options on the table
- add additional Pyside module handling such pointers
- add feature to shiboken to transparently add the support to any arbitrary C++/pyside project using shiboken
- documentation snapshot generated
- simplified setup-pyside and related build script options

==== 26. October 2017 ====
- Releasing:
- test repo for online installer created (mac seems to deploy)
- first evaluation of suggested installer approach on various platforms
- Documentation:
- Qt doc team joined the effort
- first experiences are collected
- should new documentation be done in rst rather than qdoc format?
- Getting started, General platform requirements and general fixes turning up during generation
- [https://bugreports.qt.io/browse/PYSIDE-571 PYSIDE-571] received further fixes and reviews
- REDHAT not working on Coin (caused by gcc header issues)
- other minor improvements

==== 19. October 2017 ====
- Discuss open Pyside 2 release & documentation
- Release packaging suggestion
- Qt for Python installed via Qt installer and python scripts pointed to module via PYTHON_PATH
- create test online repository for Qt installer
- follow up how this Pyside installation approach might impact deployment of Python apps using Qt for Python
- Linux distros shipping Pyside? (not sure yet either)
- coin
- breakage in CI provisioning due to competing Python binaries coming from MSVC 2017
- coin template needs updating
- [https://bugreports.qt.io/browse/PYSIDE-571 PYSIDE-571] work progressing (ready for review)
- lots of fixes in Pyside dev branch and
- feedback from Qt World Summit:
- is Pyside on Android and iOS?
- iOS probably out since platform cannot have interpreted code
- Scriptable application use case was a sought after feature
- qdoc got WebXML patch -> open question which version to use for doc generation across the various pyside versions
- add script to support single command to generate documentation

==== 12. October 2017 ====
- no update due to Qt World Summit 2017

==== 05. October 2017 ====
- Qt DataVisualization port has finished including an example
- Coin no progress due to pending Qt 5.9.2 release
- webxml support being implemented inside qdoc (beginning of the pyside documentation toolchain)

==== 28. September 2017 ====
- 5.6 and 5.9 branches are *finally* enforced by CI - yeeeaaahh
- Dev branch is still missing some forward merges before it can be enabled.
- port of QtDataVisualization progressing
- fixed bugs: [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510], [https://bugreports.qt.io/browse/PYSIDE-517 PYSIDE-517], [https://bugreports.qt.io/browse/PYSIDE-562 PYSIDE-562], [https://bugreports.qt.io/browse/PYSIDE-564 PYSIDE-564]
- [https://bugreports.qt.io/browse/PYSIDE-156 PYSIDE-156] in progress, first example of qApp protection, benchmark of impact ongoing

==== 21. September 2017 ====

- Prototyping and exploring of Pyside packaging options
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] done and merged
- [https://bugreports.qt.io/browse/PYSIDE-156 PYSIDE-156] being addressed thanks to [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510]
- [https://bugreports.qt.io/browse/PYSIDE-487 PYSIDE-487] Qt Data Visualization port progressing

==== 14. September 2017 ====
- Coin
- 5.6 testing is back online (5.9 target unblocking pending a merge)
- Packaging of Pyside started to become a discussion topic
- Standard PIP deployment
- Separate delivery via the usual Qt account channel
- void* support has a pending patch (https://codereview.qt-project.org/#/c/205124/ and related example https://codereview.qt-project.org/#/c/205272/)
- Documentation work ongoing
- WebXML support was added to qdoc - see [https://bugreports.qt.io/browse/PYSIDE-363 PYSIDE-363]
- inputting the resulting WebXML to shiboken gave promising results
- Qt Creator gain ability to fold away Python license headers
- Signature patch (https://codereview.qt-project.org/#/c/198654/)

==== 7. September 2017 ====
- Pyside CI broken (timeout for tests is zero)
- Pyside provisioning scripts are very fragile
- Qt's own provisioning is interfering when e.g. Pyside relevant tools get changed by Qt
- new ideas and redesign is likely to be needed
- New Bindings: QRegularExpression, QVersionNumber, QUuid,
- Discussions around Documentation for pyside
- couple of options for generation pipeline
1.) qdoc generates WebXML -> Shiboken converts WebXML to ReST (used to work in Qt 4 days)
2.) qdoc is lib which creates AST - > shiboken uses the AST to generate ReST
3.) \pyside to document python classes (lots of documentation effort and not ReST integratable)
4.) minimalistic approach is to merely link to the Qt object class reference (python specific docs are somewhat separate
- [https://bugreports.qt.io/browse/PYSIDE-516 PYSIDE-516] further investigation how to deal with void* APIs
-> prototyping ongoing
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] redesigned once again (no more internal Python dependencies, Python version independent implementation)

==== 31. August 2017 ====
- 5.9 passes on all platforms but one (10.10 still failing)
-> fix for provisioning scripts pending
- 5.6 no problems at hand (all passing)
- [https://bugreports.qt.io/browse/PYSIDE-516 PYSIDE-516] hit a dead end
-> fundamental way of passing vertex data (void*) pointer between Python and C++ not addressed yet
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] complete

==== 24. August 2017 ====
- Coin 5.9 provisioning is in place, but there are some issues with paths to tools which are being addressed
- Build issue on Windows 10 5.9 branch, addressed by patch in review https://codereview.qt-project.org/#/c/203406/
- Fix to macOS build when old Qt 4.8 is present, addressed by patch https://codereview.qt-project.org/#/c/203313/
- [https://bugreports.qt.io/browse/PYSIDE-516 PYSIDE-516] progress on bringing in more of the QOpenGL classes
- [https://bugreports.qt.io/browse/PYSIDE-560 PYSIDE-560] stable ABI was investigated, decision is required
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] finalizing license modifications
- [https://bugreports.qt.io/browse/PYSIDE-156 PYSIDE-156] ongoing implementation for fixing qApp crashes
- [https://bugreports.qt.io/browse/PYSIDE-552 PYSIDE-552] in process of being merged
- [https://bugreports.qt.io/browse/PYSIDE-562 PYSIDE-562] pending patch
- [https://bugreports.qt.io/browse/PYSIDE-563 PYSIDE-563] in process of being merged
- PySide 2 presentation being prepared for Qt World Summit 2017

==== 17. August 2017 ====
- Almost everyone is still on holiday - not much progress
- PySide 5.9 branch CI changes are still pending integration / ongoing due to issues with the CI infrastructure switch
- Investigation ongoing regarding QSSL classes on 5.9 branch
- PYSIDE-510 - ongoing work to make separation of different licensed code
- PYSIDE-156 - initial work to stop crashes when using methods that require an allocated QApplication instance
- PYSIDE-558 - initial investigation on how to proceed
- Updated the PySide2 wiki documentation to clear up build steps and requirements.

==== 10. August 2017 ====
- holiday time is hampering project at the moment - not much progress
- CI changesin Qt affected Pyside project such that focus was on different CI matters
- [https://bugreports.qt.io/browse/PYSIDE-557 PYSIDE-557] being addressed
- some very minor issues were fixed

==== 03. August 2017 ====
- PYSIDE-510 under code review https://codereview.qt-project.org/198654
-> license issues have to be addressed
-> some testing aspects still open (delayed till later on)
-> investigation of impact on deployment across multiple python run-time versions required
- missing bindings script/wiki page updated: [[PySide2_Missing_Bindings|Missing PySide2 bindings]]
- first working array support has been delivered (some adjustments still required), now proceeding to extend for OpenGL [https://bugreports.qt.io/browse/PYSIDE-516 PYSIDE-516]
- Missing classes in works (e.g. QAbstractnativeEventFilter, QFileLock,....)
-> revealed some issues of handling void* pointers

==== 27. July 2017 ====
- Fix for [https://bugreports.qt.io/browse/PYSIDE-331 PYSIDE-331] causes lots crashes in auto tests
-> more investigation ongoing
- coin
- since 5.6 is now enforced by Qt CI the focus shifted to the 5.9 branch of Pyside
- still encountering build issues on 5.6 though
- cmake upgrade for macOS 10.10
- missing virtual env for macOS 10.12 being deployed
- msvc 2013 being removed from CI targets
- clang on OpenSuSE deployment ongoing
- lots of effort went into debugging the above Coin issues
- numpy support for 2d array feature development progressing ([https://bugreports.qt.io/browse/PYSIDE-354 PYSIDE-354])

==== 20. July 2017 ====
- coin
- license test passing
- setup issues wit Python 3 and msvc 2008 vs 2015 issues
=> need to install newer Python 3 binaries
=> otherwise looks like enforced testing can be set alive on 5.6 branch
- 5.9 still having clang header issues
- 2D array support work in progress
- [https://bugreports.qt.io/browse/PYSIDE-331 PYSIDE-331] -> waiting for PYSIDE-510 dependency
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510]-> issues with Python 2.x left
- need to get a handling what functions are not supported by pyside due to exclusions or missing support in shiboken

==== 13. July 2017 ====
- coin
- Production coin was updated today and all fixes are finally executed
- 5.6
- macOS 10.11 machines have Python 2.6, which causes test script to fail due its usage of a
module added in 2.7. Investigation in progress on the best way to fix this.
- build failure with Windows 8.1 (msvc2013-x86)
- 5.9
- macOS 10.12 missing virtual env (https://codereview.qt-project.org/200006)
- Rest Linux/macOS configs are failing various build issues
- dev is still pending for qt5 merge from 5.9
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] development completed, test added, needs review
- [https://bugreports.qt.io/browse/PYSIDE-331 PYSIDE-331] ongoing work
- [https://bugreports.qt.io/browse/PYSIDE-550 PYSIDE-550] investigated, needs a working solution to allow proper building on distros that separate Qt private headers into separate packages
- [https://bugreports.qt.io/browse/PYSIDE-354 PYSIDE-354] ongoing work on C / C++ array support in PySide, some questions remains on how to deal with xml syntax and multiple dimensions.

==== 29. June 2017 ====
- coin
- Qt 5.6 all coin changes for Pyside are done but waiting for coin production update (after Qt 5.9.1 release)
- Pyside/Qt 5.6 on new OpenNebula infrastructure confirmed to run
- Qt 5.9 based setup still misses clang libs (merge pending)
- Pyside/Qt 5.9 test failure fixes on macOS
- worked on array support (passing arrays between Pyside and Qt API) - work in progress ([https://bugreports.qt.io/browse/PYSIDE-354 PYSIDE-354])
- continued work on debug builds across the platforms
- embedded Python example under review (further testing across the platforms)
- [https://bugreports.qt.io/browse/PYSIDE-510 PYSIDE-510] finished (not yet merged) -> revealed a few more problems in [https://bugreports.qt.io/browse/PYSIDE-331 PYSIDE-331] & [https://bugreports.qt.io/browse/PYSIDE-308 PYSIDE-308]
- added a way to dynamically detect the available Qt modules in Pyside

==== 22. June 2017 ====
- building pyside on Win with debug and non-debug
- QSSL* classes do not build on macOS & Windows (patch in progress)
- dll name handling work finished (build system issues were addressed)
- PYSIDE-531 discussions
- coin
- followup from 18 May (windows issues in coin)
- test runner changes being merged should address this
- new regression on macOS targets though
- 5.9 issues due to clang continue to exist (will be addressed after 5.6 is enforced)

==== 15. June 2017 ====
- dll name handling fixed across the platforms (e.g. pkgconfig handling)
- PYSIDE-500 fixed
- PYSIDE-331 is still not done (in parts a module by module fix is required)
- PYSIDE-510 ongoing
- no further progress on coin
- Getting started guide has been updated dealing with Qt 5.6 and Qt 5.9 based Pyside builds
- scriptable Pyside example been developed to demonstrate SDK-like usage of Pyside
- lots of small infrastructure changes/fixes

==== 8. June 2017 ====
- Proposed solution for PYSIDE-500
- Further work on example for PYSIDE-526, work on shiboken2 command line handling to ease usage with qmake
- Updated Getting started Wiki
- Introspection work continued (PYSIDE-510)

==== 1. June 2017 ====
- PYSIDE-500
- https://wiki.qt.io/PySide2_GettingStarted needs a serious cleanup
- 5.6 vs 5.9 differences not explained
- specify exact version matching conditions
- pyside repo merge completed
- Coin changes required to catchup - > recent CI issues have caused delay
- Introspection work continued (PYSIDE-510) -> not yet complete
- qtcharts and related examples have been ported (5.9 only)
- license header checks of Pyside for Coin able to distinguish branches
- Array support for Pyside missing (numpy_array support?)

==== 18. May 2017 ====
- Coin
- Win nodes didn't run the cleanup functions -> test failures due to artifacts -> no solution yet
- Clang issues persist and this must be addressed in the broader scope of Qt/qdoc depending on libclang too
-> until this point in time the setup is a manual one for pyside/5.9+
- merge of psyide repositories -> no objections against the plan in the community
-> merge will happen in the next few days (pyside.git, pyside-setup.git and shiboken.git become one repo)
-> examples, wiki and tools will remain as they are
- QOpenGL* porting continuing
- qttext2speech ported to Pyside2
- failing QML tests in Qt 5.9 based Pyside
- PYSIDE-510 - introspection solution in the works
- Qt World Summit Berlin 2017 (talk for Pyside being handed in)

==== 12. May 2017 ====
- looked into the Windows tests failures, and the reason might be related to how we copy around build artifacts, leading to an incorrect folder structure. Coin team to look at it.
- Fixed a small regression in 5.9 with building on macOS after some cmake changes that happened in 5.6
- Implemented, tested, reviewed and committed the multimedia widgets examples
- documentation from Pyside1 days can not be generated anymore
-> new approach required using exiting Qt5 doc tools
- QOpenGL* port to Pyside has started -> missing support for arrays in shiboken
- more thorough design discussion needed
- Coin
- provisioning for clang in Qt CI ongoing: https://codereview.qt-project.org/#/c/192517/10

==== 04. May 2017 ====
- Coin
- libclang 4.0 provisioning available (code reviews ongoing -> enabler for Pyside and qdoc testing)
- 5.6 coin issues resolved
- macOS related CI/cmake failures were resolved
- some CI sync issues among pyside submodules (always submodules HEAD is tested)
=> may have to change once we come closer to the final release ->
=> fine as long as we are in heavy development mode
- discussion around Ubuntu and OpenSuse configurations
- minimal cmake requirements not met on all distros
- 5.6 only be build using RedHat 6.6
- 5.9 builds have updated Linux distros -> may be able to obtain a new cmake version without hacking the standard toolchain
- QtMultimedia and QRaster* API bindings further completed
- added tests and examples for the above bindings/APIs
- PYSIDE-510 (required for simplified and more generic testing of bindings)
- PYSIDE-504 work is ongoing
- PYSIDE-507 -> avoid hardcoded includes when certain Qt modules are not available
- brief discussion whether to merge the shiboken and pyside repo
-> advantages from a CI perspective and reduces pyside setup complexity

==== 26. April 2017 ====
- Coin
- provision for 5.9+ branches -> we would like to use libclang 4.0
- test still not yet executed due to branch mismatch which pulls in dev branches
- missing bindings in QtCore/QtGui/QtMultimedia - work in progress
- clang support done (except for a Mac issue)
- Pyside clang version required Qt 5.7 or later
- [https://bugreports.qt.io/browse/PYSIDE-500 PYSIDE-500] done
- work on PYSIDE-500, 502, 504, 497 will continue
- qdoc work started trying to recover whatever documentation is left from Pyside 1.x

==== 20. April 2017 ====
- Fix for [https://bugreports.qt.io/browse/PYSIDE-331 PYSIDE-331] broke the Windows build; under investigation
- Refactoring, fixed build warnings
- Looked at debug builds on Windows

==== 13. April 2017 ====
- discussion around merge policies between 5.9 and 5.6 branch
- Linux debug library issues fixed
- PYSIDE-488 fixed via workaround
- fixed a unit tests
- worked on qdoc/html generation in Pyside (failed so far - waiting for qdoc maintainer feedback)
- PYSIDE-331 patches merged -> more bugs found in the meantime

==== 6. April 2017 ====
- 5.6 branch created
- 5.9 branch to be created as well (easier setup for Qt 5.9 testing in Coin)
- Coin
- not passing build platforms have been disabled
- otherwise COIN passing on 5.6 (except for 2 failing test) -> soon to be enforced
- license checker passing in dev
- clang changes merged to dev branch (after reviews)
- clang provisioning on Coin still missing
- for now shiboken is not a generic C++ bindings generator (targeting Qt use cases only)
- TODO: enabling the generation of documentation from repos
- fixed mixed usage of debug and release build (no debug builds for windows)
- [PYSIDE-331] work continuing - fixed, tests are missing

==== 30. March 2017 ====
- Coin
- some platforms passing and will be enabled by default
- MinGW, some OSX and cross compile targets remain out
- will branch pyside dev branches to 5.6, new dev becomes clang branch
- regular merges from 5.6 -> dev will start happening
- Pyside 5.6 branch will continue to work against Qt 5.6
- need reviews for [https://bugreports.qt.io/browse/PYSIDE-323 PYSIDE-323] to merge clang changes
- Qt 5.10, 5.9 (on main desktop plawtforms working)
- for now the Pyside dev development will be based on Qt 5.9 (to be bumped up later on)
- [PYSIDE-331] - in progress
- [PYSIDE-156] -

==== 23. March 2017 ====
- Coin
- progressing
- More tests fixed
- wip/clang branch created, will receive Clang parser port with instructions
- Refactoring of shiboken, replaced QtXml classes by QXmlStreamReader allowing for stricter error checking

==== 16. March 2017 ====
- Coin
- the fixes are still integrating or are under review (no further progress until this is done)
- clang parser replacement [https://bugreports.qt.io/browse/PYSIDE-323 PYSIDE-323]
- most test failures related to clang are fixed
- tests ran pretty much through on Qt 5.9 (Windows and Linux - Mac not yet verified)
- code cleanups in shiboken
- will create feature branch on all pyside repos to get the clang patch series under CI control
- merges from regular pyside branches into clang branch will commence
- readme required that explains how clang is to be built (if not provided by platform)
- [PYSIDE-331] - in progress

==== 09. March 2017 ====
- Coin
- lots of changes in Gerrit for Pyside and coin
- the outcome has to be check once everything merged
- upcoming clang dependencies in shiboken introduces new requirements for Coin
- clang changes to be dealt with after pyside branching
- clang
- first complete bindings generation with Qt 5.6 and Qt 5.9
- some failing unit tests which have to be looked at individually
- actual merge depends on pyside branching which in turn depends on recent Coin changes
- smart pointer support
- patches generally done, gerrit review ongoing
- rather large patch
- created list of missing bindings in Pyside ([https://wiki.qt.io/PySide2_Missing_Bindings Missing Bindings])
- mostly class level view, global functions at al not covered
- Jira cleanup
- PYSIDE-464, PYSIDE-217, Pyside-224 fixed
- most bugs reviewed now and valid ~100 bugs were identified

==== 02. March 2017 ====
- Coin
- Coin runs tests on Windows and OSX (some failures in the test - to be investigated)
- Windows provisioning somewhat blocked due to CI issues
- no progress on Linux
- OSX 10.8 ran tests with expected results
- OSX 10.9 has issues due to Pyside not supporting namespace builds of Qt
- clang
- preprocessor has remaining issue
-> with clang compiler but gcc seems OK
-> Qt Core wrapper close to compiling (QHash issues remaining)
- Smart pointer work continues
- some uses cases work, other use cases might remain
- [https://bugreports.qt.io/browse/PYSIDE-364 PYSIDE-364] was fixed (patch pending)
- General error review on bugreports.qt.io
- 50% done (prioritized bugs are handled/checked bugs - "done" bugs)
- ran address and leak sanitizer over Pyside which resulted in some worrying cases (need to be addressed going forward)

==== 22. February 2017 ====
- [https://bugreports.qt.io/browse/PYSIDE-462 PYSIDE-462] Improved solution approved
- [https://bugreports.qt.io/browse/PYSIDE-205 PYSIDE-205] Hard-to-detect memory leak plugged
- slow memory leak found in shiboken with thousands of false positives
- used differential analysis of valgrind output
- Clang: Fixed Preprocessor handling (set defines, include paths), got minimal binding tests to pass, now adapting MetaBuilder and PySide to what Clang finds when parsing Qt. Good news: Very little need to set Q_DOC or other magic defines
- Coin: Slow progress, currently struggling with provisioning
- extensive bug triaging ongoing in Pyside Jira project

==== 16. February 2017 ====
- Coin (no update - other priorities in release/CI team)
- Clang (progressing on pre-processor work)
- PYSIDE-315 closed
- PYSIDE-462 more review needed
- Shared pointer API very slowly progressing (lots of different fixes needed)
- QMimeDataBase support added
- QUrlQuery support blocked on QDOC defines in Qt sources (shiboken sets the wrong define)
- chasing memory leaks (PSYIDE-205)
- extensive bug triaging ongoing in Pyside Jira project
- confirming and testing the reported bugs (70 of 200 processed)
- some smaller bugs were fixed in the process
- quite a few bugs were discovered this week while working on the above items, e.g.:
- deployment of pyside applications partly broken due to hard-coded install paths in Qt libs
- Qt events are swallowed when Pyside error/exception occurs

==== 9. February 2017 ====
- Clang progressed
- pure C++ tests for API extractions are passing (C++ parsing based on clang)
- even works with cmake
- old C++ preprocessor still to be replaced
- working through old preprocessor and checking what magic it did and how clang might be able to replace it
- PYSIDE-315 & PYSIDE-462 fixes pending for review
- COIN
- continue progress an getting more platforms to pass (unblocking one step at a time)
- Windows (32bit) and mac are building, Win 64bit still not building
- OSX and Windows are stopping in the test runner phase
- missing cmake update still on Linux (provisioning update required)

==== 26 January 2017 ====
- PYSIDE-315
- principle fix merged but some minor improvements still pending
- Pyside-462
- essentially a feature request as C++ default parameters are not yet supported by Pyside
- discussion ongoing how to address the problem
- COIN
- 10.11, 10.9 & 10.8 build passes
- 10.10 still failing during build
- Progress on Windows and running into new problems further down the path
- Redhat failed to general brokenness of the platform in CI
- Ubuntu no further progress
- clang parser work progressing
- completeness of work is currently measured by passing unit tests
- there is a long way to go
- see [https://bugreports.qt.io/browse/PYSIDE-323 PYSIDE-323] and associated patches for progress monitoring
- Fixed regression which prevented Pyside to compile with Qt 5.5.1
- shared pointer support
- no update on 2nd February 2017 (next week)

==== 19 January 2017 ====
- PYSIDE-315
- a possible fix is pending, some minor performance improvements are still possible
- caused by different signal/slot ordering in Qt4 and Qt 5
- COIN
- issues on 10.8 and 10.9 platforms should pass now
- 10.11 & 10.10 still have issues
- Windows timeout problem fix in COIN (but no COIN update until 5.8.0 released)
- Linux builds are failing
- Ubuntu 14.04 fails due to cmake issue
- Redhat 6.6 & OpenSuse 13.01 deferred
- current COIN freeze for 5.8.0 release affecting patching of COIN for Pyside
- next steps in priority -> run tests on 10.8/10.9 and get Linux running
- PYSIDE-79 regression fixed as well (some interaction between PYSIDE-315 & PYSIDE-79)
- PYSIDE-462 to be looked at next
- clang parser work progressing

==== 12 January 2017 ====
- PYSIDE-315
- sorting of slots/signal connection changed on Qt side and Pyside side has not caught up
- had similar connection issues on the QML side, need to investigate whether there is a connection
- PYSIDE-79
- caused a regressions (not yet investigated)
- fixed OpenGL types not being recognized on MacOS (partly fixed)
- API's with shared/smart pointers in Qt don't work
- has potential long term effects and investigation has started into the reasons
- Refactoring shiboken in preparation for clang
- COIN currently runs tests with namespaced Qt
- short term fix to exclude namespaced Qt builds with Pyside (broken on MacOS 10.9)
- other failures: missing libraries on MacOS (10.11), missing provisioning on Windows, cmake issues on 10.10
- unknown state on Linux (current Redhat too old)
- Prioritization after status round:
- PYSIDE-315 to be investigated based on recent signal/slot patches for QML
- Smart pointer issues reduced in priority to provide space for PYSIDE-315 & PYSIDE-79 regression
- verify that COIN runs testrunner (not just building Pyside)
-> not yet verified since we are still failing builds in COIN

==== 5 January 2017 ====
- COIN update
- COIN changes merged (no further patches pending)
- need to run an integration test
- issues related to different build platforms still to be expected
- Continue with clang
- backtracking a bit (reusing some node API's during parsing but otherwise use clang to populate the tree)
- test blacklisting reviewed (some removed - mostly signal related ones, one new regression)
- regressions in QtQuick were worked around (caused by recent Qt Quick changes)
- issues with macos framework style includes in Qt
- PYSIDE-315 debugging ongoing, very hard to track down
- was it a regression from a previous Pyside release (e.g. Qt 5.4?!?
- hard-copied Qt 5.4 based headers still in existence
- updated needed but would shut Qt 5.4 users out
</div>

== 2016 ==
<div class="mw-collapsible mw-collapsed" style="overflow:auto;">

==== 22 December 2016 ====
- lots of discussions around the COIN patches
- source archive setup being under review
- Qt 5.6 provisioning patches merged
- CI uses Python 2.7 at this stage
- clang C++ parsing continues
- fix of some Pyside unit tests (now have a clean slate again)
- finished QtQuick port
- some overflow problems have been fixed in shiboken

==== 15 December 2016 ====
- COIN changes pending for testing infrastructure
-> https://codereview.qt-project.org/177136 (Pyside change)
-> https://codereview.qt-project.org/176968 (Coin change)
-> https://codereview.qt-project.org/179662 (Provisioning changes)
-> https://codereview.qt-project.org/179663 (Provisioning changes)
- waiting for COIN development team to review/accept the pending changes
- no update in PYSIDE-315 (under investigation)
- Flushed out a couple of shiboken, QML, qml example bugs
- Some bugs related to parser delayed until clang parser task done (https://bugreports.qt.io/browse/PYSIDE-322)
- most basic shiboken API extractor test to pass (global enumeration test)
- some trouble with int size data types
-> Python 2 & 3 are different and the relevant C++ data types are yet again different from platform to platform

==== 8 December 2016 ====
- COIN patches pending approval
- Windows provisioning reviewed
- Linux, Pyside, COIN itself
- Clang changes progressing, comparing AST tree from old parser and clang
- PYSIDE-79 done
- PYSIDE-315 under investigation
- QtQuick patches taking shape (some template magic and function pointer
features in Qt cannot be parsed by shiboken)

==== 1 December 2016 ====
- COIN
- PYSIDE-79 there seems to be a final work around (https://codereview.qt-project.org/#/c/176374/)
- fixing a few tests in the process
- clang update
- dumping AST, identifying the required info
- work in progress...
- problems with global static QObjects on the Qt side calling back into Python during app exit
- may require some changes on the Qt side

==== 24 November 2016 ====
- automatic COIN triggering for submodules work in progress
- several discussions on this topic this week
- Clang investigation (what library to use)
- fixing bugs on Qt side for Pyside
- Qt QML support almost done, work will continue with Qt Quick
- PYSIDE-79 work story continues
- reference counting not quite accurate but point of deallocation of ref count not identifiable

==== 17 November 2016 ====
- Pyside team suffering from sickness -> not much progress this week
- Pyside-79 fix had a lot of negative side effects (breaking existing tests)
- internal object reference counting is the predominant issue at hand
- continue to work on the bug (no resolution yet as delayed due to sickness)
- COIN some progress but still open discussions on branching policy required

==== 11 November 2016 ====
- PYSIDE-79 being fixed
- PYSIDE-315 to be addressed
- Shiboken and Clang
- familiarizing with clang and its parser's inner working
- added experimental qmake project definition for shiboken (makes work in Qt Creator easier)
- Qt QML on Pyside work progressing
- work on COIN did not progress due to conflicting priorities inside COIN development

==== 3 November 2016 ====
- working through the QML stack esnuring all required API's are exported (https://codereview.qt-project.org/#/c/175682/)
- small build system patches
- PYSIDE-79 work progressing
- OpenGL support fixed (PYSIDE-314)
- COIN issues
- repo interdepencies not working yet, suggestion under discussion and to be implemented
- most license checks have been fixed
- Qt 5.6 based Pyside to skip check
- after branching for C++11 work the dev branch should work from license check perspective
- eventually the entire CI needs to run through (more hidden problems could be hidden)
- Started working on C++11 compliant parser for shiboken
- libclang will be used
- first target is to replace the AST tree implementation
- requires clang setup in the CI

==== 27 October 2016 ====
- Work on WebKit/WebEngine support
- Further work on [https://bugreports.qt.io/browse/PYSIDE-431 COIN] support
- Planning meeting
- Workshop for C++11 support in Pyside ([https://bugreports.qt.io/browse/PYSIDE-323 PYSIDE-323])

==== 20 October 2016 ====
- [https://bugreports.qt.io/browse/PYSIDE-355 Qt Quick support] submitted
- [https://bugreports.qt.io/browse/PYSIDE-314 QtOpenGL support] submitted
- Further work on [https://bugreports.qt.io/browse/PYSIDE-431 COIN] support, license headers
==== 13 October 2016 ====
- Qt CI update
- Coin changes have merged but integration not yet working
- Qt CI enables on Pyside side merged
=> COIN integration fails with license issues
=> requires review of license conditions for all files, some files are not even relicensable
=> skipping license check for now, most likely to be done later again but requires changes to license check script
- more issues of interworking between QtCI and Pyside expected (won't be visible until license problems resolved)
Open issue: does a change in Pyside repo trigger a rebuild of everything?
- Qt QML support progressing and first patches merged
- serious bugs have been fixed, more complex QML examples are now working

==== 29 September 2016 ====
- Coin integration close but not merged
- Bugfixing in particular on the shiboken parser side
- QML/Python binding and tests fixed -> general check all day-to-day aspects of QML are working
- QML examples porting
-> still some failing tests
-> Check all QML/Quick class are exported

==== 22 September 2016 ====
- Refactored Shiboken, udnerstanding build sequences
- black list for unit tests defined and tested
- fixing of tests
- QML example fixing continued (QML bindings not working)
- Pyside side for COIN done (pending integration checks)
- COIN integration still wip due to long test and retest cycles
- pyside and shiboken repo to be relicensed similar to other Qt products
=> this should address any issues regarding the status of generated code too

==== 16 September 2016 ====
- Pyside side for CI testing ready for testing
- status of COIN side to be determined. Code exists need help from CI team to confirm status.
- build system infrastructure improvements in pyside setup
- Qt logging now working
- and more
- Update on bug handling
- PYSIDE-88 continuing
- PYSIDE-349 (Multimedia ported)
- PYSIDE-344 fix pending on codereview
- make debug builds of Pyside work (OSX works, Linux has work in progress patch, Windows side awaiting contribution)
- QML support work in progress
- examples are slowly ported with aim to identify bugs

==== 25 August 2016 ====
- Properly implementing QML experience in Pyside
- Unit test fixing
- automated CI testing for Pyside
- working locally but still failures occurring on various other test machines

==== 4 August 2016 ====
- Additional Pyside examples under review
- Fixed warnings coming from Shiboken

==== 21 July 2016 ====

- main Pyside 2 example port done
- additional examples to fill gaps are being ported (as per prio list)
- CI patches running, but still gaps (should be done by next week)
- about 86% of auto test working (failing count of test 80+ auto test)
- [[pyside-Teststatus|Project Test Status]]

==== 14 July 2016 ====

- Pyside 2 examples ported
- OpenGL & SVG not working
- QtQuick 2 is in strange situation (QtQml depends on QtQuick)
- Python 3 realed Unicode handling not working with Qt
- QMessageBox hangs
- no documentation for any example
- lots of warnings when building wrapper
- results: https://paste.kde.org/pgje2toyh/mlbqic
- COIN setup for pyside https://codereview.qt-project.org/#/c/158336/
- Qt 5.7 still blocked due to missing C++11 support in shiboken
- food for ideas: https://steveire.wordpress.com/

==== 7 July 2016 ====

- automated CI testing
- patches for Pyside and Qt CI side required
- Testing somewhat more complicated due to closed nature of Qt CI
- script to port examples to Qt 5 -> https://bugreports.qt.io/issues/?jql=labels%20%3D%20exampleport5
- all examples to remain BSD licensed
</div>

=== Backlog ===

The list below represents some short term targets and long term ideas for Pyside2 development. There is no guarantee that this will happen as written down. It is meant as a short reminder and idea collection for future development. In the long term this list is likely to move to https://bugreports.qt.io/browse/PYSIDE.

# First time with Pyside (Document how to get started on this wiki)
# Testing Infrastructure
## What has been done so far?
## Qt CI support ([https://bugreports.qt.io/browse/PYSIDE-431 PYSIDE-431])
### make test
### cmake based build system (all repos)
### pip installable Pyside
#### CI has to setup virtual Python environment
#### Use pip to install/build Pyside (release bundling)

# Future changes to PySide
## Gaps (modules & API)
### Identify the extent of the gaps by porting existing examples from Qt4 to Qt5 (done)
### Plugin system (in what form or shape do we need it is uncertain - some failing tests exist already)
### Prepare a summary of gaps for other modules
## Fundamental Architecture changes
### Shiboken
#### Clang support ([https://bugreports.qt.io/browse/PYSIDE-323 PYSIDE-323])
### QtQML support ([https://bugreports.qt.io/browse/PYSIDE-355 PYSIDE-355])
## MyPy (type annotation - fully typed Python API)
## General Python features and their adoption in PySide (e.g. Async I/O)
## Creator and tooling
### Fix QtC debugger to understand Python/C++ mixed internals
## Documentation generation
## Deployment of apps
## Debugging support

# Must have tasks for first release
## Packaging (e.g. pip deployment? )
## Clarify Installer story
## Documentation
## Product placement decisions
### Licensing
### Naming
### etc
## Complete CI coverage

Qt for Python DBusIntegration

2018-05-27T15:11:49Z

AutoSpider: Move Category:QtForPython -> Category:Qt for Python

[[Category:Qt for Python]]

To get PySide2 and DBus working together you can use the glib mainloop integration already done in [https://pypi.org/project/dbus-python/ dbus-python].

The examples below show how to export Qt objects to Python and emit a D-Bus signal when a Qt signal is emitted.
The code comments explain what you need to know about PySide2 and D-Bus.

Also refer to the [http://dbus.freedesktop.org/doc/dbus-python/doc/tutorial.html dbus-python tutorial].

== D-Bus Client ==

<syntaxhighlight lang="python" line='line'>
#!/usr/bin/env python
# -'''- coding: utf-8 -'''-

# DBUS Client using PySide2 integration

import sys
from traceback import print_exc

# import python dbus module
import dbus
# import python dbus GLib mainloop support
import dbus.mainloop.glib
# import QtCore
from PySide2.QtCore import *

# signal handler
def button_clicked():
print("button clicked")

# main function
if __name__ == '__main__':
# Enable glib main loop support
dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
# Get the session bus
bus = dbus.SessionBus()

try:
# Get the remote object
remote_object = bus.get_object("com.example.SampleService",
"/DBusWidget")
# Get the remote interface for the remote object
iface = dbus.Interface(remote_object, "com.example.SampleWidget")
except dbus.DBusException:
print_exc()
sys.exit(1)

# Start the application
app = QCoreApplication([])

# Call some methods of the remote interface
iface.show()
iface.setText("Emit signal")
# connect the DBus signal clicked to the function button_clicked
iface.connect_to_signal("clicked", button_clicked)
iface.connect_to_signal("lastWindowClosed", app.quit)

# enter in the main loop
app.exec_()

</syntaxhighlight>

=== D-Bus Server ===
<syntaxhighlight lang="python" line='line'>
#!/usr/bin/env python
#-'''- coding: utf-8 -'''-

# DBUS Server Example of use PySide2 with dbus-python library

import dbus
import dbus.service
import dbus.mainloop.glib
import random

from PySide2.QtCore import *
from PySide2.QtWidgets import QPushButton, QApplication

# The adaptor, MUST inherit dbus.service.Object
class DBusWidget(dbus.service.Object):
def __init__(self, name, session):
# export this object to dbus
dbus.service.Object.__init__(self, name, session)

# create a simple widget
self.widget = QPushButton()
self.widget.resize(200, 50)

# To export a Qt signal as a DBus-signal, you need to connect it to
# a method in this class.
# The method MUST have the signal annotation, so dbus-python will
# export it as a dbus-signal
QObject.connect(self.widget, SIGNAL ("clicked()"), self.clicked)
QObject.connect(QApplication.instance(), SIGNAL ("lastWindowClosed()"),
self.lastWindowClosed)

# You can export methods to dbus like you do in python-dbus.
@dbus.service.method("com.example.SampleWidget", in_signature='', out_signature='')
def show(self):
self.widget.show()

# Another method… now with a parameter
@dbus.service.method("com.example.SampleWidget", in_signature='s', out_signature='')
def setText(self, value):
self.widget.setText(value)

# Another one…
@dbus.service.method("com.example.SampleWidget", in_signature='', out_signature='')
def exit(self):
qApp().quit()

# A signal that will be exported to dbus
@dbus.service.signal("com.example.SampleWidget", signature='')
def clicked(self):
pass

# Another signal that will be exported to dbus
@dbus.service.signal("com.example.SampleWidget", signature='')
def lastWindowClosed(self):
pass

if __name__ == "__main__":
print("holi")
app = QApplication([])
# Use qt/glib mainloop integration to get dbus mainloop working
dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

session_bus = dbus.SessionBus()
print(session_bus)
# Export the service
name = dbus.service.BusName("com.example.SampleService", session_bus)
# Export the object
widget = DBusWidget(session_bus, '/DBusWidget')

print("Running
</syntaxhighlight>

=== Running the examples ===

Copy the client code to a file called example-client.py and the server to a file called example-server.py and type:

<code>
python example-server.py &
python example-client.py
</code>

A small window should appear on screen. Click on the button to emit a Qt signal. The signal will be converted to a D-Bus signal that will be caught by our D-Bus client.

Squish/Waiting for a Progress Bar

2017-11-25T08:48:03Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: waiting for a progress bar or a progress dialog]] if relevant}}
[[Category:Squish]]

= Waiting for a progress bar or progress dialog =

When you have a calculation or some other work item in your AUT that takes an arbitrary amount of time to complete, it can be hard to get your test script to be stable by just using snooze() or waitForObject() calls to wait for the work item to finish. Instead, you can use the more powerful waitFor() method, that takes any code statement, executes it until it returns True, or until the optional timeout is reached before it continues the script playback.

Assuming the work item shows a progress bar or a progress dialog while it is running, you can easily use waitFor() to make sure your script does not continue playback until the work item has completed and the progress dialog has gone away:

<code>clickButton(waitForObject(":Dialog.Calculate_QPushButton"))
waitFor("object.exists(':_QProgressDialog')", 20000)
waitFor("not object.exists(':_QProgressDialog')")</code>

Squish/Verifying the Existence of a Menu Item

2017-11-25T08:47:50Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: verifying the existence of a menu item]] if relevant}}
[[Category:Squish]]

= Verifying the existence of a menu item =

To verify the existence of a menu item within a menu, there are multiple approaches: 1) accessing the QAction list supplied to us by the QWidget class through the Qt API or 2) using Squish's real name to see if the object exists.

In the end, the usage of any of these approaches are as simple as:
<code>test.verify(menuItemExists("File", "&Save"))<code>

== Qt API approach ==

This approach uses the Qt API to access the menu and the menu's actions, and then iterate through all of the actions to see if it contains the one we are looking for.

</code>def menuItemExists(menu, menuItem):
menuName = "{title='s' type='QMenu' window=':Window'}" menu
waitFor("object.exists(menuName)", 20000)
actions = findObject(menuName).actions()
for i in range(actions.size()):
action = actions.at(i)
if action.text == menuItem:
return True
return False<code>

We start out by using the real name of the menu to identify it, as that gives us the ability to dynamically specify which menu Squish should be looking for. We then wait for it to exist, to make sure the script is not played back to fast, retrieve the QAction list from the menu and iterate through them, comparing the text property of QAction with the text we supply in the argument.

== Squish's real name approach ==

Similar to the approach above where we use the real name to get to the menu, we do the same thing but with the menu item instead.

</code>def menuItemExists(menu, menuItem):
menuName = "{title='s' type='QMenu' window=':Window'}" menu
menuItemName = "{container=%s text='s' type='QAction'}" (menuName, menuItem)
return object.exists(menuItemName)<code>

Squish/Using Ctrl+A

2017-11-25T08:46:42Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Using Ctrl+A =

The Ctrl+A keyboard shortcut is often the most effective way to select everything in a widget to perform some operation, be it to select everything in a list view to perform an operation or to select everything in a text box to type a replacement. In general, keyboard shortcuts can be an expedient way to test functionality. Here are a couple of examples for Ctrl+A:

== Setting a Text Box value
<code>#Incredibly straightforward, will work on anything with a text area that accepts standard keyboard shortcuts
def setTextBoxValue(boxName, value):
type(waitForObject(boxName), "<Ctrl+A>")
type(waitForObject(boxName), "value")</code> ==

== Selecting All Items in a List
<code>#Works with most QAbstractItemView types e.g. QListView
def selectAll(viewName):
#select the first item
model = waitForObject(viewName).view.model()
clickItem(viewName, model.data(model.index(0,0))) ==

Squish/nativeType Function

2017-11-25T08:46:22Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]
It can be the case that you need to type some text and be picked up by the application but which the receiver of the text is either unknown or very hard to predict. Think along the lines of an event filter being installed or if an object redirects events to its children.

It's in these situations that you should always recur to the function nativeType().

It works very similarly to type() however it doesn't take an object as its target, rather, it emulates the typing a user would do to the application. This allows it to be redirected through the same paths and be picked by the proper objects.

Squish/Keeping an Object Tree Tidy

2017-11-25T08:46:04Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]
= Keep a tidy object tree =
Always remember to keep your tree clean by removing old objects from it or adapting the object properties to match the new layout of the application. This will accomplish 2 things:
1)You keep a comprehensive relationship of the objects that do exist in your application rather than a tree with every object the application has ever seen.
2)You will fix your application much easily.

It can be the case that a particular object is particularly hard to predict, perhaps your application title changes with every revision of your application. If so, every build could, potentially, break your Q&A. Instead of trying to manually correct it or compute at run time, you should use the squish built in different modes to match properties. Remember that there exists a wildcard mode:

<code>{title?='SomeApp*' type='QMainWindow'}<code>

and a regular expression mode:

</code>{title~='SomeApp.*' type='QMainWindow'}</code>

This way you can avoid creating too many objects and keep your tree clean.

Squish/Interacting with Menus

2017-11-25T08:45:50Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Interacting with menus and menu items =

In [[:Category:Tools::Squish::Verifying_the_existence_of_a_menu_item | Verifying the existence of a menu item]], we saw how to access single menu items using Squish's real name approach. We can use this approach again, to implement support for dynamically interacting with menus and menu items. That is, we implement one single function for interacting with all menu items in the main window of the AUT, including menu items in sub-menus.

[[Image:http://www.kdab.com/~tobias/interacting-with-menus.png|Menu structure]]

Consider the menu structure above - if we simply record interaction with File -> New…, Edit-> Find -> Find…
and Edit-> Find -> Advanced-> Find & Replace…, we end up with code such as:
<code> # File -> New…
activateItem(waitForObjectItem(":MainWindow.menuBar_QMenuBar", "File"))
activateItem(waitForObjectItem(":MainWindow.File_QMenu", "New…"))

# Edit-> Find -> Find…
activateItem(waitForObjectItem(":MainWindow.menuBar_QMenuBar", "Edit"))
activateItem(waitForObjectItem(":MainWindow.Edit_QMenu", "Find"))
activateItem(waitForObjectItem(":Edit.Find_QMenu", "Find…"))

# Edit-> Find -> Advanced-> Find & Replace…
activateItem(waitForObjectItem(":MainWindow.menuBar_QMenuBar", "Edit"))
activateItem(waitForObjectItem(":MainWindow.Edit_QMenu", "Find"))
activateItem(waitForObjectItem(":Edit.Find_QMenu", "Advanced"))
activateItem(waitForObjectItem(":Find.Advanced_QMenu", "Find & Replace…"))</code>

This code requires the menu objects, including the sub-menus, to be added to the object map, which in turn requires us to always record when interacting with a menu or sub-menu that Squish does not yet know about. With the real name approach, we can get around this.

Adding support for any level of menu depth can be done by implementing a function that takes an arbitrary number of arguments, such as below:
<code>def activateMenuItem(*menuPath):
menu = ":MainWindow.menuBar_QMenuBar"
parent = "{name='MainWindow' type='MainWindow' visible='1' windowTitle='MainWindow'}"
for item in menuPath[:–1]:
activateItem(waitForObjectItem(menu, item))
menu = "{title='%s' type='QMenu' visible='1' window=s}" (item, parent)
parent = menu
activateItem(waitForObjectItem(menu, menuPath[–1]))</code>

The code above only requires one object to be in the object map, and that is the menu bar. Of course, that can also be changed into a real name instead, if necessary.

Usage would simply be:
<code> activateMenuItem("File", "New…")
activateMenuItem("Edit", "Find", "Find…")
activateMenuItem("Edit", "Find", "Advanced", "Find & Replace…")</code>

Squish/Working with Long Test Cases

2017-11-25T08:45:07Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: Working with long test cases]] if relevant}}
This page in: [[:Category:Tools::Squish::Working with long test cases Spanish|Español]]

[[Category:Squish]]

= Working with long test cases =

In the situation where you have very long test cases covering e.g. a specific workflow in your application, recording everything in one go could be troublesome as you normally are aiming for refactoring the recorded code into reusable functions. Trying to find specific actions among 500 lines of generated code is bound to be error-prone.

One way of working around this problem is to have the application running in the background, record separate pieces of the workflow and refactor each piece after recording it.

The way this is done is initially starting your application from Squish by clicking the ''Launch AUT'' button in the toolbar. Now, whenever you want to record something, you right-click in the test script where you want the recorded script to end up, and select ''Record snippet'' from the context menu. This will bring you into the application in recording mode.

When you are done recording, DO NOT shut down the application, but click ''Stop recording'' in the control bar instead. This will bring you back to the IDE so you can refactor the recorded code. When you are done refactoring, you can right-click and select ''Record snippet'' again to start recording more interactions.

Squish/Hooking into Subprocesses

2017-11-25T08:44:54Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

Sometimes when writing Squish tests the application being tested launches a subprocess. In this short tip we'll see how to robustly connect to an externally launched subprocess on Windows.

As the froglogic Squish manual (section 17.7.1) explains, hooking into an AUT's subprocess when on windows is slightly more complex, as Squish is not able to use LD_PRELOAD (or DYLD_INSERT_LIBRARIES on OS X) to insert the squish library hook into the launching executable. Two options to get around this are clear—the AUT sourcecode can be modified to optionally insert "dllpreload.exe" into the subprocess launch (as the squish manual explains), or the AUT can be modified to call an external shell script that does the optional prepending of 'dllpreload.exe'.

In any case, once the AUT has been modified to properly launch the subprocess, the squish test still needs to attach to the launching subprocess. If the AUT uses QProcess to launch the subprocess, it is enough to do:

<code> subprocess = waitForApplicationLaunch()</code>
However, if the squish IDE is set up to attach to the AUT manually, the desired call would be:

<code> subprocess = attachToApplication( "APPNAME" )</code>
However, the attachToApplication() call will throw an exception if the subprocess is not ready. So, a more robust way to give the subprocess time to launch properly is to try again in a loop for a predetermined amount of time:

<code> subprocess = 0
count = 0
while True:
if count > 30:
raise RuntimeError( "Attaching to AUT subprocess failed!" )
try:
subprocess = attachToApplication("APPNAME")
break
except:
snooze(1)
count += 1</code>

Squish/Using Custom Properties

2017-11-25T08:44:13Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Using Squish and custom properties =

To fully test your application, there might be situations where you need to modify the application source code to add properties to specific widgets that can be tested from Squish. There are essentially two ways of doing this:

== 1) Use the Q_PROPERTY macro ==

If you have access to the source code for the widget you want to change, you can simply use the Q_PROPERTY macro to add a property to the widget:
<code>class MyWidget : public QWidget
{
Q_OBJECT
Q_PROPERTY(QString nameOfProperty READ getValue)

public:
…
QString getValue() const { return m_memberVar; }
…
private:
QString m_memberVar;
}</code>

This property will then be accessible in Squish using the Squish Spy just like any other widget property, and turned into a verification point simply by recording:

<code>waitFor("object.exists(':NameOfObject')", 20000)
object = findObject(":NameOfObject")
value = object.nameOfProperty
test.compare(value, "Expected value")</code>

== 2) Use dynamic properties ==

In the case where you do not have access to the source code for the widget, but instead only to the application using it, you cannot use the Q_PROPERTY approach as described above, but will need to use dynamic properties instead. This is essentially using the QObject::setProperty() function in the application source code to set the value of the property on the widget. This function takes two parameters, the name of the property (which you will later use from Squish) and the value to set:

<code>myWidget->setProperty("nameOfProperty", "Expected value")<code>

The dynamic properties are however not seen automatically by Squish, so you cannot access them in the Squish Spy. Instead, we need to call the QObject::property() function to get the value. This is nothing different from calling other Qt functions from your Squish scripts:

</code>waitFor("object.exists(':NameOfObject')", 20000)
object = findObject(":NameOfObject")
value = object.property("nameOfProperty").toString()
test.compare(value, "Expected value")<code>

Squish/Generating Test Data

2017-11-25T08:44:00Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Generating test data =

In the cases where you are testing an application that works with files, be it a file transfer application, editor or your own checksum calculator, you might benefit from testing it with different file types and/or file sizes. This article will show you how to generate these test files on-the-fly, so you will not have to keep them around in your revision control system where they simply take up space.

Normally, when you work with test data in Squish, you will import some file using the IDE, which will copy that file into your suite_testsuite/tst_case/testdata or suite_testsuite/shared/testdata folder. You will then get it to your application using testData.put(). The beauty of testData.put() is that it also works across the network, if you are testing your application on e.g. an embedded system and have the squishrunner running on your local desktop machine.

However, we can accomplish that even with generated files, without importing them using the IDE, and without copying them to the test system using testData.put(). This is because of Squish's built-in Qt bindings. As shown in various Squish articles in this wiki ([[:Category:Tools::Squish::Verifying_the_existence_of_a_menu_item | here]], [[:Category:Tools::Squish::Iterating_through_a_table | here]] and [[:Robust_selection_of_listview_or_treeview_items_with_variable_text | here]]) you can use the Qt classes and functions from within your test script, and we will use this support for generating the test files on the system where the AUT is being executed.

The script can look something like this:
<code>def createTestData(fileName, size):
file = QFile("s/%s" (currentApplicationContext().cwd, fileName))
if file.open(QIODevice.WriteOnly):
mb = 1024*1024
if size > mb:
mbData = QString()
mbData.fill('a', mb)
count = size / mb
i = 0
while i < count:
file.write(mbData)
i = i + 1
rest = size % mb
mbData.fill('a', rest)
file.write(mbData)
else:
data = QString()
data.fill('a', size)
file.write(data)
file.close()</code>

Usage would be:
<code>createTestData("test.txt", 543872)<code>

This script simply generates a file with a specified file size and a specified file name, puts the file into the current working directory of the AUT, and fills it with the character "a". As you can see from the function, it writes the data one megabyte at the time. This is to avoid allocating the full file size of data at once, hence getting the AUT to possibly consume a lot of the machines memory resources.

The working directory where the files are put can be customized in the Test Suite Settings in the IDE, by simply changing the working directory of the AUT.

Of course, this is only one way to actually generate the data. If you need more sophisticated data, or actually some proper content, you will of course have to modify this function. When doing so, just make sure to use the Qt API for creating the files and writing the data, as using Python's ditto will be executed in the context of the squishrunner (i.e. on your desktop machine), while using the Qt API it will be executed in the context of the AUT (i.e. the embedded device).

Squish/Waiting for Input from the Test Operator

2017-11-25T08:43:24Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: waiting for input from the test operator]] if relevant}}
[[Category:Squish]]

= Waiting for input from the test operator =

In the cases where Squish cannot automate the whole test case, such as when a coin needs to be inserted into a slot machine or a physical button needs to be pressed which Squish cannot simulate, you need some way of notifying the test operator. As we have access to the whole Qt API from Squish, this can easily be done with a QMessageBox:
<code>QMessageBox.information(0, "Input needed", "Please insert coin now!")<code>

As the call to information() won't return until the user clicks the OK button, the script will be paused until that happens.

We can also use Squish's powerful waitFor() command to continue the script immediately when the required action has occurred, without the user having to click a button, which can be useful in situations where an input cursor is not available for the test operator:
</code>label = QLabel("Please insert coin now!")
label.show()
waitFor("findObject(':CoinCounter_QLabel').text == '1'")
label.close()<code>

Squish/Robust Selection of View Items with Variable Text

2017-11-25T08:43:12Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

This article is similiar to to [[Finding list items that ends in a given string]] however goes into a bit more detail and is also functional for treeviews as well as listviews. Dealing with a treeview requires careful handling of "."-separated paths.

Imagine you need to select some item in a treeview, but you don't know the exact string of the item as it may have changed. Alternatively maybe the parent item of the item you wish to select has changed, but the item is still the same. You need to find the item you want in the tree, and extract the correct Squish item identifier to interact with it later on.

For example, assume you need to find a certain file in treeview, but the treeview has items with absolute paths that might be different on various machines. All you know is that the filename you are looking for will be the same, if it exists. You wish to iterate through the treeview, checking each level against some known valid path that you have. For this example, we will assume you have paths such as

<code>server1\serverpath\some\path\test_data\test_project\filetest.db
server32\serverpath\some\path\test_data\test_project\filetest.db
C:_mirror\some\path\test_data\test_project\filetest.db</code>

and you can't be sure which path is in the treeview (potentially as a parent or child item). This means you might need to convert

<code>server1serverpathsomepathtestdatatestprojectfiletestb.subtem.subSubItem</code>

to

<code>C:localmirrorsomepathtestdatatestprojectfiletestb.subtem.subSubItem</code>

(Note that these paths are escaped so that Squish's itemview functions properly find the paths). As you can see, all three of the paths are the same from the "test_data" folder onwards, so we will use that to split between the "known good" parts of the path we wish to match, and the variable part we wish to replace.

<code>def findRealPath( treeviewname, origpath ):
import re

print "Original path: ", origpath
treeView = waitForObject( treeviewname )
model = treeView.model()

# we are looking for this
originalParts = origpath.split( "testdata" )
pathOnly = originalParts[1]
# Remove the items separated by "." (but not . which is an escaped dot in the folder path)
print "Now splitting items: s" re.split( "[<sup>].", pathOnly, 1 )
pieces = re.split( "[</sup>].", pathOnly, 1 ) # only split once
pathOnly = pieces[ 0 ]
childrenItems = ""
if len( pieces ) > 1: # If this has children
childrenItems = pieces[ 1 ]
toplevel = model.rowCount( QModelIndex() )
for row in range( toplevel ): # iterate through tree, looking for matching file
# shortcut solution: check all top-level items in their first three columns. much more efficient if result is top-level
for col in range( 3 ): # check first few columns
idx = model.index( row, col, QModelIndex() )
if checkModelItemReplacement(idx, pathOnly):
return replaceModelIndex(utils.escape(str( idx.data( Qt.DisplayRole ).toString() )), childrenItems)

# didn't find what we were looking for in the top level, do a search two more levels down
# check all our children as well
for col in range(20):
idx = model.index( row, col, QModelIndex() )
childCount = model.rowCount(idx)
print "Checking children of item %s, found s" (idx.data(Qt.DisplayRole).toString(), childCount)
for childRow in range(childCount):
child = model.index( 0, 0, idx )
print "checking child %s: s" (childRow, child.data(Qt.DisplayRole).toString())
if checkModelItemReplacement(child, pathOnly):
# we need to do the replacement differently, because we need to keep the parent in the path
partpieces = re.split( "([<sup>]).", origpath )
# find the index that has the test_data/ path. all indexes before that are parents
for i in range(len(partpieces)):
if "testdata" in partpieces[i]: # stop here
# since we split on [</sup>]. and captured the split text, we need to condense each pair of items
num = i/2
parentItems = []
for k in range(num):
parentItems.append( partpieces[k] + partpieces[k+1] ) # rescue the char lost when splitting
parentstr = ".".join(parentItems)
return replaceModelIndex(utils.escape(str( child.data( Qt.DisplayRole ).toString() )), childrenItems, parentstr)

# we failed
print "Failed to replace: s" origpath
return origpath

# used internally by above
def checkModelItemReplacement( idx, pathOnly ):
contents = utils.escape(str( idx.data( Qt.DisplayRole ).toString() ))
print "Checking for %s in s" (pathOnly, contents)
if pathOnly in contents: # this is the entry we are looking for
return True
else:
return False

# used internally by above
def replaceModelIndex( contents, children, parents = "" ):
print "Replacing with %s and %s with parent? s" (contents, children, parents)
replaced = contents

if children [[Image:= "":
replaced += "." + children
print "added children to replaced: %s" % replaced
if parents |]]= "":
replaced = parents + "." + replaced
print "added parents to replaced: s" replaced
return replaced</code>

As is visible in the above code sample, this code only searches three-levels-deep for a match. If your tree is deeper than 3 levels, you'll need to either add another level of drilling down, or convert it into recursive function that works on any arbitrary level. The above code can be used like so:

<code>treeViewName = ":Your_treeview_here"
itemPath = "server1serverpathsomepathtestdatatestprojectfiletestb.subtem.subSubItem"
realItemPath = findRealPath( treeViewName, itemPath )</code>

Squish/Finding List Items that End in a Given String/es

2017-11-25T08:42:54Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: finding list items that end in a given string/es]] if relevant}}
This page in: [[:Category:Tools::Squish::Finding list items that ends in a given string|English]]

[[Category:Squish]]
[[Category:Spanish]]

= Buscando elementos de una lista que terminan en una cadena dada =

Como Squish utiliza el texto completo del artículo para la identificación de los elementos de un list view, esto podría causar problemas cuando el comienzo del texto del elemento es diferente en función de por ejemplo la máquina que está ejecutando el caso de la prueba.

Una solución a esto podría ser buscar los items que terminan con una cadena dada, para evitar incluir la cadena con el prefijo cambiado. Esto se puede hacer usando la función que se muestra debajo, la misma hace click en un elemento que termina en una cadena dada en una columna especifica:

<code>def clickListItem(obj, endValue, column):
model = waitForObject(obj).model()
rows = model.rowCount()

for i in range(rows):
itemString=str(model.data(model.index(i, column), Qt.DisplayRole).toString())

if itemString.endswith(endValue):
waitForObjectItem(obj, itemString)
clickItem(obj, itemString, 0, 0, 0, Qt.LeftButton)
return

test.fatal("Could not find item with end value: " + endValue)</code>

Para seleccionar un item que termine con el string "value1" en una list view especifica, usamos:
<code>clickListItem(":MyQListView", "value1", 0)<code>

Squish/Verifying the Value of a QLabel

2017-11-25T08:41:41Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: verifying the value of a QLabel]] if relevant}}
This page in: [[:Category:Tools::Squish::VerifyingTheValueOfAQLabelSpanish|Español]]

[[Category:Squish]]

= Verifying the value of a QLabel =

In some applications you might show dynamic data in QLabel and you want the value of this QLabel to be verified during playback. The problem however is that Squish uses the text property of QLabel to identify the QLabel object, which works just fine as long as the value is the expected value. But as soon as the value of the QLabel changes, Squish won't be able to find your QLabel and instead of a verification failure at playback you have a playback error due to a missing object.

This problem can be solved by not using the text property for identification of that QLabel. This is done by opening the Object Map, selecting the affected QLabel and remove the text property in the list of properties being shown. This will however only solve the problem for this specific label. If you have several more labels being affected by this, it might be a better idea to add a permanent solution, to avoid doing this manual work for every label.

This is done by adding a file called qtwrapper_user_descriptors.xml to your ~/.squish folder (APPDATAon Windows) with the following content:
<code><objectdescriptors>
<descriptor>
<type name="QLabel"/>
<realidentifiers>
<property exclude="yes">text</property>
</realidentifiers>
</descriptor>
</objectdescriptors></code>

Squish/Load Testing

2017-11-25T08:41:23Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Load testing with Squish =

Let's assume you have an application that communicates with a separate server, let it be a web server, a Jabber server or a custom developed server only for your application. Using Squish, you can load test this server with your application as the entry point. This is done by running Squish multiple times in parallel on multiple instances of your application working against the same server.

To accomplish the load testing, you need two different scripts: the actual test script that will run on each application instance and a launch script that will start off the requested number of Squish instances.

== 1) The test script ==

The content of the test script is of course very dependent of the application you are testing, but one general concept is that you put the interactions in a loop doing a pre-defined number of iterations. For the sake of this example, we will use the fortune client and threaded fortune server available in your Qt installation. The test will simply be repetetive clicking of the "Get Fortune" button, verifying that the fortune text is updated within a specific period of time, in the below case 20 milliseconds. The script assumes the fortune server is already running.

<code>def main():
startApplication("fortuneclient")
type(waitForObject(":Server port:_QLineEdit"), "41868")

labelName = "{type='QLabel' unnamed='1' visible='1' window=':Fortune Client_Client' occurrence='3'}"
waitFor("object.exists(labelName)", 20000)
label = findObject(labelName)

prevText = label.text

for i in range(100):
clickButton(waitForObject(":Fortune Client.Get Fortune_QPushButton"))

time = QTime()
time.start()
waitFor("label.text != prevText")
elapsed = time.elapsed()
test.verify(elapsed < 20)

prevText = label.text

clickButton(waitForObject(":Fortune Client.Quit_QPushButton"))</code>

== 2) The launch script ==

This script can be written in any scripting language of your choice. The main purpose of it though is to launch ONE Squish server and an arbitrary number of Squish runners all running the script above. The script below does that, in Python, launching 50 Squish runners.

<code>#!/usr/bin/env python

import subprocess

SQUISHDIR="/path/to/squish-4.1.0-qt-src"
TESTSUITEDIR="/path/to/suite_loadTesting"
TESTCASE="tst_case1"

subprocess.Popen(["s/bin/squishserver" SQUISHDIR, "—daemon"])

for i in range(50):
subprocess.Popen(["s/bin/squishrunner" SQUISHDIR, "—testsuite", TESTSUITEDIR, "—testcase", TESTCASE])</code>

== Discussion ==

One problem with the above approach is that the test script will launch immediately when the Squish runner is launched, which is normally what you want. However, this means some of the application instances are finished by the time other start. This can be worked around by having the test script wait for a specific file to exist before entering the loop, and having the launch script create this file after all Squish runners has started. That way, the actual load testing won't start until all the clients are ready.

You may also want to introduce random snoozing between each iteration in the test script, to even out the load on the client machine and also making the load on the server machine more "human".

If you want to run more application instances than what is feasable on a single host, using Squish's remote testing you can execute multiple application instances on multiple different hosts. This of course still means running the Squish runners on one machine, but at least you reduce the load introduced by the application you are testing. An alternative of course is to execute the Squish runners remotely over e.g. SSH on multiple machines to spread the load even more.

Technically, you could be using multiple Squish servers (e.g. one per application instance), but as a single server is handling multiple Squish runners quite well, there is really no need for it, and it will actually increase system load on the client machine.

Squish/Finding List Items that End in a Given String

2017-11-25T08:41:10Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: finding list items that end in a given string]] if relevant}}
This page in: [[:Category:Tools::Squish::FindingListItemsThatEndsInAGivenStringSpanish|Español]]

[[Category:Squish]]

= Finding list items that ends in a given string =

As Squish uses the full item text for identifying items in a list view, this could cause problems when
the beginning of the item text is different based on e.g. which machine you are running the test case.

One solution to this could be to look for items ending with a given string, to avoid including
the changing string prefix. This can be done with the utility function below, which clicks an item
that ends in a given string in a given column:

<code>def clickListItem(obj, endValue, column):
model = waitForObject(obj).model()
rows = model.rowCount()

for i in range(rows):
itemString=str(model.data(model.index(i, column), Qt.DisplayRole).toString())

if itemString.endswith(endValue):
waitForObjectItem(obj, itemString)
clickItem(obj, itemString, 0, 0, 0, Qt.LeftButton)
return

test.fatal("Could not find item with end value: " + endValue)</code>

Selecting an item that ends in the string "value1" in a specific list view is then done by doing:
<code>clickListItem(":MyQListView", "value1", 0)<code>

Squish/Verifying the Value of a QLabel/es

2017-11-25T08:38:32Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: Verifying The Value of a QLabel/es]] if relevant}}
This page in: [[:Category:Tools::Squish::Verifying the value of a QLabel|English]]

[[Category:Squish]]
[[Category:Spanish]]

= Verificando el valor de una QLabel =

En algunas aplicaciones necesitaras mostrar datos dinámicos en un QLabel y verificar el valor de este QLabel durante la reproducción. El problema sin embargo es que Squish utiliza la propiedad text de QLabel para identificar el objeto QLabel, esto funciona muy bien siempre y cuando el valor sea el valor esperado. Pero tan pronto como el valor de el QLabel cambia, Squish no será capaz de encontrar al QLabel y en lugar de mostrar un error de verificación durante la reproducción obtendrá un error de reproducción debido a un objeto perdido.

Este problema puede ser resuelto no usando la propiedad de texto para la identificación de el QLabel. Esto se hace abriendo el Mapa de Objetos, seleccionando el QLabel afectado y quitando la propiedad texto en la lista de propiedades que se muestran. Esto sin embargo, sólo resuelve el problema para esta label específica. Si usted tiene varias labels afectados por esto, podría ser una mejor idea agregar una solución permanente, para evitar hacer este trabajo manualmente para cada label.

Esto se hace mediante la adición de un archivo llamado qtwrapper_user_descriptors.xml a nuestrar carpeta ~/.squish (APPDATAen Windows) con el siguiente contenido:
<code><objectdescriptors>
<descriptor>
<type name="QLabel"/>
<realidentifiers>
<property exclude="yes">text</property>
</realidentifiers>
</descriptor>
</objectdescriptors></code>

Squish/Using a Decorator to Profile Tests

2017-11-25T08:38:14Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

== Use a decorator to profile tests ==

If your Squish tests are very intensive, or you have hundreds of them, you can run them trough a profiler from time to time. This will enable you to see where you're spending most of your time and will help optimize your efforts.

In order to do this you will need to run your main function through the python profiling package cProfile. For example:

<code>def main():
pass

import cProfile
profile = cProfile.Profile()
profile.runcall(main)
</code>

Depending on your particular configuration, the previous code might lead you to run the test twice. To avoid the repetition, wrap your main function with a decorator instead:

<code>import decorator

</code>decorator.profile
def main():
pass

#in the decorator file
def profile(func):
def inner():
import cProfile
p = cProfile.Profile()
p.runcall(func)
#do something to report the result

return inner
<code>

Squish/Iterating Through a Table/es

2017-11-25T08:38:02Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: iterating through a table/es]] if relevant}}
This page in: [[:Category:Tools::Squish::Iterating through a table|English]]

[[Category:Squish]]
[[Category:Spanish]]

= Iterando a través de una tabla =

Hay varias formas de recorrer una tabla con script de test para utilizarlo cuando se necesita verificar o tomar una decisión sobre un determinado conjunto de filas o columnas. En los siguientes ejemplos vamos a utilizar los tres métodos para verificar que no hay celdas vacías en una tabla.

Al final, el uso de cualquiera de estos tres enfoques sería simplemente:
<code>verifyNoEmptyCells(":MyQTableWidget")<code>

== Usando la API de Qt ==

Este acercamiento usa la API de Qt para acceder al modelo directamente e iterar entre las filas y las columnas de la tabla.

</code>def verifyNoEmptyCells(tableName):
table = waitForObject(tableName)
model = table.model()
columnCount = model.columnCount()
rowCount = model.rowCount()

for col in range(columnCount):
for row in range(rowCount):
itemText = str(model.data(model.index(row, col), Qt.DisplayRole).toString())
test.verify(itemText != "")<code>

== Usando waitForObjectItem() ==

Usando waitForObjectItem() se puede acceder a items de un widget especifico, tales como las acciones en un menú o en este caso, las celdas de una tabla. Se necesitan dos parámetros, el primero es el nombre del objeto primario y el segundo es la identificación del elemento. Para las celdas de una tabla, que es de dos números enteros en forma de fila / columna.

</code>def verifyNoEmptyCells(tableName):
table = waitForObject(tableName)
columnCount = table.columnCount
rowCount = table.rowCount

for col in range(columnCount):
for row in range(rowCount):
item = waitForObjectItem(tableName, str(row)+"/"''str(col))
test.verify(item.text != "")<code>

== Usando nombres reales ==
Squish ofrece dos formas de identificar los objetos en un script de tests, ya sea usando el nombre simbólico que se asigna a una entrada en el mapa del objetos, o usar el nombre real que muestra todas las propiedades y su valor esperado en una cadena de identificación. Detrás de escena, el nombre simbólico se mapea al nombre real, usando el nombre simbólico generalmente hace que el script sea más legible.

Al utilizar el nombre real para identificar las celdas, podemos cambiar los valores esperados de las propiedades y por lo tanto el acceso a las diferentes celdas de la tabla como se ve a continuación.

</code>def verifyNoEmptyCells(tableName):
waitFor("object.exists(tableName)")
columnCount = findObject(tableName).columnCount
rowCount = findObject(tableName).rowCount

for col in range(columnCount):
for row in range(rowCount):
item = waitForObject("{column='"'' str(col) + "' container='" + tableName + "' row='" + str(row) + "' type='QModelIndex'}")
test.verify(item.text != "")<code>

Squish/Enumerating all Objects Matching a Pattern

2017-11-25T08:37:35Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

== Enumerating all objects matching a pattern ==

When using Squish's pattern lookup functionality, it is often useful to perform an operation on all occurrences of an object matching a Squish pattern. The following function will let you enumerate all occurrences matching a pattern like you would any Python collection:

This function will yield all of the objects matching the specified pattern, by occurrence unless an alternative field to enumerate is provided with '%i' as its value.
<code>def enumerateObjects(pattern):
#allow %i to be specified manually, e.g. to check rows in a model one could do
#enumerateObjects("{column='0' container=':containerObject' row='%i' type='QModelIndex'}")
if '%i' not in pattern:
if not pattern.endswith('}'): #invalid pattern
raise RuntimeError("Pattern 's' is invalid!" pattern)
pattern = pattern[:–1] + " occurrence='i'}"
i = 1
while True:
try:
#return objects until a LookupError occurs
yield findObject(pattern i)
except:
return
i += 1
</code>

As a usage example, to log the contents of all '''QLabel''' widgets with parent :foo, you would do:
<code>for label in enumerateObjects("{type='QLabel' parent=':foo'}"):
test.log(str(label.text()))

Squish/Working with Long Test Cases/es

2017-11-25T08:35:50Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: Working with long test cases/es]] if relevant}}
This page in: [[:Category:Tools::Squish::Working with long test cases|English]]

[[Category:Squish]]
[[Category:Spanish]]

= Trabajando con grandes casos de pruebas =

In the situation where you have very long test cases covering e.g. a specific workflow in your application, recording everything in one go could be troublesome as you normally are aiming for refactoring the recorded code into reusable functions. Trying to find specific actions among 500 lines of generated code is bound to be error-prone.

En la situación en la que se tienen casos de prueba muy grandes, que abarcan por ejemplo un flujo de trabajo específico en su aplicación, grabarlo todo de una vez podría ser un problema, es recomendable refactorizar en el código grabado en funciones reutilizables. Tratar de encontrar acciones específicas entre 500 líneas de código generado está destinado a ser un proceso propenso a errores.

Una forma de solucionar este problema es tener la aplicación en segundo plano, grabando las piezas del flujo de trabajo por separado y refactorizando cada pieza después de la grabación.

La manera de hacer esto es iniciar su aplicación desde Squish haciendo clic en el botón ''Launch AUT'' en la barra de herramientas. Ahora cada vez que desee grabar algo, pulsa el con el botón derecho en el script del test, seleccione ''Record snippet'' en el menu contextual. Esto le llevará a la aplicación en modo de grabación.

Cuando haya terminado de grabar, NO cierre la aplicación, sino que haga clic en ''Stop recording'' en la barra de control. Esto le llevará de nuevo al IDE para que pueda refactorizar el código grabado. Cuando haya terminado la refactorización, puede hacer click derecho y seleccionar ''Record snippet'' de nuevo para iniciar la grabación de mas interaciones.

Squish/Using Helper Objects

2017-11-25T08:34:04Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Using Helper Objects =

When writing a Squish test, it is often helpful to provide a helper object in your application code to provide information your test can't easily access. A helper object, in this context, is a QObject that provides methods useful to Squish tests that is instantiated in the application for Squish to find. A helper object may be a good fit if you're trying to verify application state that can't easily be checked using native Qt and Squish functions.

As a contrived example, it might be useful to provide a helper object to get the color of a model rendered in a QGLWidget instead of trying to use a screenshot verification. Ideally a helper object's methods should ''not'' have side effects, as an ideal Squish test should only be testing what a user can do with normal input.

== An Example C++ Helper Object ==

The following class definition provides the method '''SquishHelper::help''', which Squish can invoke and get an integer result from. Note that '''SquishHelper::help''' is flagged as '''Q_INVOKABLE''', this is important! A method used by Squish must be accessible via Qt's metaobject system, which means methods that are either slots or '''Q_INVOKABLE'''.

<code>#include <QObject>

class SquishHelper : public QObject
{
public:
SquishHelper(QObject* parent);
~SquishHelper();

Q_INVOKABLE int help() const; //only offer a non-const method if you have a good reason
};</code>

After defining the class, merely instantiate it somewhere and optionally give it a name if there may be multiple instances. Make sure that the QObject parent of the helper object is a GUI element Squish shows in its object tree for the application, such as the main window. This ensures that Squish can successfully look up the object later.
<code>…
SquishHelper* helper = new SquishHelper(this);
helper->setName("Helper1");
…</code>

== Using a Helper Object From Squish ==

With the above helper object, looking up and invoking methods on the object is trivial. For instance, to look up the object and check the result of help in Python, you could do:
<code>…
helper = findObject("{name='Helper1' type='SquishHelper'}")
test.compare(helper.help(), 0)
…</code>

Squish/Navigating a QDateEdit

2017-11-25T08:33:51Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Navigating a QDateEdit =

Interacting with a QDateEdit from a Squish script is a bit more involved than just clicking a button or writing some text into a line edit, especially if you want a nice scripting API for it as well. Below is a script function that you can cut-and-paste into your existing test case or shared script, and use without modifications. It requires you to have recorded one interaction with a QDateEdit though, to have the proper names in the object map.

Usage would be:
<code>setDate(":nameOfQDateEdit", "2011", "April", "1")<code>

</code>def setDate(dateedit, year, month, day):
waitFor("object.exists(dateedit)", 20000)

dateExpandX = findObject(dateedit).width - 10
sendEvent("QMouseEvent", waitForObject(dateedit), QEvent.MouseButtonPress, dateExpandX, 15, Qt.LeftButton, 0)
sendEvent("QMouseEvent", waitForObject(dateedit), QEvent.MouseButtonRelease, dateExpandX, 15, Qt.LeftButton, 0)

yearToolButtonName = "{name='qt_calendar_yearbutton' type='QToolButton' visible='1' window=':qt_datetimedit_calendar_QCalendarPopup'}"
clickButton(waitForObject(yearToolButtonName))

yearEditSpinBoxName = "{name='qt_calendar_yearedit' type='QSpinBox' visible='1' window=':qt_datetimedit_calendar_QCalendarPopup'}"
type(waitForObject(yearEditSpinBoxName), year)
type(waitForObject(yearEditSpinBoxName), "<Return>")

monthToolButtonName = "{name='qt_calendar_monthbutton' type='QToolButton' visible='1' window=':qt_datetimedit_calendar_QCalendarPopup'}"
clickButton(waitForObject(monthToolButtonName))

monthMenuName = "{type='QMenu' unnamed='1' visible='1' window=':qt_datetimedit_calendar_QCalendarPopup'}"
activateItem(waitForObjectItem(monthMenuName, month))

calendarViewName = "{name='qt_calendar_calendarview' type='QCalendarView' visible='1' window=':qt_datetimedit_calendar_QCalendarPopup'}"
waitFor("object.exists(calendarViewName)", 20000)
model = findObject(calendarViewName).model()
seenOne = False
for row in range(1, model.rowCount() - 1): # First row contains day names, let's skip it
for col in range(model.columnCount()):
dayText = model.data(model.index(row, col)).toString()

if dayText == "1": # Some dates from last month may be seen, so make sure we've iterated
seenOne = True # past them before we actually click an item

if seenOne and dayText == day:
waitForObjectItem(calendarViewName, "s/%s" (row, col))
clickItem(calendarViewName, "s/%s" (row, col), 14, 11, 0, Qt.LeftButton)

Squish/Iterating Through a Table

2017-11-25T08:33:33Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: iterating through a table]] if relevant}}
This page in: [[:Category:Tools::Squish::IteratingThroughATableSpanish|Español]]

[[Category:Squish]]

= Iterating through a table =

There are several ways to iterate through a table in your test script to be used when you need to verify or take action on a given set of rows or columns. In the examples below we will use all three approaches to verify that there are no empty cells in a table.

In the end, the usage of any of these three approaches would simply be:
<code>verifyNoEmptyCells(":MyQTableWidget")<code>

== Qt API approach ==

This approach uses the Qt API to access the model directly and iterate through the rows and columns of the table.

</code>def verifyNoEmptyCells(tableName):
table = waitForObject(tableName)
model = table.model()
columnCount = model.columnCount()
rowCount = model.rowCount()

for col in range(columnCount):
for row in range(rowCount):
itemText = str(model.data(model.index(row, col), Qt.DisplayRole).toString())
test.verify(itemText != "")<code>

== waitForObjectItem() ==

Using waitForObjectItem() you can access items of a specific widget, such as actions in a menu or, in this case, cells in a table. It takes two parameters, the first being the name of the parent object and the second being the identification for the item. For cells in a table, that is two integers in the form of row/col.

</code>def verifyNoEmptyCells(tableName):
table = waitForObject(tableName)
columnCount = table.columnCount
rowCount = table.rowCount

for col in range(columnCount):
for row in range(rowCount):
item = waitForObjectItem(tableName, str(row)+"/"''str(col))
test.verify(item.text != "")<code>

== Real name approach ==
Squish offers two ways of identifying your objects in a test script, either using the symbolic name which maps to an entry in the object map, or using the real name which lists all properties and their expected value in an identification string. Behind the scenes, the symbolic name of course maps to this real name, using the symbolic name generally makes the scripts more readable though.

By using the real name to identify cells, we can change the expected values of the properties and hence access different table cells as seen below.

</code>def verifyNoEmptyCells(tableName):
waitFor("object.exists(tableName)")
columnCount = findObject(tableName).columnCount
rowCount = findObject(tableName).rowCount

for col in range(columnCount):
for row in range(rowCount):
item = waitForObject("{column='"'' str(col) + "' container='" + tableName + "' row='" + str(row) + "' type='QModelIndex'}")
test.verify(item.text != "")<code>

Squish/Custom Settings for Test Runs/es

2017-11-25T08:33:20Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: custom settings for test runs/es]] if relevant}}
This page in: [[:Category:Tools::Squish::Custom_settings_for_test_runs|English]] '''Español''' [[:Category:Tools::Squish::CustomSettingsForTestRuns_Italian|Italian]]

[[Category:Squish]]
[[Category:Spanish]]

= Configuración personalizada para pruebas =

En ciertos casos de prueba, podría ser necesario utilizar una configuración personalizada para la aplicación, diferente de otros casos de prueba. Un ejemplo de esto podría ser una aplicación que muestra una guía de introducción la primera vez que se inicia, para configurar algunos parámetros básicos. Esta sólo funciona la primera vez, sin embargo los ajustes son almacenados cuando el caso de prueba ha terminado, preferentemente utilizando QSettings.

Pero ya que podemos acceder a toda la API de Qt desde Squish, hay una manera fácil de evitar este problema! Para el caso de esta prueba específica, simplemente modificamos los QSettings del objeto de la aplicación. O más concretamente, cambiamos la ruta de acceso donde se almacenan los ajustes a un directorio temporal que sera eliminado al final de la secuencia de comandos de la prueba.

<code>tempDir = "/tmp/test-settings"
QSettings.setPath(QSettings.NativeFormat, QSettings.UserScope, tempDir)</code>

Squish/Custom Settings for Test Runs

2017-11-25T08:30:35Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: custom settings for test runs]] if relevant}}
This page in: [[:Category:Tools::Squish::CustomSettingsForTestRunsSpanish|Español]] [[:Category:Tools::Squish::CustomSettingsForTestRuns_Italian|Italian]]

[[Category:Squish]]

= Custom settings for test runs =

In certain test cases, it might be necessary to use custom settings for the application compared to other test cases. This could for example include an application that shows an introductory guide the very first time it is started, to set up some basic settings. This would only work the first time though, as the settings are stored when the test case is finished, preferrably using QSettings.

But since we can access all of the Qt API from Squish, there is an easy way around this problem! For the specific test case, simply modify the QSettings object for the application. Or more specifically, change the path to where the settings are stored to a temporary directory that you are removing at the end of the test script.

<code>tempDir = "/tmp/test-settings"
QSettings.setPath(QSettings.NativeFormat, QSettings.UserScope, tempDir)</code>

Keep in mind that this call will not modify existing QSettings objects in the application, so this will need to be done before any of those are created.

Squish/Clicking a QLabel Link

2017-11-25T08:26:00Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Clicking link in label =

As is commonly known, you can put in hyper text links in a regular QLabel in Qt, by using simple HTML syntax. Then of course, you want to be able to click this link in your Squish tests. However, Squish does not have a clickLink() function, as it does for e.g. clickButton() or clickTab(), so what happens during recording is that you will get code similar to:
<code>mouseClick(waitForObject(":MyQLabel"), 31, 14, 0, Qt.LeftButton)<code>

That is, hard coded coordinates for where the link is. So if the position of the link would change for whatever reason (different platform, new text added, different font) the test will break.

In Squish 4.1, a new function named installSignalHandler() was added. This lets your test script react to signals emitted from the application code. We can use this function combined with the fact that a signal is emitted from a QLabel whenever a link is hovered. This will let us implement a function for clicking arbitrary links in a label.

</code>_lookingFor = None
_found = False

def handleLinkHovered(obj, link):
global _found
if link == _lookingFor:
_found = True

def findLink(objectName, link):
global _lookingFor
global _found
_lookingFor = link
_found = False

object = waitForObject(objectName)

installSignalHandler(object, "linkHovered(QString)", "handleLinkHovered")

width = object.width
height = object.height
y = 0
while y < height:
x = 0
while x < width:
sendEvent("QMouseEvent", object, QEvent.MouseMove, x, y, Qt.NoButton, 0)
if _found:
return (x,y)
x ''= 5
y''= 10

return (–1,–1)

def clickLink(objectName, link):
(x, y) = findLink(objectName, link)
if x [[Image:= -1 and y |= -1 and y ]]= 1:
mouseClick(objectName, x, y, 0, Qt.LeftButton)<code>

Usage is simply:
</code>clickLink(":MyQLabel", "some-action")</code>

Squish/Calculating Checksums

2017-11-25T08:20:20Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

[[Category:Squish]]

= Calculating checksums =

When you are testing e.g. a file transfer client, and you want to make sure the file transferred is the same on both the sender and the receiver side, one easy way of doing this is using checksums. And luckily for us, Python comes with a hashlib module, with support for exactly that! Problem? The Python code in your test script is being executed in the context of the squishrunner, which is a problem if your application (and hence your files) are being executed on another machine, e.g. an embedded system.

But as mentioned in the article on [[:Category:Tools::Squish::Generating test data | generating test data]], Squish gives us access to most of the Qt API using the built-in Qt wrapper library. And whatever Qt code we put into our test script will be executed in the context of the AUT, even when the AUT is being executed on an embedded system. So combining the fact that the Qt code is being executed on the AUT side along with Python's hashlib module, we can generate checksums!

<code>import hashlib
def calculateMd5(fileName):
m = hashlib.md5()
file = QFile("s/%s" (currentApplicationContext().cwd, fileName))
if file.open(QIODevice.ReadOnly):
mb = 1024*1024
while not file.atEnd():
data = file.read(mb)
m.update(str(data))
file.close()
return m.hexdigest()</code>

Usage:
<code>sum = calculateMd5("test.txt")<code>

Squish/Best Practices/es

2017-11-25T08:16:29Z

AutoSpider: Move :Category::Tools::Squish -> :Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: recommended way of working/es]] if relevant}}
This page in: [[:Category:Tools::Squish::RecommendedWayOfWorking|English]]

[[Category:Squish]]
[[Category:Spanish]]

= La forma recomendada de trabajar con Squish =

Imagine que ha estado utilizando Squish por un tiempo, grabando y reproduciendo casos de prueba con ninguna o sólo pequeñas modificaciones en los scripts de tests. Ha acumulado a una cantidad significativa de casos de prueba y la mayoría de ellos comienzan con la realización de la misma secuencia de pasos, por ejemplo, acceder a un servidor remoto mediante la especificación de un nombre de usuario y una contraseña para luego hacer click en el botón OK en un cuadro de diálogo.

El código luciría mas o menos como lo siguiente:
<code>def main():
type(":Username_QLineEdit", "user")
type(":Password_QLineEdit", "mypassword")
clickButton(":OK_QPushButton")</code>

Ahora imagine que por alguna razón, un desarrollador va y cambia su aplicación para no utilizar una caja de textos en el campo de entrada del nombre de usuario, sino que en su lugar utiliza un QComboBox. Ahora tendrá que volver a grabar manualmente o como mínimo cambiar cada caso de prueba que interactue con este cuadro de diálogo de inicio de sesión.

En lugar de crear casos de prueba usando sólo la función de grabación, que con el tiempo daría lugar a problemas como el descrito anteriormente, la manera recomendada de trabajar con Squish es grabar y refactorizar. Es decir, grabar un caso de prueba o una pieza de un caso de prueba y refactorizar en una o varias funciones que luego pueden ser llamadas por el script del test.

En el siguiente ejemplo, se crea un función login(), después de haber registrado el primer caso de prueba que consiste en acceder a un servidor. Entonces, para todos los casos de prueba subsiguientes, solo es necesario llamar a la función login() desde el script del test.

<code>def login(username, password):
type(":Username_QLineEdit", username)
type(":Password_QLineEdit", password)
clickButton(":OK_QPushButton")

def main():
login("user", "mypassword")</code>

Como un efecto secundario de la creación de este método, podemos parametrizar la llamada a la función, para que pueda probar el cuadro de diálogo de inicio de sesión con diferentes valores con sólo llamar con diferentes parámetro a login().

Squish/Best Practices

2017-11-25T08:13:41Z

AutoSpider: Move Category::Tools::Squish -> Category::Squish

{{Delete|reason=Page not category. Include as single block in [[Squish: recommended way of working]] if relevant}}
[[Category:Squish]]

= The recommended way of working with Squish =

Imagine you have been using Squish out-of-the-box for a while, recording and replaying test
cases with none or only minor manual modifications to the test scripts. You have reached a significant
amount of test cases, and most of them start with doing the same sequence of steps, e.g. logging in to
a remote server by specifying a user name and a password and then clicking OK in a dialog.

The code for this could look something like below:
<code>def main():
type(":Username_QLineEdit", "user")
type(":Password_QLineEdit", "mypassword")
clickButton(":OK_QPushButton")</code>

Now imagine, for some reason, a developer goes and changes your application to not use a line edit as the
user name input field, but a QComboBox instead. Now you will need to go and manually re-record or at least
change every single test case interacting with this login dialog.

Instead of creating test cases by simply recording them, as that would eventually lead to the problem above, the
recommended way of working with Squish is to record and refactor. That is, you record a test case, or a piece
of a test case, and refactor that into one or several functions that you then call from your test script.

In the example above, you would create a login() function after you have recorded the first test case that
involves logging in to a server. Then for all subsequent test cases, you call this login() function from
your test script. In code, this would be:

<code>def login(username, password):
type(":Username_QLineEdit", username)
type(":Password_QLineEdit", password)
clickButton(":OK_QPushButton")

def main():
login("user", "mypassword")</code>

And as a side-effect of us creating this method, we also parameterized the function call, so you can test
the login dialog with different values by just adding additional calls to login().

If the same change to the application as above would now be made by a developer, you would not need to change hundreds of test

Robust selection of listview or treeview items with variable text

2017-11-25T07:53:43Z

AutoSpider: AutoSpider moved page Robust selection of listview or treeview items with variable text to Squish/Robust Selection of View Items with Variable Text: Move under the "Squish" banner; shorten titles

#REDIRECT [[Squish/Robust Selection of View Items with Variable Text]]

Squish/Robust Selection of View Items with Variable Text

2017-11-25T07:53:43Z

[[Category:Tools::Squish]]

This article is similiar to to [[Finding list items that ends in a given string]] however goes into a bit more detail and is also functional for treeviews as well as listviews. Dealing with a treeview requires careful handling of "."-separated paths.

Imagine you need to select some item in a treeview, but you don't know the exact string of the item as it may have changed. Alternatively maybe the parent item of the item you wish to select has changed, but the item is still the same. You need to find the item you want in the tree, and extract the correct Squish item identifier to interact with it later on.

For example, assume you need to find a certain file in treeview, but the treeview has items with absolute paths that might be different on various machines. All you know is that the filename you are looking for will be the same, if it exists. You wish to iterate through the treeview, checking each level against some known valid path that you have. For this example, we will assume you have paths such as

<code>server1\serverpath\some\path\test_data\test_project\filetest.db
server32\serverpath\some\path\test_data\test_project\filetest.db
C:_mirror\some\path\test_data\test_project\filetest.db</code>

and you can't be sure which path is in the treeview (potentially as a parent or child item). This means you might need to convert

<code>server1serverpathsomepathtestdatatestprojectfiletestb.subtem.subSubItem</code>

to

<code>C:localmirrorsomepathtestdatatestprojectfiletestb.subtem.subSubItem</code>

(Note that these paths are escaped so that Squish's itemview functions properly find the paths). As you can see, all three of the paths are the same from the "test_data" folder onwards, so we will use that to split between the "known good" parts of the path we wish to match, and the variable part we wish to replace.

<code>def findRealPath( treeviewname, origpath ):
import re

print "Original path: ", origpath
treeView = waitForObject( treeviewname )
model = treeView.model()

# we are looking for this
originalParts = origpath.split( "testdata" )
pathOnly = originalParts[1]
# Remove the items separated by "." (but not . which is an escaped dot in the folder path)
print "Now splitting items: s" re.split( "[<sup>].", pathOnly, 1 )
pieces = re.split( "[</sup>].", pathOnly, 1 ) # only split once
pathOnly = pieces[ 0 ]
childrenItems = ""
if len( pieces ) > 1: # If this has children
childrenItems = pieces[ 1 ]
toplevel = model.rowCount( QModelIndex() )
for row in range( toplevel ): # iterate through tree, looking for matching file
# shortcut solution: check all top-level items in their first three columns. much more efficient if result is top-level
for col in range( 3 ): # check first few columns
idx = model.index( row, col, QModelIndex() )
if checkModelItemReplacement(idx, pathOnly):
return replaceModelIndex(utils.escape(str( idx.data( Qt.DisplayRole ).toString() )), childrenItems)

# didn't find what we were looking for in the top level, do a search two more levels down
# check all our children as well
for col in range(20):
idx = model.index( row, col, QModelIndex() )
childCount = model.rowCount(idx)
print "Checking children of item %s, found s" (idx.data(Qt.DisplayRole).toString(), childCount)
for childRow in range(childCount):
child = model.index( 0, 0, idx )
print "checking child %s: s" (childRow, child.data(Qt.DisplayRole).toString())
if checkModelItemReplacement(child, pathOnly):
# we need to do the replacement differently, because we need to keep the parent in the path
partpieces = re.split( "([<sup>]).", origpath )
# find the index that has the test_data/ path. all indexes before that are parents
for i in range(len(partpieces)):
if "testdata" in partpieces[i]: # stop here
# since we split on [</sup>]. and captured the split text, we need to condense each pair of items
num = i/2
parentItems = []
for k in range(num):
parentItems.append( partpieces[k] + partpieces[k+1] ) # rescue the char lost when splitting
parentstr = ".".join(parentItems)
return replaceModelIndex(utils.escape(str( child.data( Qt.DisplayRole ).toString() )), childrenItems, parentstr)

# we failed
print "Failed to replace: s" origpath
return origpath

# used internally by above
def checkModelItemReplacement( idx, pathOnly ):
contents = utils.escape(str( idx.data( Qt.DisplayRole ).toString() ))
print "Checking for %s in s" (pathOnly, contents)
if pathOnly in contents: # this is the entry we are looking for
return True
else:
return False

# used internally by above
def replaceModelIndex( contents, children, parents = "" ):
print "Replacing with %s and %s with parent? s" (contents, children, parents)
replaced = contents

if children [[Image:= "":
replaced += "." + children
print "added children to replaced: %s" % replaced
if parents |]]= "":
replaced = parents + "." + replaced
print "added parents to replaced: s" replaced
return replaced</code>

As is visible in the above code sample, this code only searches three-levels-deep for a match. If your tree is deeper than 3 levels, you'll need to either add another level of drilling down, or convert it into recursive function that works on any arbitrary level. The above code can be used like so:

<code>treeViewName = ":Your_treeview_here"
itemPath = "server1serverpathsomepathtestdatatestprojectfiletestb.subtem.subSubItem"
realItemPath = findRealPath( treeViewName, itemPath )</code>

Hooking into slow-launching subprocesses on Windows

2017-11-25T07:53:42Z

AutoSpider: AutoSpider moved page Hooking into slow-launching subprocesses on Windows to Squish/Hooking into Subprocesses: Move under the "Squish" banner; shorten titles

#REDIRECT [[Squish/Hooking into Subprocesses]]

Squish/Hooking into Subprocesses

2017-11-25T07:53:42Z

AutoSpider: AutoSpider moved page Hooking into slow-launching subprocesses on Windows to Squish/Hooking into Subprocesses: Move under the "Squish" banner; shorten titles

[[Category:Tools::Squish]]

Sometimes when writing Squish tests the application being tested launches a subprocess. In this short tip we'll see how to robustly connect to an externally launched subprocess on Windows.

As the froglogic Squish manual (section 17.7.1) explains, hooking into an AUT's subprocess when on windows is slightly more complex, as Squish is not able to use LD_PRELOAD (or DYLD_INSERT_LIBRARIES on OS X) to insert the squish library hook into the launching executable. Two options to get around this are clear—the AUT sourcecode can be modified to optionally insert "dllpreload.exe" into the subprocess launch (as the squish manual explains), or the AUT can be modified to call an external shell script that does the optional prepending of 'dllpreload.exe'.

In any case, once the AUT has been modified to properly launch the subprocess, the squish test still needs to attach to the launching subprocess. If the AUT uses QProcess to launch the subprocess, it is enough to do:

<code> subprocess = waitForApplicationLaunch()</code>
However, if the squish IDE is set up to attach to the AUT manually, the desired call would be:

<code> subprocess = attachToApplication( "APPNAME" )</code>
However, the attachToApplication() call will throw an exception if the subprocess is not ready. So, a more robust way to give the subprocess time to launch properly is to try again in a loop for a predetermined amount of time:

<code> subprocess = 0
count = 0
while True:
if count > 30:
raise RuntimeError( "Attaching to AUT subprocess failed!" )
try:
subprocess = attachToApplication("APPNAME")
break
except:
snooze(1)
count += 1</code>

Category:Tools::SquishSpanish::RecommendedWayOfWorkingSpanish

2017-11-25T02:56:47Z

AutoSpider: AutoSpider moved page Category:Tools::SquishSpanish::RecommendedWayOfWorkingSpanish to Squish/Best Practices/es: Title name format

#REDIRECT [[Squish/Best Practices/es]]

Squish/Best Practices/es

2017-11-25T02:56:47Z

AutoSpider: AutoSpider moved page Category:Tools::SquishSpanish::RecommendedWayOfWorkingSpanish to Squish/Best Practices/es: Title name format

{{Delete|reason=Page not category. Include as single block in [[Squish: recommended way of working/es]] if relevant}}
This page in: [[:Category:Tools::Squish::RecommendedWayOfWorking|English]]

[[Category:Tools::Squish]]
[[Category:Spanish]]

= La forma recomendada de trabajar con Squish =

Imagine que ha estado utilizando Squish por un tiempo, grabando y reproduciendo casos de prueba con ninguna o sólo pequeñas modificaciones en los scripts de tests. Ha acumulado a una cantidad significativa de casos de prueba y la mayoría de ellos comienzan con la realización de la misma secuencia de pasos, por ejemplo, acceder a un servidor remoto mediante la especificación de un nombre de usuario y una contraseña para luego hacer click en el botón OK en un cuadro de diálogo.

El código luciría mas o menos como lo siguiente:
<code>def main():
type(":Username_QLineEdit", "user")
type(":Password_QLineEdit", "mypassword")
clickButton(":OK_QPushButton")</code>

Ahora imagine que por alguna razón, un desarrollador va y cambia su aplicación para no utilizar una caja de textos en el campo de entrada del nombre de usuario, sino que en su lugar utiliza un QComboBox. Ahora tendrá que volver a grabar manualmente o como mínimo cambiar cada caso de prueba que interactue con este cuadro de diálogo de inicio de sesión.

En lugar de crear casos de prueba usando sólo la función de grabación, que con el tiempo daría lugar a problemas como el descrito anteriormente, la manera recomendada de trabajar con Squish es grabar y refactorizar. Es decir, grabar un caso de prueba o una pieza de un caso de prueba y refactorizar en una o varias funciones que luego pueden ser llamadas por el script del test.

En el siguiente ejemplo, se crea un función login(), después de haber registrado el primer caso de prueba que consiste en acceder a un servidor. Entonces, para todos los casos de prueba subsiguientes, solo es necesario llamar a la función login() desde el script del test.

<code>def login(username, password):
type(":Username_QLineEdit", username)
type(":Password_QLineEdit", password)
clickButton(":OK_QPushButton")

def main():
login("user", "mypassword")</code>

Como un efecto secundario de la creación de este método, podemos parametrizar la llamada a la función, para que pueda probar el cuadro de diálogo de inicio de sesión con diferentes valores con sólo llamar con diferentes parámetro a login().