class QNetworkCookie#

The QNetworkCookie class holds one network cookie. More

Inheritance diagram of PySide6.QtNetwork.QNetworkCookie

Synopsis#

Methods#

Static functions#

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#

Cookies are small bits of information that stateless protocols like HTTP use to maintain some persistent information across requests.

A cookie is set by a remote server when it replies to a request and it expects the same cookie to be sent back when further requests are sent.

QNetworkCookie holds one such cookie as received from the network. A cookie has a name and a value, but those are opaque to the application (that is, the information stored in them has no meaning to the application). A cookie has an associated path name and domain, which indicate when the cookie should be sent again to the server.

A cookie can also have an expiration date, indicating its validity. If the expiration date is not present, the cookie is considered a “session cookie” and should be discarded when the application exits (or when its concept of session is over).

QNetworkCookie provides a way of parsing a cookie from the HTTP header format using the parseCookies() function. However, when received in a QNetworkReply , the cookie is already parsed.

This class implements cookies as described by the initial cookie specification by Netscape, which is somewhat similar to the RFC 2109 specification, plus the “HttpOnly” extension. The more recent RFC 2965 specification (which uses the Set-Cookie2 header) is not supported.

class RawForm#

This enum is used with the toRawForm() function to declare which form of a cookie shall be returned.

Constant

Description

QNetworkCookie.NameAndValueOnly

makes toRawForm() return only the “NAME=VALUE” part of the cookie, as suitable for sending back to a server in a client request’s “Cookie:” header. Multiple cookies are separated by a semi-colon in the “Cookie:” header field.

QNetworkCookie.Full

makes toRawForm() return the full cookie contents, as suitable for sending to a client in a server’s “Set-Cookie:” header.

Note that only the Full form of the cookie can be parsed back into its original contents.

class SameSite#

Constant

Description

QNetworkCookie.SameSite.Default

SameSite is not set. Can be interpreted as None or Lax by the browser.

QNetworkCookie.SameSite.None

Cookies can be sent in all contexts. This used to be default, but recent browsers made Lax default, and will now require the cookie to be both secure and to set SameSite=None.

QNetworkCookie.SameSite.Lax

Cookies are sent on first party requests and GET requests initiated by third party website. This is the default in modern browsers (since mid 2020).

QNetworkCookie.SameSite.Strict

Cookies will only be sent in a first-party context.

New in version 6.1.

__init__(other)#
Parameters:

otherQNetworkCookie

Creates a new QNetworkCookie object by copying the contents of other.

__init__([name=QByteArray()[, value=QByteArray()]])
Parameters:

Create a new QNetworkCookie object, initializing the cookie name to name and its value to value.

A cookie is only valid if it has a name. However, the value is opaque to the application and being empty may have significance to the remote server.

domain()#
Return type:

str

Returns the domain this cookie is associated with. This corresponds to the “domain” field of the cookie string.

Note that the domain here may start with a dot, which is not a valid hostname. However, it means this cookie matches all hostnames ending with that domain name.

See also

setDomain()

expirationDate()#
Return type:

QDateTime

Returns the expiration date for this cookie. If this cookie is a session cookie, the QDateTime returned will not be valid. If the date is in the past, this cookie has already expired and should not be sent again back to a remote server.

The expiration date corresponds to the parameters of the “expires” entry in the cookie string.

hasSameIdentifier(other)#
Parameters:

otherQNetworkCookie

Return type:

bool

Returns true if this cookie has the same identifier tuple as other. The identifier tuple is composed of the name, domain and path.

See also

operator==()

isHttpOnly()#
Return type:

bool

Returns true if the “HttpOnly” flag is enabled for this cookie.

A cookie that is “HttpOnly” is only set and retrieved by the network requests and replies; i.e., the HTTP protocol. It is not accessible from scripts running on browsers.

See also

isSecure()

isSecure()#
Return type:

bool

Returns true if the “secure” option was specified in the cookie string, false otherwise.

Secure cookies may contain private information and should not be resent over unencrypted connections.

See also

setSecure()

isSessionCookie()#
Return type:

bool

Returns true if this cookie is a session cookie. A session cookie is a cookie which has no expiration date, which means it should be discarded when the application’s concept of session is over (usually, when the application exits).

name()#
Return type:

QByteArray

Returns the name of this cookie. The only mandatory field of a cookie is its name, without which it is not considered valid.

See also

setName() value()

normalize(url)#
Parameters:

urlQUrl

This functions normalizes the path and domain of the cookie if they were previously empty. The url parameter is used to determine the correct domain and path.

__ne__(other)#
Parameters:

otherQNetworkCookie

Return type:

bool

Returns true if this cookie is not equal to other.

See also

operator==()

__eq__(other)#
Parameters:

otherQNetworkCookie

Return type:

bool

Returns true if this cookie is equal to other. This function only returns true if all fields of the cookie are the same.

However, in some contexts, two cookies of the same name could be considered equal.

See also

operator!=() hasSameIdentifier()

static parseCookies(cookieString)#
Parameters:

cookieStringQByteArray

Return type:

.list of QNetworkCookie

Parses the cookie string cookieString as received from a server response in the “Set-Cookie:” header. If there’s a parsing error, this function returns an empty list.

Since the HTTP header can set more than one cookie at the same time, this function returns a QList< QNetworkCookie >, one for each cookie that is parsed.

See also

toRawForm()

path()#
Return type:

str

Returns the path associated with this cookie. This corresponds to the “path” field of the cookie string.

See also

setPath()

sameSitePolicy()#
Return type:

SameSite

Returns the “ SameSite “ option if specified in the cookie string, SameSite::Default if not present.

setDomain(domain)#
Parameters:

domain – str

Sets the domain associated with this cookie to be domain.

See also

domain()

setExpirationDate(date)#
Parameters:

dateQDateTime

Sets the expiration date of this cookie to date. Setting an invalid expiration date to this cookie will mean it’s a session cookie.

setHttpOnly(enable)#
Parameters:

enable – bool

Sets this cookie’s “HttpOnly” flag to enable.

See also

isHttpOnly()

setName(cookieName)#
Parameters:

cookieNameQByteArray

Sets the name of this cookie to be cookieName. Note that setting a cookie name to an empty QByteArray will make this cookie invalid.

See also

name() value()

setPath(path)#
Parameters:

path – str

Sets the path associated with this cookie to be path.

See also

path()

setSameSitePolicy(sameSite)#
Parameters:

sameSiteSameSite

Sets the “ SameSite “ option of this cookie to sameSite.

See also

sameSitePolicy()

setSecure(enable)#
Parameters:

enable – bool

Sets the secure flag of this cookie to enable.

Secure cookies may contain private information and should not be resent over unencrypted connections.

See also

isSecure()

setValue(value)#
Parameters:

valueQByteArray

Sets the value of this cookie to be value.

See also

value() name()

swap(other)#
Parameters:

otherQNetworkCookie

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

toRawForm([form=QNetworkCookie.RawForm.Full])#
Parameters:

formRawForm

Return type:

QByteArray

Returns the raw form of this QNetworkCookie . The QByteArray returned by this function is suitable for an HTTP header, either in a server response (the Set-Cookie header) or the client request (the Cookie header). You can choose from one of two formats, using form.

See also

parseCookies()

value()#
Return type:

QByteArray

Returns this cookies value, as specified in the cookie string. Note that a cookie is still valid if its value is empty.

Cookie name-value pairs are considered opaque to the application: that is, their values don’t mean anything.

See also

setValue() name()