PySide6.QtNetwork.QNetworkRequest

class QNetworkRequest

The QNetworkRequest class holds a request to be sent with QNetworkAccessManager . More…

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

QNetworkRequest is part of the Network Access API and is the class holding the information necessary to send a request over the network. It contains a URL and some ancillary information that can be used to modify the request.

class KnownHeaders

List of known header types that QNetworkRequest parses. Each known header is also represented in raw form with its full HTTP name.

Constant

Description

QNetworkRequest.ContentDispositionHeader

Corresponds to the HTTP Content-Disposition header and contains a string containing the disposition type (for instance, attachment) and a parameter (for instance, filename).

QNetworkRequest.ContentTypeHeader

Corresponds to the HTTP Content-Type header and contains a string containing the media (MIME) type and any auxiliary data (for instance, charset).

QNetworkRequest.ContentLengthHeader

Corresponds to the HTTP Content-Length header and contains the length in bytes of the data transmitted.

QNetworkRequest.LocationHeader

Corresponds to the HTTP Location header and contains a URL representing the actual location of the data, including the destination URL in case of redirections.

QNetworkRequest.LastModifiedHeader

Corresponds to the HTTP Last-Modified header and contains a QDateTime representing the last modification date of the contents.

QNetworkRequest.IfModifiedSinceHeader

Corresponds to the HTTP If-Modified-Since header and contains a QDateTime. It is usually added to a QNetworkRequest . The server shall send a 304 (Not Modified) response if the resource has not changed since this time.

QNetworkRequest.ETagHeader

Corresponds to the HTTP ETag header and contains a QString representing the last modification state of the contents.

QNetworkRequest.IfMatchHeader

Corresponds to the HTTP If-Match header and contains a QStringList. It is usually added to a QNetworkRequest . The server shall send a 412 (Precondition Failed) response if the resource does not match.

QNetworkRequest.IfNoneMatchHeader

Corresponds to the HTTP If-None-Match header and contains a QStringList. It is usually added to a QNetworkRequest . The server shall send a 304 (Not Modified) response if the resource does match.

QNetworkRequest.CookieHeader

Corresponds to the HTTP Cookie header and contains a QList< QNetworkCookie > representing the cookies to be sent back to the server.

QNetworkRequest.SetCookieHeader

Corresponds to the HTTP Set-Cookie header and contains a QList< QNetworkCookie > representing the cookies sent by the server to be stored locally.

QNetworkRequest.UserAgentHeader

The User-Agent header sent by HTTP clients.

QNetworkRequest.ServerHeader

The Server header received by HTTP clients.

See also

header() setHeader() rawHeader() setRawHeader()

class Attribute

Attribute codes for the QNetworkRequest and QNetworkReply .

Attributes are extra meta-data that are used to control the behavior of the request and to pass further information from the reply back to the application. Attributes are also extensible, allowing custom implementations to pass custom values.

The following table explains what the default attribute codes are, the QVariant types associated, the default value if said attribute is missing and whether it’s used in requests or replies.

Constant

Description

QNetworkRequest.HttpStatusCodeAttribute

Replies only, type: QMetaType::Int (no default) Indicates the HTTP status code received from the HTTP server (like 200, 304, 404, 401, etc.). If the connection was not HTTP-based, this attribute will not be present.

QNetworkRequest.HttpReasonPhraseAttribute

Replies only, type: QMetaType::QByteArray (no default) Indicates the HTTP reason phrase as received from the HTTP server (like “Ok”, “Found”, “Not Found”, “Access Denied”, etc.) This is the human-readable representation of the status code (see above). If the connection was not HTTP-based, this attribute will not be present. Note: The reason phrase is not used when using HTTP/2.

QNetworkRequest.RedirectionTargetAttribute

Replies only, type: QMetaType::QUrl (no default) If present, it indicates that the server is redirecting the request to a different URL. The Network Access API does follow redirections by default, unless ManualRedirectPolicy is used. Additionally, if UserVerifiedRedirectPolicy is used, then this attribute will be set if the redirect was not followed. The returned URL might be relative. Use QUrl::resolved() to create an absolute URL out of it.

QNetworkRequest.ConnectionEncryptedAttribute

Replies only, type: QMetaType::Bool (default: false) Indicates whether the data was obtained through an encrypted (secure) connection.

QNetworkRequest.CacheLoadControlAttribute

