New in version 5.9.
QHttpPart class holds a body part to be used inside a HTTP multipart MIME message (which is represented by the
QHttpMultiPart class). A
QHttpPart consists of a header block and a data block, which are separated by each other by two consecutive new lines. An example for one part would be:
Content-Type: text/plain Content-Disposition: form-data; name="text" goes = here()
For reading small pieces of data, use
setBody() ; for larger data blocks like e.g. images, use
setBodyDevice() . The latter method saves memory by not copying the data internally, but reading directly from the device. This means that the device must be opened and readable at the moment when the multipart message containing the body part is sent on the network via
To construct a
QHttpPart with a small body, consider the following snippet (this produces the data shown in the example above):
textPart = QHttpPart() textPart.setHeader(QNetworkRequest.ContentTypeHeader, QVariant("text/plain")) textPart.setHeader(QNetworkRequest.ContentDispositionHeader, QVariant("form-data; name=\"text\"")) textPart.setBody("here goes the body")
To construct a
QHttpPart reading from a device (e.g. a file), the following can be applied:
imagePart = QHttpPart() imagePart.setHeader(QNetworkRequest.ContentTypeHeader, QVariant("image/jpeg")) imagePart.setHeader(QNetworkRequest.ContentDispositionHeader, QVariant("form-data; name=\"image\"")) imagePart.setRawHeader("Content-ID", "firstname.lastname@example.org") # add any headers you like via setRawHeader() file = QFile("image.jpg") file.open(QIODevice.ReadOnly) imagePart.setBodyDevice(file)
Be aware that
QHttpPart does not take ownership of the device when set, so it is the developer’s responsibility to destroy it when it is not needed anymore. A good idea might be to set the multipart message as parent object for the device, as documented at the documentation for
- class PySide6.QtNetwork.QHttpPart¶
Constructs an empty
Creates a copy of
- Return type
- Return type
true if this object is the same as
other (i.e., if they have the same headers and body).
Sets the body of this MIME part to
body. The body set with this method will be used unless the device is set via
setBodyDevice() . For a large amount of data (e.g. an image), use
setBodyDevice() , which will not copy the data internally.
Sets the device to read the content from to
device. For large amounts of data this method should be preferred over
setBody() , because the content is not copied when using this method, but read directly from the device.
device must be open and readable.
QHttpPart does not take ownership of
device, i.e. the device must be closed and destroyed if necessary. if
device is sequential (e.g. sockets, but not files),
post() should be called after
device has emitted finished(). For unsetting the device and using data set via
setBody() , use “(0)”.
- PySide6.QtNetwork.QHttpPart.setHeader(header, value)¶
value – object
Sets the value of the known header
header to be
value, overriding any previously set headers.
- PySide6.QtNetwork.QHttpPart.setRawHeader(headerName, headerValue)¶
Sets the header
headerName to be of value
headerName corresponds to a known header (see
KnownHeaders ), the raw format will be parsed and the corresponding “cooked” header will be set as well.
Setting the same header twice overrides the previous setting. To accomplish the behaviour of multiple HTTP headers of the same name, you should concatenate the two values, separating them with a comma (“,”) and set one single raw header.
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.