← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-qt4/trusty

« back to all changes in this revision

Viewing changes to doc/html/_sources/build_system.txt

  • Committer: Package Import Robot
  • Author(s): Dmitry Shachnev
  • Date: 2013-11-13 14:02:27 UTC
  • mfrom: (1.5.18) (50.1.23 sid)
  • Revision ID: package-import@ubuntu.com-20131113140227-jgpyxhgh4pc5j1s4
Tags: 4.10.3+dfsg-1
http://bugs.debian.org/723039
* Update pyrcc4 man page to list -py2 and -py3 options.
* Regenerate resource files during build.
* Repack orig tarball to remove non-free Sphinx-generated HTML
  documentation and non-free JS files (closes: #723039).
* Add debian/get-orig-source.sh script.
* Update debian/watch to mangle dfsg version.
* Drop debian/python-qt4-doc.docs, we install docs directly.
* Pass --debug to configure-ng.py when doing debug builds.
* Add a patch (phonon_cfgtest.diff) to fix detection of new Phonon
  versions.
* Add a patch (config_flags.diff) to apply build flags to designer
  module.
* Remove duplicate references to GPL license file from debian/copyright.
* Add myself to Uploaders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/_sources/build_system.txt
1
 
.. _ref-build-system:
2
 
 
3
 
The PyQt4 Build System
4
 
======================
5
 
 
6
 
.. versionadded:: 4.10
7
 
 
8
 
SIP v5 will not include an extensible build system, i.e it will not provide an
9
 
equivalent of SIP v4's :mod:`sipconfig` module.  Consequently a version of PyQt
10
 
built with SIP v5 will not provide an equivalent of the
11
 
:mod:`~PyQt4.pyqtconfig` module.  However there is still a need for certain
12
 
information to be shared between PyQt and other modules (such as QScintilla's
13
 
:mod:`~PyQt4.Qsci` module) that are built on top of it.  Specifically it is
14
 
important that the same ``-t`` and ``-x`` command line flags are passed to the
15
 
``sip`` executable to create, for example, the QScintilla bindings as were
16
 
passed to create the PyQt bindings.
17
 
 
18
 
Starting with v4.10, :attr:`PyQt4.QtCore.PYQT_CONFIGURATION` is a dict that
19
 
describes how PyQt was configured.  At the moment it contains a single value
20
 
called ``sip_flags`` which is a string containing the appropriate ``-t`` and
21
 
``-x`` flags.
22
 
 
23
 
 
24
 
The Old Build System
25
 
--------------------
26
 
 
27
 
.. deprecated:: 4.10
28
 
 
29
 
The old PyQt4 build system is an extension of the SIP v4 build system and is
30
 
implemented by the :mod:`~PyQt4.pyqtconfig` module.  It can be used by
31
 
configuration scripts of other bindings that build on top of PyQt4 and takes
32
 
care of the details of the Qt installation.
33
 
 
34
 
Note that the :mod:`~PyQt4.pyqtconfig` module is only created if you use
35
 
:program:`configure.py` and not if you use :program:`configure-ng.py`.
36
 
 
37
 
.. module:: PyQt4.pyqtconfig
38
 
 
39
 
.. class:: Configuration(sub_cfg=None)
40
 
 
41
 
    This class encapsulates configuration values that can be accessed as
42
 
    instance objects.  It is derived from :class:`sipconfig.Configuration`.
43
 
 
44
 
    :param sub_cfg:
45
 
        an optional list of sub-class configurations.  It should only be used
46
 
        by the ``__init__()`` method of a sub-class to append its own
47
 
        dictionary of configuration values before passing the list to its
48
 
        super-class.
49
 
 
50
 
    .. attribute:: pyqt_bin_dir
51
 
 
52
 
        The name of the directory where the PyQt4 utilities are installed.
53
 
 
54
 
    .. attribute:: pyqt_config_args
55
 
 
56
 
        The command line passed to :program:`configure.py` when PyQt4 was
57
 
        configured.
58
 
 
59
 
    .. attribute:: pyqt_mod_dir
60
 
 
61
 
        The name of the directory where the :mod:`PyQt4` Python package is
62
 
        installed.
63
 
 
64
 
    .. attribute:: pyqt_modules
65
 
 
66
 
        A space separated string of installed PyQt4 modules.  The :mod:`Qt`
67
 
        module is not included.
68
 
 
69
 
    .. attribute:: pyqt_sip_dir
70
 
 
71
 
        The name of the base directory where PyQt4's ``.sip`` files are
72
 
        installed.  Each module's ``.sip`` files are installed in a
73
 
        sub-directory with the same name as the module.
74
 
 
75
 
    .. attribute:: pyqt_sip_flags
76
 
 
77
 
        A space separated string of the :program:`sip` command line options
78
 
        used to build the PyQt4 modules.  These should also be used when
79
 
        building bindings that ``%Import`` any PyQt4 modules.
80
 
 
81
 
    .. attribute:: pyqt_version
82
 
 
83
 
        The PyQt4 version as a 3 part hexadecimal number (e.g. v4.0.1 is
84
 
        represented as ``0x040001``).
85
 
 
86
 
    .. attribute:: pyqt_version_str
87
 
 
88
 
        The PyQt4 version as a string.  For development snapshots it will start
89
 
        with ``snapshot-``.
90
 
 
91
 
    .. attribute:: qt_data_dir
92
 
 
93
 
        The value of ``QLibraryInfo::location(DataPath)`` for the Qt
94
 
        installation.
95
 
 
96
 
    .. attribute:: qt_archdata_dir
97
 
 
98
 
        When building against Qt v5 this is the value of
99
 
        ``QLibraryInfo::location(ArchDataPath)``.  When building against Qt v4
100
 
        it is the value of ``QLibraryInfo::location(DataPath)``.
101
 
 
102
 
    .. attribute:: qt_dir
103
 
 
104
 
        The root directory of the Qt installation (normally the directory that
105
 
        contains the :file:`bin` directory).
106
 
 
107
 
    .. attribute:: qt_edition
108
 
 
109
 
        The Qt edition.
110
 
 
111
 
    .. attribute:: qt_framework
112
 
 
113
 
        Set if Qt is built as a MacOS/X framework.
114
 
 
115
 
    .. attribute:: qt_inc_dir
116
 
 
117
 
        The value of ``QLibraryInfo::location(HeadersPath)`` for the Qt
118
 
        installation.
119
 
 
120
 
    .. attribute:: qt_lib_dir
121
 
 
122
 
        The value of ``QLibraryInfo::location(LibrariesPath)`` for the Qt
123
 
        installation.
124
 
 
125
 
    .. attribute:: qt_threaded
126
 
 
127
 
        Set if Qt is built with thread support (always set for PyQt4).
128
 
 
129
 
    .. attribute:: qt_version
130
 
 
131
 
        The Qt version as a 3 part hexadecimal number (e.g. v4.1.2 is
132
 
        represented as ``0x040102``).
133
 
 
134
 
    .. attribute:: qt_winconfig
135
 
 
136
 
        Additional Windows specific configuration.
137
 
 
138
 
 
139
 
.. class:: QtAssistantModuleMakefile
140
 
 
141
 
    This class encapsulates a Makefile to build a SIP generated Python
142
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtAssistant`
143
 
    module.
144
 
 
145
 
 
146
 
.. class:: QAxContainerModuleMakefile
147
 
 
148
 
    This class encapsulates a Makefile to build a SIP generated Python
149
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QAxContainer`
150
 
    module.
151
 
 
152
 
 
153
 
.. class:: QtCoreModuleMakefile
154
 
 
155
 
    This class encapsulates a Makefile to build a SIP generated Python
156
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtCore` module.
157
 
 
158
 
 
159
 
.. class:: QtDBusModuleMakefile
160
 
 
161
 
    This class encapsulates a Makefile to build a SIP generated Python
162
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtDBus` module.
163
 
 
164
 
 
165
 
.. class:: QtDeclarativeModuleMakefile
166
 
 
167
 
    This class encapsulates a Makefile to build a SIP generated Python
168
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtDeclarative`
169
 
    module.
170
 
 
171
 
 
172
 
.. class:: QtDesignerModuleMakefile
173
 
 
174
 
    This class encapsulates a Makefile to build a SIP generated Python
175
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtDesigner`
176
 
    module.
177
 
 
178
 
 
179
 
.. class:: QtGuiModuleMakefile
180
 
 
181
 
    This class encapsulates a Makefile to build a SIP generated Python
182
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtGui` module.
183
 
 
184
 
 
185
 
.. class:: QtHelpModuleMakefile
186
 
 
187
 
    This class encapsulates a Makefile to build a SIP generated Python
188
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtHelp` module.
189
 
 
190
 
 
191
 
.. class:: QtMultimediaModuleMakefile
192
 
 
193
 
    This class encapsulates a Makefile to build a SIP generated Python
194
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtMultimedia`
195
 
    module.
196
 
 
197
 
 
198
 
.. class:: QtNetworkModuleMakefile
199
 
 
200
 
    This class encapsulates a Makefile to build a SIP generated Python
201
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtNetwork` module.
202
 
 
203
 
 
204
 
.. class:: QtOpenGLModuleMakefile
205
 
 
206
 
    This class encapsulates a Makefile to build a SIP generated Python
207
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtOpenGL` module.
208
 
 
209
 
 
210
 
.. class:: QtScriptModuleMakefile
211
 
 
212
 
    This class encapsulates a Makefile to build a SIP generated Python
213
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtScript` module.
214
 
 
215
 
 
216
 
.. class:: QtScriptToolsModuleMakefile
217
 
 
218
 
    This class encapsulates a Makefile to build a SIP generated Python
219
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtScriptTools`
220
 
    module.
221
 
 
222
 
 
223
 
.. class:: QtSqlModuleMakefile
224
 
 
225
 
    This class encapsulates a Makefile to build a SIP generated Python
226
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtSql` module.
227
 
 
228
 
 
229
 
.. class:: QtSvgModuleMakefile
230
 
 
231
 
    This class encapsulates a Makefile to build a SIP generated Python
232
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtSvg` module.
233
 
 
234
 
 
235
 
.. class:: QtTestModuleMakefile
236
 
 
237
 
    This class encapsulates a Makefile to build a SIP generated Python
238
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtTest` module.
239
 
 
240
 
 
241
 
.. class:: QtWebKitModuleMakefile
242
 
 
243
 
    This class encapsulates a Makefile to build a SIP generated Python
244
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtWebKit` module.
245
 
 
246
 
 
247
 
.. class:: QtXmlModuleMakefile
248
 
 
249
 
    This class encapsulates a Makefile to build a SIP generated Python
250
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtXml` module.
251
 
 
252
 
 
253
 
.. class:: QtXmlPatternsModuleMakefile
254
 
 
255
 
    This class encapsulates a Makefile to build a SIP generated Python
256
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.QtXmlPatterns`
257
 
    module.
258
 
 
259
 
 
260
 
.. class:: phononModuleMakefile
261
 
 
262
 
    This class encapsulates a Makefile to build a SIP generated Python
263
 
    extension module that is built on the PyQt4 :mod:`~PyQt4.phonon` module.