Requests only, type: QMetaType::Int (default: PreferNetwork ) Controls how the cache should be accessed. The possible values are those of CacheLoadControl . Note that the default QNetworkAccessManager implementation does not support caching. However, this attribute may be used by certain backends to modify their requests (for example, for caching proxies).

QNetworkRequest.CacheSaveControlAttribute

Requests only, type: QMetaType::Bool (default: true) Controls if the data obtained should be saved to cache for future uses. If the value is false, the data obtained will not be automatically cached. If true, data may be cached, provided it is cacheable (what is cacheable depends on the protocol being used).

QNetworkRequest.SourceIsFromCacheAttribute

Replies only, type: QMetaType::Bool (default: false) Indicates whether the data was obtained from cache or not.

QNetworkRequest.DoNotBufferUploadDataAttribute

Requests only, type: QMetaType::Bool (default: false) Indicates whether the QNetworkAccessManager code is allowed to buffer the upload data, e.g. when doing a HTTP POST. When using this flag with sequential upload data, the ContentLengthHeader header must be set.

QNetworkRequest.HttpPipeliningAllowedAttribute

Requests only, type: QMetaType::Bool (default: false) Indicates whether the QNetworkAccessManager code is allowed to use HTTP pipelining with this request.

QNetworkRequest.HttpPipeliningWasUsedAttribute

Replies only, type: QMetaType::Bool Indicates whether the HTTP pipelining was used for receiving this reply.

QNetworkRequest.CustomVerbAttribute

Requests only, type: QMetaType::QByteArray Holds the value for the custom HTTP verb to send (destined for usage of other verbs than GET, POST, PUT and DELETE). This verb is set when calling sendCustomRequest() .

QNetworkRequest.CookieLoadControlAttribute

Requests only, type: QMetaType::Int (default: Automatic ) Indicates whether to send ‘Cookie’ headers in the request. This attribute is set to false by Qt WebKit when creating a cross-origin XMLHttpRequest where withCredentials has not been set explicitly to true by the Javascript that created the request. See here for more information. (This value was introduced in 4.7.)

QNetworkRequest.CookieSaveControlAttribute

Requests only, type: QMetaType::Int (default: Automatic ) Indicates whether to save ‘Cookie’ headers received from the server in reply to the request. This attribute is set to false by Qt WebKit when creating a cross-origin XMLHttpRequest where withCredentials has not been set explicitly to true by the Javascript that created the request. See here for more information. (This value was introduced in 4.7.)

QNetworkRequest.AuthenticationReuseAttribute

Requests only, type: QMetaType::Int (default: Automatic ) Indicates whether to use cached authorization credentials in the request, if available. If this is set to Manual and the authentication mechanism is ‘Basic’ or ‘Digest’, Qt will not send an ‘Authorization’ HTTP header with any cached credentials it may have for the request’s URL. This attribute is set to Manual by Qt WebKit when creating a cross-origin XMLHttpRequest where withCredentials has not been set explicitly to true by the Javascript that created the request. See here for more information. (This value was introduced in 4.7.)

QNetworkRequest.BackgroundRequestAttribute

Type: QMetaType::Bool (default: false) Indicates that this is a background transfer, rather than a user initiated transfer. Depending on the platform, background transfers may be subject to different policies.

QNetworkRequest.Http2AllowedAttribute

Requests only, type: QMetaType::Bool (default: true) Indicates whether the QNetworkAccessManager code is allowed to use HTTP/2 with this request. This applies to SSL requests or ‘cleartext’ HTTP/2 if Http2CleartextAllowedAttribute is set.

QNetworkRequest.Http2WasUsedAttribute

Replies only, type: QMetaType::Bool (default: false) Indicates whether HTTP/2 was used for receiving this reply. (This value was introduced in 5.9.)

QNetworkRequest.EmitAllUploadProgressSignalsAttribute

Requests only, type: QMetaType::Bool (default: false) Indicates whether all upload signals should be emitted. By default, the uploadProgress signal is emitted only in 100 millisecond intervals. (This value was introduced in 5.5.)

QNetworkRequest.OriginalContentLengthAttribute

Replies only, type QMetaType::Int Holds the original content-length attribute before being invalidated and removed from the header when the data is compressed and the request was marked to be decompressed automatically. (This value was introduced in 5.9.)

QNetworkRequest.RedirectPolicyAttribute

Requests only, type: QMetaType::Int, should be one of the RedirectPolicy values (default: NoLessSafeRedirectPolicy ). (This value was introduced in 5.9.)

