QNetworkRequest — PyQt Documentation v6.9.0 (original) (raw)

PyQt6.QtNetwork.QNetworkRequest

Description¶

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

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.

Enums¶

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.

CacheLoadControl

Controls the caching mechanism of QNetworkAccessManager.

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

LoadControl

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

Priority

This enum lists the possible network request priorities.

RedirectPolicy

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

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.

TransferTimeoutConstant

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

See also

QNetworkRequest::DefaultTransferTimeout.

Methods¶

__init__()

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

See also

url(), setUrl().

__init__(QUrl)

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

See also

url(), setUrl().

__init__(QNetworkRequest)

Creates a copy of other.

attribute(Attribute, defaultValue: Any = None) → Any

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() → 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.

__eq__(QNetworkRequest) → bool

TODO

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.

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).

See also

KnownHeaders, rawHeader(), setHeader().

Returns headers that are set in this network request.

http1Configuration() → QHttp1Configuration

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

http2Configuration() → 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() → int

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

__ne__(QNetworkRequest) → bool

TODO

originatingObject() → QObject

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

peerVerifyName() → str

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

See also

setPeerVerifyName().

priority() → Priority

Return the priority of this request.

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().

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(Attribute, Any)

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.

See also

attribute(), Attribute.

setDecompressedSafetyCheckThreshold(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.

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.

See also

KnownHeaders, setRawHeader(), header().

This is an overloaded function.

setHttp1Configuration(QHttp1Configuration)

Sets request’s HTTP/1 parameters from configuration.

setHttp2Configuration(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.

setMaximumRedirectsAllowed(int)

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

setOriginatingObject(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.

See also

originatingObject().

setPeerVerifyName(Optional[str])

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

See also

peerVerifyName().

setPriority(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.

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(QSslConfiguration)

Sets this network request’s SSL configuration to be config. The settings that apply are the private key, the local certificate, the SSL protocol (SSLv2, SSLv3, TLSv1.0 where applicable), the CA certificates and the ciphers that the SSL backend is allowed to use.

setTransferTimeout(timeout: int = DefaultTransferTimeoutConstant)

Sets timeout as the transfer timeout in milliseconds.

See also

setTransferTimeout(std::chrono::milliseconds), transferTimeout(), transferTimeoutAsDuration().

setUrl(QUrl)

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

sslConfiguration() → QSslConfiguration

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

swap(QNetworkRequest)

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

transferTimeout() → 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() → QUrl

Returns the URL this network request is referring to.