QUrlQuery¶

PyQt5.QtCore.QUrlQuery

Description¶

The QUrlQuery class provides a way to manipulate a key-value pairs in a URL’s query.

It is used to parse the query strings found in URLs like the following:

Query strings like the above are used to transmit options in the URL and are usually decoded into multiple key-value pairs. The one above would contain two entries in its list, with keys “type” and “color”. QUrlQuery can also be used to create a query string suitable for use in setQuery() from the individual components of the query.

The most common way of parsing a query string is to initialize it in the constructor by passing it the query string. Otherwise, the setQuery() method can be used to set the query to be parsed. That method can also be used to parse a query with non-standard delimiters, after having set them using the setQueryDelimiters() function.

The encoded query string can be obtained again using query(). This will take all the internally-stored items and encode the string using the delimiters.

Encoding¶

All of the getter methods in QUrlQuery support an optional parameter of type QUrl::ComponentFormattingOptions, including query(), which dictate how to encode the data in question. Except for FullyDecoded, the returned value must still be considered a percent-encoded string, as there are certain values which cannot be expressed in decoded form (like control characters, byte sequences not decodable to UTF-8). For that reason, the percent character is always represented by the string “%25”.

Handling of spaces and plus (“+”)¶

Web browsers usually encode spaces found in HTML FORM elements to a plus sign (“+”) and plus signs to its percent-encoded form (%2B). However, the Internet specifications governing URLs do not consider spaces and the plus character equivalent.

For that reason, QUrlQuery never encodes the space character to “+” and will never decode “+” to a space character. Instead, space characters will be rendered “%20” in encoded form.

To support encoding like that of HTML forms, QUrlQuery also never decodes the “%2B” sequence to a plus sign nor encode a plus sign. In fact, any “%2B” or “+” sequences found in the keys, values, or query string are left exactly like written (except for the uppercasing of “%2b” to “%2B”).

Full decoding¶

With FullyDecoded formatting, all percent-encoded sequences will be decoded fully and the ‘%’ character is used to represent itself. FullyDecoded should be used with care, since it may cause data loss. See the documentation of FullyDecoded for information on what data may be lost.

This formatting mode should be used only when dealing with text presented to the user in contexts where percent-encoding is not desired. Note that QUrlQuery setters and query methods do not support the counterpart DecodedMode parsing, so using FullyDecoded to obtain a listing of keys may result in keys not found in the object.

Non-standard delimiters¶

By default, QUrlQuery uses an equal sign (“=”) to separate a key from its value, and an ampersand (“&”) to separate key-value pairs from each other. It is possible to change the delimiters that QUrlQuery uses for parsing and for reconstructing the query by calling setQueryDelimiters().

Non-standard delimiters should be chosen from among what RFC 3986 calls “sub-delimiters”. They are:

# sub-delims    = "!" / "$" / "&" / "'" / "(" / ")"
#               / "*" / "+" / "," / ";" / "="

Use of other characters is not supported and may result in unexpected behaviour. QUrlQuery does not verify that you passed a valid delimiter.

Methods¶

__init__(): TODO

__init__(QUrl): TODO

__init__(str): TODO

__init__(QUrlQuery): TODO

addQueryItem(str, str): TODO

allQueryItemValues(str, options: Union[ComponentFormattingOptions, ComponentFormattingOption] = PrettyDecoded) → List[str]: TODO

clear(): TODO

@staticmethod defaultQueryPairDelimiter() → str: TODO

@staticmethod defaultQueryValueDelimiter() → str: TODO

__eq__(QUrlQuery) → bool: TODO

__hash__() → int: TODO

hasQueryItem(str) → bool: TODO

isDetached() → bool: TODO

isEmpty() → bool: TODO

__ne__(QUrlQuery) → bool: TODO

query(options: Union[ComponentFormattingOptions, ComponentFormattingOption] = PrettyDecoded) → str: See also

setQuery().

queryItems(options: Union[ComponentFormattingOptions, ComponentFormattingOption] = PrettyDecoded) → List[Tuple[str, str]]: See also

setQueryItems().

queryItemValue(str, options: Union[ComponentFormattingOptions, ComponentFormattingOption] = PrettyDecoded) → str: TODO

queryPairDelimiter() → str: TODO

queryValueDelimiter() → str: TODO

removeAllQueryItems(str): TODO

removeQueryItem(str): TODO

setQuery(str): See also

query().

setQueryDelimiters(str, str): TODO

setQueryItems(Iterable[Tuple[str, str]]): See also

queryItems().

swap(QUrlQuery): TODO

toString(options: Union[ComponentFormattingOptions, ComponentFormattingOption] = PrettyDecoded) → str: TODO