QNetworkRequest.Http2DirectAttribute

Requests only, type: QMetaType::Bool (default: false) If set, this attribute will force QNetworkAccessManager to use HTTP/2 protocol without initial HTTP/2 protocol negotiation. Use of this attribute implies prior knowledge that a particular server supports HTTP/2. The attribute works with SSL or with ‘cleartext’ HTTP/2 if Http2CleartextAllowedAttribute is set. If a server turns out to not support HTTP/2, when HTTP/2 direct was specified, QNetworkAccessManager gives up, without attempting to fall back to HTTP/1.1. If both Http2AllowedAttribute and Http2DirectAttribute are set, Http2DirectAttribute takes priority. (This value was introduced in 5.11.)

QNetworkRequest.AutoDeleteReplyOnFinishAttribute

Requests only, type: QMetaType::Bool (default: false) If set, this attribute will make QNetworkAccessManager delete the QNetworkReply after having emitted “finished”. (This value was introduced in 5.14.)

QNetworkRequest.ConnectionCacheExpiryTimeoutSecondsAttribute

Requests only, type: QMetaType::Int To set when the TCP connections to a server (HTTP1 and HTTP2) should be closed after the last pending request had been processed. (This value was introduced in 6.3.)

QNetworkRequest.Http2CleartextAllowedAttribute

Requests only, type: QMetaType::Bool (default: false) If set, this attribute will tell QNetworkAccessManager to attempt an upgrade to HTTP/2 over cleartext (also known as h2c). Until Qt 7 the default value for this attribute can be overridden to true by setting the QT_NETWORK_H2C_ALLOWED environment variable. This attribute is ignored if the Http2AllowedAttribute is not set. (This value was introduced in 6.3.)

QNetworkRequest.UseCredentialsAttribute

Requests only, type: QMetaType::Bool (default: false) Indicates if the underlying XMLHttpRequest cross-site Access-Control requests should be made using credentials. Has no effect on same-origin requests. This only affects the WebAssembly platform. (This value was introduced in 6.5.)

QNetworkRequest.FullLocalServerNameAttribute

Requests only, type: QMetaType::String Holds the full local server name to be used for the underlying QLocalSocket . This attribute is used by the QNetworkAccessManager to connect to a specific local server, when QLocalSocket ‘s behavior for a simple name isn’t enough. The URL in the QNetworkRequest must still use unix+http: or local+http: scheme. And the hostname in the URL will be used for the Host header in the HTTP request. (This value was introduced in 6.8.)

QNetworkRequest.User

Special type. Additional information can be passed in QVariants with types ranging from User to UserMax. The default implementation of Network Access will ignore any request attributes in this range and it will not produce any attributes in this range in replies. The range is reserved for extensions of QNetworkAccessManager .

QNetworkRequest.UserMax

Special type. See User.
class CacheLoadControl

Controls the caching mechanism of QNetworkAccessManager .

Constant

Description

QNetworkRequest.AlwaysNetwork

always load from network and do not check if the cache has a valid entry (similar to the “Reload” feature in browsers); in addition, force intermediate caches to re-validate.

QNetworkRequest.PreferNetwork

default value; load from the network if the cached entry is older than the network entry. This will never return stale data from the cache, but revalidate resources that have become stale.

QNetworkRequest.PreferCache

load from cache if available, otherwise load from network. Note that this can return possibly stale (but not expired) items from cache.

QNetworkRequest.AlwaysCache

only load from cache, indicating error if the item was not cached (i.e., off-line mode)
class LoadControl

Indicates if an aspect of the request’s loading mechanism has been manually overridden, e.g. by Qt WebKit.

Constant

Description

QNetworkRequest.Automatic

default value: indicates default behaviour.

QNetworkRequest.Manual

indicates behaviour has been manually overridden.
class Priority

This enum lists the possible network request priorities.

Constant

Description

QNetworkRequest.HighPriority

High priority

QNetworkRequest.NormalPriority

Normal priority

QNetworkRequest.LowPriority

Low priority
class RedirectPolicy

Indicates whether the Network Access API should automatically follow a HTTP redirect response or not.

Constant

Description

QNetworkRequest.ManualRedirectPolicy

Not following any redirects.

QNetworkRequest.NoLessSafeRedirectPolicy

Default value: Only “http”->”http”, “http” -> “https” or “https” -> “https” redirects are allowed.

QNetworkRequest.SameOriginRedirectPolicy

