Qt for Python/GettingStarted/Windows: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Adding building from source)
No edit summary
 
(36 intermediate revisions by 7 users not shown)
Line 1: Line 1:
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. 
[[Category:Qt for Python]]  
                                                                                   
==== Requirements ====                                                             
* Qt package from https://www.qt.io or a custom build of Qt (preferably '''Qt 5.9''')
* Python from https://www.python.org/downloads/ ('''Python 3.6''' or '''Python 2.7''')
* [http://landinghub.visualstudio.com/visual-cpp-build-tools MSVC2015] (for Python 3 on Windows), MSCVC2008 (for Python 2 on Windows)       
* CMake from https://cmake.org/download/ ('''>= 3.1''')                             
* libclang (required for the 5.9 and dev branches) from [http://download.qt.io/development_releases/prebuilt/libclang/ download.qt.io] ('''>= 3.9''')                                                       
* virtualenv (optional but recommended)                                               
* Python sphinx package for documentation (optional, pip install sphinx)               


=== Building from sources on Windows 10 ===
== Official documentation ==


The following steps are performed on the command prompt (''cmd'').
Refer to the [https://doc.qt.io/qtforpython/gettingstarted-windows.html official documentation] to get started on Windows.
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.


==== Setting up CLANG ====
== 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. The only exception are MSVC2015 & MSVC2017 as those compilers produce compatible binaries.
** 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 (or MSVC2017 due to the aforementioned compatibility).
** 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'''.


* Download [http://download.qt.io/development_releases/prebuilt/libclang/ libclang], e.g.
== Development ==                                                                                                                                                          
[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]
Development happens in the 5.12 and dev branches of the [http://code.qt.io/cgit/pyside/pyside-setup.git/ pyside-setup repository].                                                                                
* Extract the files, e.g. using [http://www.7-zip.org/ 7zip]                       
* Move the directory ''libclang'' to any desire path, e.g ''c:\'', and then set an environment variable with the new path:
set LLVM_INSTALL_DIR=c:\libclang                                             
                                                                                   
==== Getting PySide2 ====                                                 
* You must [https://git-scm.com/download/win download git] in order to clone the repository.
* Clonning the official repository
git clone --recursive https://codereview.qt-project.org/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  --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 --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:                                   
The top level repository has the following submodules:                                   
* sources/pyside2-tools: uic, rcc tools   
* sources/pyside2-tools: uic, rcc tools   
* examples/                                             
* sources/pyside2-examples (5.6 only, examples are no longer a submodule in 5.9+)                                                                                                                                 
                                                                                       
Contributions follow the [[Qt_Project_Guidelines|standard process]].                                                                                                
Contributions follow the [[Qt_Project_Guidelines|standard process]].                
                                                                                       
It is helpful to have debug binaries and/or symbols for Python available.               
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.
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.                                                                                
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:
On Windows an installation step may be required:
  python -m pip install virtualenv                                                       
  python -m pip install virtualenv                                                       
  python -m virtualenv testenv                                                          
  python -m virtualenv testenv                                                                                                                                          
                                                                                       
The Virtual Environment is activated by·                                                 
The Virtual Environment is activated by·                                                 
  CALL testenv\Scripts\activate.bat                                                                                                                                                                                                          
  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:·
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
  pip install sphinx
Other useful modules are
pip install numpy PyOpenGL

Latest revision as of 10:54, 2 January 2020


Official documentation

Refer to the official documentation to get started on Windows.

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. The only exception are MSVC2015 & MSVC2017 as those compilers produce compatible binaries.
    • In practice this means that if you use the official Python 3.x package from [1] which is built with MSVC 2015, you need to use a Qt package built with MSVC 2015 (or MSVC2017 due to the aforementioned compatibility).
    • 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.12 and dev branches of the 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 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 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 Sphinx should be installed into the virtual environment:· 

pip install sphinx

Other useful modules are 

pip install numpy PyOpenGL
Retrieved from "https://wiki.qt.io/index.php?title=Qt_for_Python/GettingStarted/Windows&oldid=36631"