Require the same protocol, host and port. Note, http://example.com and http://example.com:80 will fail with this policy (implicit/explicit ports are considered to be a mismatch).

QNetworkRequest.UserVerifiedRedirectPolicy

Client decides whether to follow each redirect by handling the redirected() signal, emitting redirectAllowed() on the QNetworkReply object to allow the redirect or aborting/finishing it to reject the redirect. This can be used, for example, to ask the user whether to accept the redirect, or to decide based on some app-specific configuration.

Note

When Qt handles redirects it will, for legacy and compatibility reasons, issue the redirected request using GET when the server returns a 301 or 302 response, regardless of the original method used, unless it was HEAD.

class TransferTimeoutConstant

A constant that can be used for enabling transfer timeouts with a preset value.

Constant

Description

QNetworkRequest.DefaultTransferTimeoutConstant

The transfer timeout in milliseconds. Used if setTimeout() is called without an argument.

See also

QNetworkRequest::DefaultTransferTimeout

__init__()

Constructs a QNetworkRequest object with no URL to be requested. Use setUrl() to set one.

See also

url() setUrl()

__init__(other)
Parameters:

other – QNetworkRequest

Creates a copy of other.

__init__(url)
Parameters:

url – QUrl

Constructs a QNetworkRequest object with url as the URL to be requested.

See also

url() setUrl()

attribute(code[, defaultValue=None])
Parameters:
Return type:

object

Returns the attribute associated with the code code. If the attribute has not been set, it returns defaultValue.

Note

This function does not apply the defaults listed in Attribute .

See also

setAttribute() Attribute

decompressedSafetyCheckThreshold()
Return type:

int

Returns the threshold for archive bomb checks.

If the decompressed size of a reply is smaller than this, Qt will simply decompress it, without further checking.

hasRawHeader(headerName)
Parameters:

headerName – str

Return type:

bool

Returns true if the raw header headerName is present in this network request.

Note

In Qt versions prior to 6.7, this function took QByteArray only.

See also

rawHeader() setRawHeader()

header(header)
Parameters:

header – KnownHeaders

Return type:

object

Returns the value of the known network header header if it is present in this request. If it is not present, returns QVariant() (i.e., an invalid variant).

headers()
Return type:

QHttpHeaders

Returns headers that are set in this network request.

See also

setHeaders()

http1Configuration()
Return type:

QHttp1Configuration

Returns the current parameters that QNetworkAccessManager is using for the underlying HTTP/1 connection of this request.

http2Configuration()
Return type:

QHttp2Configuration

Returns the current parameters that QNetworkAccessManager is using for this request and its underlying HTTP/2 connection. This is either a configuration previously set by an application or a default configuration.

The default values that QNetworkAccessManager is using are:

  • Window size for connection-level flowcontrol is 2147483647 octets

  • Window size for stream-level flowcontrol is 214748364 octets

  • Max frame size is 16384

By default, server push is disabled, Huffman compression and string indexing are enabled.

maximumRedirectsAllowed()
Return type:

int

Returns the maximum number of redirects allowed to be followed for this request.

__ne__(other)
Parameters:

other – QNetworkRequest

Return type:

bool

Returns false if this object is not the same as other.

See also

operator==()

__eq__(other)
Parameters:

other – QNetworkRequest

Return type:

bool

Returns true if this object is the same as other (i.e., if they have the same URL, same headers and same meta-data settings).

See also

operator!=()

originatingObject()
Return type:

QObject

Returns a reference to the object that initiated this network request; returns None if not set or the object has been destroyed.

peerVerifyName()
Return type:

str

Returns the host name set for the certificate validation, as set by setPeerVerifyName . By default this returns a null string.

priority()
Return type:

Priority

Return the priority of this request.

See also

setPriority()

rawHeader(headerName)
Parameters:

headerName – str

Return type:

QByteArray

Returns the raw form of header headerName. If no such header is present, an empty QByteArray is returned, which may be indistinguishable from a header that is present but has no content (use hasRawHeader() to find out if the header exists or not).

Raw headers can be set with setRawHeader() or with setHeader() .

Note

In Qt versions prior to 6.7, this function took QByteArray only.

See also

header() setRawHeader()

rawHeaderList()
Return type:

.list of QByteArray

Returns a list of all raw headers that are set in this network request. The list is in the order that the headers were set.

setAttribute(code, value)
Parameters:

Sets the attribute associated with code code to be value value. If the attribute is already set, the previous value is discarded. In special, if value is an invalid QVariant, the attribute is unset.

setDecompressedSafetyCheckThreshold(threshold)
Parameters:

threshold – int

Sets the threshold for archive bomb checks.

Some supported compression algorithms can, in a tiny compressed file, encode a spectacularly huge decompressed file. This is only possible if the decompressed content is extremely monotonous, which is seldom the case for real files being transmitted in good faith: files exercising such insanely high compression ratios are typically payloads of buffer-overrun attacks, or denial-of-service (by using up too much memory) attacks. Consequently, files that decompress to huge sizes, particularly from tiny compressed forms, are best rejected as suspected malware.

If a reply’s decompressed size is bigger than this threshold (by default, 10 MiB, i.e. 10 * 1024 * 1024), Qt will check the compression ratio: if that is unreasonably large (40:1 for GZip and Deflate, or 100:1 for Brotli and ZStandard), the reply will be treated as an error. Setting the threshold to -1 disables this check.

setHeader(header, value)
Parameters:

Sets the value of the known header header to be value, overriding any previously set headers. This operation also sets the equivalent raw HTTP header.

setHeaders(newHeaders)
Parameters:

newHeaders – QHttpHeaders

This is an overloaded function.

setHttp1Configuration(configuration)
Parameters:

configuration – QHttp1Configuration

Sets request’s HTTP/1 parameters from configuration.

setHttp2Configuration(configuration)
Parameters:

configuration – QHttp2Configuration

Sets request’s HTTP/2 parameters from configuration.

Note

The configuration must be set prior to making a request.

Note

HTTP/2 multiplexes several streams in a single HTTP/2 connection. This implies that QNetworkAccessManager will use the configuration found in the first request from a series of requests sent to the same host.

See also

http2Configuration QNetworkAccessManager QHttp2Configuration

setMaximumRedirectsAllowed(maximumRedirectsAllowed)
Parameters:

maximumRedirectsAllowed – int

Sets the maximum number of redirects allowed to be followed for this request to maxRedirectsAllowed.

setOriginatingObject(object)
Parameters:

object – QObject

Allows setting a reference to the object initiating the request.

For example Qt WebKit sets the originating object to the QWebFrame that initiated the request.

setPeerVerifyName(peerName)
Parameters:

peerName – str

Sets peerName as host name for the certificate validation, instead of the one used for the TCP connection.

See also

peerVerifyName

setPriority(priority)
Parameters:

priority – Priority

Set the priority of this request to priority.

Note

The priority is only a hint to the network access manager. It can use it or not. Currently it is used for HTTP to decide which request should be sent first to a server.

See also

priority()

setRawHeader(headerName, value)
Parameters:

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Sets the header headerName to be of value headerValue. If headerName corresponds to a known header (see KnownHeaders ), the raw format will be parsed and the corresponding “cooked” header will be set as well.

For example:

request.setRawHeader(QByteArray("Last-Modified"), QByteArray("Sun, 06 Nov 1994 08:49:37 GMT"))

will also set the known header LastModifiedHeader to be the QDateTime object of the parsed date.

Note

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.

Note

Since Qt 6.8, the header field names are normalized by converting them to lowercase.

See also

KnownHeaders setHeader() hasRawHeader() rawHeader()

setSslConfiguration(configuration)
Parameters:

configuration – QSslConfiguration

Sets this network request’s SSL configuration to be config. The settings that apply are the private key, the local certificate, the TLS protocol (e.g. TLS 1.3), the CA certificates and the ciphers that the SSL backend is allowed to use.

setTransferTimeout(timeout)
Parameters:

timeout – int

Sets timeout as the transfer timeout in milliseconds.

See also

milliseconds) transferTimeout() transferTimeoutAsDuration()

setUrl(url)
Parameters:

url – QUrl

Sets the URL this network request is referring to be url.

See also

url()

sslConfiguration()
Return type:

QSslConfiguration

Returns this network request’s SSL configuration. By default this is the same as defaultConfiguration() .

swap(other)
Parameters:

other – QNetworkRequest

Swaps this network request with other. This operation is very fast and never fails.

transferTimeout()
Return type:

int

Returns the timeout used for transfers, in milliseconds.

If transferTimeoutAsDuration() .count() cannot be represented in int, this function returns INT_MAX/INT_MIN instead.

See also

setTransferTimeout() transferTimeoutAsDuration()

url()
Return type:

QUrl

Returns the URL this network request is referring to.

See also

setUrl()