QUrl¶
Synopsis¶
Functions¶
def
__eq__
(url)def
__lt__
(url)def
__ne__
(url)def
__reduce__
()def
__repr__
()def
adjusted
(options)def
authority
([options=QUrl.PrettyDecoded])def
clear
()def
errorString
()def
fileName
([options=QUrl.FullyDecoded])def
fragment
([options=QUrl.PrettyDecoded])def
hasFragment
()def
hasQuery
()def
host
([arg__1=QUrl.FullyDecoded])def
isEmpty
()def
isLocalFile
()def
isParentOf
(url)def
isRelative
()def
isValid
()def
matches
(url, options)def
operator=
(url)def
password
([arg__1=QUrl.FullyDecoded])def
path
([options=QUrl.FullyDecoded])def
port
([defaultPort=-1])def
query
([arg__1=QUrl.PrettyDecoded])def
resolved
(relative)def
scheme
()def
setAuthority
(authority[, mode=TolerantMode])def
setFragment
(fragment[, mode=TolerantMode])def
setHost
(host[, mode=DecodedMode])def
setPassword
(password[, mode=DecodedMode])def
setPath
(path[, mode=DecodedMode])def
setPort
(port)def
setQuery
(query)def
setQuery
(query[, mode=TolerantMode])def
setScheme
(scheme)def
setUrl
(url[, mode=TolerantMode])def
setUserInfo
(userInfo[, mode=TolerantMode])def
setUserName
(userName[, mode=DecodedMode])def
swap
(other)def
toDisplayString
([options=QUrl.FormattingOptions(PrettyDecoded)])def
toEncoded
([options=QUrl.FullyEncoded])def
toLocalFile
()def
toString
([options=QUrl.FormattingOptions(PrettyDecoded)])def
topLevelDomain
([options=QUrl.FullyDecoded])def
url
([options=QUrl.FormattingOptions(PrettyDecoded)])def
userInfo
([options=QUrl.PrettyDecoded])def
userName
([options=QUrl.FullyDecoded])
Static functions¶
def
fromAce
(arg__1)def
fromEncoded
(url[, mode=TolerantMode])def
fromLocalFile
(localfile)def
fromPercentEncoding
(arg__1)def
fromStringList
(uris[, mode=TolerantMode])def
fromUserInput
(userInput)def
fromUserInput
(userInput, workingDirectory[, options=QUrl.DefaultResolution])def
idnWhitelist
()def
setIdnWhitelist
(arg__1)def
toAce
(arg__1)def
toPercentEncoding
(arg__1[, exclude=QByteArray()[, include=QByteArray()]])def
toStringList
(uris[, options=QUrl.FormattingOptions(PrettyDecoded)])
Detailed Description¶
It can parse and construct URLs in both encoded and unencoded form.
QUrl
also has support for internationalized domain names (IDNs).The most common way to use
QUrl
is to initialize it via the constructor by passing aQString
. Otherwise,setUrl()
can also be used.URLs can be represented in two forms: encoded or unencoded. The unencoded representation is suitable for showing to users, but the encoded representation is typically what you would send to a web server. For example, the unencoded URL “http://bühler.example.com/List of applicants.xml” would be sent to the server as “http://xn–bhler-kva.example.com/List%20of%20applicants.xml”.
A URL can also be constructed piece by piece by calling
setScheme()
,setUserName()
,setPassword()
,setHost()
,setPort()
,setPath()
,setQuery()
andsetFragment()
. Some convenience functions are also available:setAuthority()
sets the user name, password, host and port.setUserInfo()
sets the user name and password at once.Call
isValid()
to check if the URL is valid. This can be done at any point during the constructing of a URL. IfisValid()
returnsfalse
, you shouldclear()
the URL before proceeding, or start over by parsing a new URL withsetUrl()
.Constructing a query is particularly convenient through the use of the
QUrlQuery
class and its methodssetQueryItems()
,addQueryItem()
andremoveQueryItem()
. UsesetQueryDelimiters()
to customize the delimiters used for generating the query string.For the convenience of generating encoded URL strings or query strings, there are two static functions called
fromPercentEncoding()
andtoPercentEncoding()
which deal with percent encoding and decoding ofQString
objects.
fromLocalFile()
constructs aQUrl
by parsing a local file path.toLocalFile()
converts a URL to a local file path.The human readable representation of the URL is fetched with
toString()
. This representation is appropriate for displaying a URL to a user in unencoded form. The encoded form however, as returned bytoEncoded()
, is for internal use, passing to web servers, mail clients and so on. Both forms are technically correct and represent the same URL unambiguously – in fact, passing either form toQUrl
‘s constructor or tosetUrl()
will yield the sameQUrl
object.
QUrl
conforms to the URI specification from RFC 3986 (Uniform Resource Identifier: Generic Syntax), and includes scheme extensions from RFC 1738 (Uniform Resource Locators). Case folding rules inQUrl
conform to RFC 3491 (Nameprep: A Stringprep Profile for Internationalized Domain Names (IDN)). It is also compatible with the file URI specification from freedesktop.org, provided that the locale encodes file names using UTF-8 (required by IDN).
Relative URLs vs Relative Paths¶
Calling
isRelative()
will return whether or not the URL is relative. A relative URL has noscheme
. For example:qDebug() << QUrl("main.qml").isRelative(); // true: no scheme qDebug() << QUrl("qml/main.qml").isRelative(); // true: no scheme qDebug() << QUrl("file:main.qml").isRelative(); // false: has "file" scheme qDebug() << QUrl("file:qml/main.qml").isRelative(); // false: has "file" schemeNotice that a URL can be absolute while containing a relative path, and vice versa:
// Absolute URL, relative path QUrl url("file:file.txt"); qDebug() << url.isRelative(); // false: has "file" scheme qDebug() << QDir::isAbsolutePath(url.path()); // false: relative path // Relative URL, absolute path url = QUrl("/home/user/file.txt"); qDebug() << url.isRelative(); // true: has no scheme qDebug() << QDir::isAbsolutePath(url.path()); // true: absolute pathA relative URL can be resolved by passing it as an argument to
resolved()
, which returns an absolute URL.isParentOf()
is used for determining whether one URL is a parent of another.
Error checking¶
QUrl
is capable of detecting many errors in URLs while parsing it or when components of the URL are set with individual setter methods (likesetScheme()
,setHost()
orsetPath()
). If the parsing or setter function is successful, any previously recorded error conditions will be discarded.By default,
QUrl
setter methods operate inTolerantMode
, which means they accept some common mistakes and mis-representation of data. An alternate method of parsing isStrictMode
, which applies further checks. SeeParsingMode
for a description of the difference of the parsing modes.
QUrl
only checks for conformance with the URL specification. It does not try to verify that high-level protocol URLs are in the format they are expected to be by handlers elsewhere. For example, the following URIs are all considered valid byQUrl
, even if they do not make sense when used:When the parser encounters an error, it signals the event by making
isValid()
return false andtoString()
/toEncoded()
return an empty string. If it is necessary to show the user the reason why the URL failed to parse, the error condition can be obtained fromQUrl
by callingerrorString()
. Note that this message is highly technical and may not make sense to end-users.
QUrl
is capable of recording only one error condition. If more than one error is found, it is undefined which error is reported.
Character Conversions¶
Follow these rules to avoid erroneous character conversion when dealing with URLs and strings:
When creating a
QString
to contain a URL from aQByteArray
or a char*, always usefromUtf8()
.
- class PySide2.QtCore.QUrl¶
PySide2.QtCore.QUrl(url[, mode=TolerantMode])
PySide2.QtCore.QUrl(copy)
- param url:
str
- param copy:
- param mode:
Constructs an empty
QUrl
object.Constructs a URL by parsing
url
.QUrl
will automatically percent encode all characters that are not allowed in a URL and decode the percent-encoded sequences that represent an unreserved character (letters, digits, hyphens, undercores, dots and tildes). All other characters are left in their original forms.Parses the
url
using the parser modeparsingMode
. InTolerantMode
(the default),QUrl
will correct certain mistakes, notably the presence of a percent character (‘%’) not followed by two hexadecimal digits, and it will accept any character in any position. InStrictMode
, encoding mistakes will not be tolerated andQUrl
will also check that certain forbidden characters are not present in unencoded form. If an error is detected inStrictMode
,isValid()
will return false. The parsing modeDecodedMode
is not permitted in this context.Example:
url = QUrl("http://www.example.com/List of holidays.xml") # url.toEncoded() == "http://www.example.com/List%20of%20holidays.xml"
To construct a URL from an encoded string, you can also use
fromEncoded()
:url = QUrl.fromEncoded("http://qtsoftware.com/List%20of%20holidays.xml")
Both functions are equivalent and, in Qt 5, both functions accept encoded data. Usually, the choice of the
QUrl
constructor orsetUrl()
versusfromEncoded()
will depend on the source data: the constructor andsetUrl()
take aQString
, whereasfromEncoded
takes aQByteArray
.See also
setUrl()
fromEncoded()
TolerantMode
- PySide2.QtCore.QUrl.ParsingMode¶
The parsing mode controls the way
QUrl
parses strings.Constant
Description
QUrl.TolerantMode
QUrl
will try to correct some common errors in URLs. This mode is useful for parsing URLs coming from sources not known to be strictly standards-conforming.QUrl.StrictMode
Only valid URLs are accepted. This mode is useful for general URL validation.
QUrl.DecodedMode
QUrl
will interpret the URL component in the fully-decoded form, where percent characters stand for themselves, not as the beginning of a percent-encoded sequence. This mode is only valid for the setters setting components of a URL; it is not permitted in theQUrl
constructor, infromEncoded()
or insetUrl()
. For more information on this mode, see the documentation forFullyDecoded
.In , the parser has the following behaviour:
Spaces and “%20”: unencoded space characters will be accepted and will be treated as equivalent to “%20”.
Single “%” characters: Any occurrences of a percent character “%” not followed by exactly two hexadecimal characters (e.g., “13% coverage.html”) will be replaced by “%25”. Note that one lone “%” character will trigger the correction mode for all percent characters.
Reserved and unreserved characters: An encoded URL should only contain a few characters as literals; all other characters should be percent-encoded. In , these characters will be accepted if they are found in the URL: space / double-quote / “<” / “>” / “” / “^” / “`” / “{” / “|” / “}” Those same characters can be decoded again by passing
DecodeReserved
totoString()
ortoEncoded()
. In the getters of individual components, those characters are often returned in decoded form.
When in , if a parsing error is found,
isValid()
will returnfalse
anderrorString()
will return a message describing the error. If more than one error is detected, it is undefined which error gets reported.Note that is not usually enough for parsing user input, which often contains more errors and expectations than the parser can deal with. When dealing with data coming directly from the user – as opposed to data coming from data-transfer sources, such as other programs – it is recommended to use
fromUserInput()
.See also
fromUserInput()
setUrl()
toString()
toEncoded()
FormattingOptions
- PySide2.QtCore.QUrl.UrlFormattingOption¶
The formatting options define how the URL is formatted when written out as text.
Constant
Description
QUrl.None
The format of the URL is unchanged.
QUrl.RemoveScheme
The scheme is removed from the URL.
QUrl.RemovePassword
Any password in the URL is removed.
QUrl.RemoveUserInfo
Any user information in the URL is removed.
QUrl.RemovePort
Any specified port is removed from the URL.
QUrl.RemoveAuthority
QUrl.RemovePath
The URL’s path is removed, leaving only the scheme, host address, and port (if present).
QUrl.RemoveQuery
The query part of the URL (following a ‘?’ character) is removed.
QUrl.RemoveFragment
QUrl.RemoveFilename
The filename (i.e. everything after the last ‘/’ in the path) is removed. The trailing ‘/’ is kept, unless is set. Only valid if is not set.
QUrl.PreferLocalFile
If the URL is a local file according to
isLocalFile()
and contains no query or fragment, a local file path is returned.QUrl.StripTrailingSlash
The trailing slash is removed from the path, if one is present.
QUrl.NormalizePathSegments
Modifies the path to remove redundant directory separators, and to resolve “.”s and “..”s (as far as possible). For non-local paths, adjacent slashes are preserved.
Note that the case folding rules in Nameprep, which
QUrl
conforms to, require host names to always be converted to lower case, regardless of the Qt::FormattingOptions used.The options from
ComponentFormattingOptions
are also possible.See also
ComponentFormattingOptions
- PySide2.QtCore.QUrl.ComponentFormattingOption¶
The component formatting options define how the components of an URL will be formatted when written out as text. They can be combined with the options from
FormattingOptions
when used intoString()
andtoEncoded()
.Constant
Description
QUrl.PrettyDecoded
The component is returned in a “pretty form”, with most percent-encoded characters decoded. The exact behavior of varies from component to component and may also change from Qt release to Qt release. This is the default.
QUrl.EncodeSpaces
Leave space characters in their encoded form (“%20”).
QUrl.EncodeUnicode
Leave non-US-ASCII characters encoded in their UTF-8 percent-encoded form (e.g., “%C3%A9” for the U+00E9 codepoint, LATIN SMALL LETTER E WITH ACUTE).
QUrl.EncodeDelimiters
Leave certain delimiters in their encoded form, as would appear in the URL when the full URL is represented as text. The delimiters are affected by this option change from component to component. This flag has no effect in
toString()
ortoEncoded()
.QUrl.EncodeReserved
Leave US-ASCII characters not permitted in the URL by the specification in their encoded form. This is the default on
toString()
andtoEncoded()
.QUrl.DecodeReserved
Decode the US-ASCII characters that the URL specification does not allow to appear in the URL. This is the default on the getters of individual components.
QUrl.FullyEncoded
Leave all characters in their properly-encoded form, as this component would appear as part of a URL. When used with
toString()
, this produces a fully-compliant URL inQString
form, exactly equal to the result oftoEncoded()
QUrl.FullyDecoded
Attempt to decode as much as possible. For individual components of the URL, this decodes every percent encoding sequence, including control characters (U+0000 to U+001F) and UTF-8 sequences found in percent-encoded form. Use of this mode may cause data loss, see below for more information.
The values of and should not be used together in one call. The behavior is undefined if that happens. They are provided as separate values because the behavior of the “pretty mode” with regards to reserved characters is different on certain components and specially on the full URL.
Full decoding¶
The mode is similar to the behavior of the functions returning
QString
in Qt 4.x, in that every character represents itself and never has any special meaning. This is true even for the percent character (‘%’), which should be interpreted to mean a literal percent, not the beginning of a percent-encoded sequence. The same actual character, in all other decoding modes, is represented by the sequence “%25”.Whenever re-applying data obtained with into a
QUrl
, care must be taken to use theDecodedMode
parameter to the setters (likesetPath()
andsetUserName()
). Failure to do so may cause re-interpretation of the percent character (‘%’) as the beginning of a percent-encoded sequence.This mode is quite useful when portions of a URL are used in a non-URL context. For example, to extract the username, password or file paths in an FTP client application, the mode should be used.
This mode should be used with care, since there are two conditions that cannot be reliably represented in the returned
QString
. They are:
Non-UTF-8 sequences: URLs may contain sequences of percent-encoded characters that do not form valid UTF-8 sequences. Since URLs need to be decoded using UTF-8, any decoder failure will result in the
QString
containing one or more replacement characters where the sequence existed.Encoded delimiters: URLs are also allowed to make a distinction between a delimiter found in its literal form and its equivalent in percent-encoded form. This is most commonly found in the query, but is permitted in most parts of the URL.
The following example illustrates the problem:
QUrl original("http://example.com/?q=a%2B%3Db%26c"); QUrl copy(original); copy.setQuery(copy.query(QUrl::FullyDecoded), QUrl::DecodedMode); qDebug() << original.toString(); // prints: http://example.com/?q=a%2B%3Db%26c qDebug() << copy.toString(); // prints: http://example.com/?q=a+=b&cIf the two URLs were used via HTTP GET, the interpretation by the web server would probably be different. In the first case, it would interpret as one parameter, with a key of “q” and value “a+=b&c”. In the second case, it would probably interpret as two parameters, one with a key of “q” and value “a =b”, and the second with a key “c” and no value.
See also
FormattingOptions
- PySide2.QtCore.QUrl.UserInputResolutionOption¶
The user input resolution options define how
fromUserInput()
should interpret strings that could either be a relative path or the short form of a HTTP URL. For instancefile.pl
can be either a local file or the URLhttp://file.pl
.Constant
Description
QUrl.DefaultResolution
The default resolution mechanism is to check whether a local file exists, in the working directory given to
fromUserInput
, and only return a local path in that case. Otherwise a URL is assumed.QUrl.AssumeLocalFile
This option makes
fromUserInput()
always return a local path unless the input contains a scheme, such ashttp://file.pl
. This is useful for applications such as text editors, which are able to create the file if it doesn’t exist.See also
- PySide2.QtCore.QUrl.__reduce__()¶
- Return type:
object
- PySide2.QtCore.QUrl.__repr__()¶
- Return type:
object
- PySide2.QtCore.QUrl.adjusted(options)¶
- Parameters:
options –
FormattingOptions
- Return type:
Returns an adjusted version of the URL. The output can be customized by passing flags with
options
.The encoding options from
ComponentFormattingOption
don’t make much sense for this method, nor doesPreferLocalFile
.This is always equivalent to
QUrl
(url.toString
(options)).See also
FormattingOptions
toEncoded()
toString()
- PySide2.QtCore.QUrl.authority([options=QUrl.PrettyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Returns the authority of the URL if it is defined; otherwise an empty string is returned.
This function returns an unambiguous value, which may contain that characters still percent-encoded, plus some control sequences not representable in decoded form in
QString
.The
options
argument controls how to format the user info component. The value ofFullyDecoded
is not permitted in this function. If you need to obtain fully decoded data, calluserName()
,password()
,host()
andport()
individually.See also
setAuthority()
userInfo()
userName()
password()
host()
port()
- PySide2.QtCore.QUrl.clear()¶
Resets the content of the
QUrl
. After calling this function, theQUrl
is equal to one that has been constructed with the default empty constructor.See also
- PySide2.QtCore.QUrl.errorString()¶
- Return type:
str
Returns an error message if the last operation that modified this
QUrl
object ran into a parsing error. If no error was detected, this function returns an empty string andisValid()
returnstrue
.The error message returned by this function is technical in nature and may not be understood by end users. It is mostly useful to developers trying to understand why
QUrl
will not accept some input.See also
ParsingMode
- PySide2.QtCore.QUrl.fileName([options=QUrl.FullyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Returns the name of the file, excluding the directory path.
Note that, if this
QUrl
object is given a path ending in a slash, the name of the file is considered empty.If the path doesn’t contain any slash, it is fully returned as the .
Example:
QUrl url("http://qt-project.org/support/file.html"); // url.adjusted(RemoveFilename) == "http://qt-project.org/support/" // url.fileName() == "file.html"
The
options
argument controls how to format the file name component. All values produce an unambiguous result. WithFullyDecoded
, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form inQString
.See also
- PySide2.QtCore.QUrl.fragment([options=QUrl.PrettyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Returns the fragment of the URL. To determine if the parsed URL contained a fragment, use
hasFragment()
.The
options
argument controls how to format the fragment component. All values produce an unambiguous result. WithFullyDecoded
, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form inQString
.Note that
FullyDecoded
may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context.See also
- static PySide2.QtCore.QUrl.fromAce(arg__1)¶
- Parameters:
arg__1 –
PySide2.QtCore.QByteArray
- Return type:
str
Returns the Unicode form of the given domain name
domain
, which is encoded in the ASCII Compatible Encoding (ACE). The result of this function is considered equivalent todomain
.If the value in
domain
cannot be encoded, it will be converted toQString
and returned.The ASCII Compatible Encoding (ACE) is defined by RFC 3490, RFC 3491 and RFC 3492. It is part of the Internationalizing Domain Names in Applications (IDNA) specification, which allows for domain names (like
"example.com"
) to be written using international characters.
- static PySide2.QtCore.QUrl.fromEncoded(url[, mode=TolerantMode])¶
- Parameters:
mode –
ParsingMode
- Return type:
Parses
input
and returns the correspondingQUrl
.input
is assumed to be in encoded form, containing only ASCII characters.Parses the URL using
parsingMode
. SeesetUrl()
for more information on this parameter.DecodedMode
is not permitted in this context.See also
- static PySide2.QtCore.QUrl.fromLocalFile(localfile)¶
- Parameters:
localfile – str
- Return type:
Returns a
QUrl
representation oflocalFile
, interpreted as a local file. This function accepts paths separated by slashes as well as the native separator for this platform.This function also accepts paths with a doubled leading slash (or backslash) to indicate a remote file, as in “//servername/path/to/file.txt”. Note that only certain platforms can actually open this file using
open()
.An empty
localFile
leads to an empty URL (since Qt 5.4).qDebug() << QUrl::fromLocalFile("file.txt"); // QUrl("file:file.txt") qDebug() << QUrl::fromLocalFile("/home/user/file.txt"); // QUrl("file:///home/user/file.txt") qDebug() << QUrl::fromLocalFile("file:file.txt"); // doesn't make sense; expects path, not url with scheme
In the first line in snippet above, a file URL is constructed from a local, relative path. A file URL with a relative path only makes sense if there is a base URL to resolve it against. For example:
QUrl url = QUrl::fromLocalFile("file.txt"); QUrl baseUrl = QUrl("file:/home/user/"); // wrong: prints QUrl("file:file.txt"), as url already has a scheme qDebug() << baseUrl.resolved(url);
To resolve such a URL, it’s necessary to remove the scheme beforehand:
// correct: prints QUrl("file:///home/user/file.txt") url.setScheme(QString()); qDebug() << baseUrl.resolved(url);
For this reason, it is better to use a relative URL (that is, no scheme) for relative file paths:
QUrl url = QUrl("file.txt"); QUrl baseUrl = QUrl("file:/home/user/"); // prints QUrl("file:///home/user/file.txt") qDebug() << baseUrl.resolved(url);
- static PySide2.QtCore.QUrl.fromPercentEncoding(arg__1)¶
- Parameters:
arg__1 –
PySide2.QtCore.QByteArray
- Return type:
str
Returns a decoded copy of
input
.input
is first decoded from percent encoding, then converted from UTF-8 to unicode.Note
Given invalid input (such as a string containing the sequence “%G5”, which is not a valid hexadecimal number) the output will be invalid as well. As an example: the sequence “%G5” could be decoded to ‘W’.
- static PySide2.QtCore.QUrl.fromStringList(uris[, mode=TolerantMode])¶
- Parameters:
uris – list of strings
mode –
ParsingMode
- Return type:
Converts a list of strings representing
urls
into a list of urls, usingQUrl
(str,mode
). Note that this means all strings must be urls, not for instance local paths.
- static PySide2.QtCore.QUrl.fromUserInput(userInput)¶
- Parameters:
userInput – str
- Return type:
Returns a valid URL from a user supplied
userInput
string if one can be deducted. In the case that is not possible, an invalidQUrl()
is returned.Most applications that can browse the web, allow the user to input a URL in the form of a plain string. This string can be manually typed into a location bar, obtained from the clipboard, or passed in via command line arguments.
When the string is not already a valid URL, a best guess is performed, making various web related assumptions.
In the case the string corresponds to a valid file path on the system, a file:// URL is constructed, using
fromLocalFile()
.If that is not the case, an attempt is made to turn the string into a http:// or ftp:// URL. The latter in the case the string starts with ‘ftp’. The result is then passed through
QUrl
‘s tolerant parser, and in the case or success, a validQUrl
is returned, or else aQUrl()
.
Examples:¶
qt-project.org becomes http://qt-project.org
ftp.qt-project.org becomes ftp://ftp.qt-project.org
hostname becomes http://hostname
/home/user/test.html becomes file:///home/user/test.html
- static PySide2.QtCore.QUrl.fromUserInput(userInput, workingDirectory[, options=QUrl.DefaultResolution])
- Parameters:
userInput – str
workingDirectory – str
options –
UserInputResolutionOptions
- Return type:
Returns a valid URL from a user supplied
userInput
string if one can be deduced. In the case that is not possible, an invalidQUrl()
is returned.This overload takes a
workingDirectory
path, in order to be able to handle relative paths. This is especially useful when handling command line arguments. IfworkingDirectory
is empty, no handling of relative paths will be done, so this method will behave like its one argument overload.By default, an input string that looks like a relative path will only be treated as such if the file actually exists in the given working directory.
If the application can handle files that don’t exist yet, it should pass the flag
AssumeLocalFile
inoptions
.
- PySide2.QtCore.QUrl.hasFragment()¶
- Return type:
bool
Returns
true
if this URL contains a fragment (i.e., if # was seen on it).See also
- PySide2.QtCore.QUrl.hasQuery()¶
- Return type:
bool
Returns
true
if this URL contains a Query (i.e., if ? was seen on it).See also
- PySide2.QtCore.QUrl.host([arg__1=QUrl.FullyDecoded])¶
- Parameters:
arg__1 –
ComponentFormattingOptions
- Return type:
str
Returns the host of the URL if it is defined; otherwise an empty string is returned.
The
options
argument controls how the hostname will be formatted. TheEncodeUnicode
option will cause this function to return the hostname in the ASCII-Compatible Encoding (ACE) form, which is suitable for use in channels that are not 8-bit clean or that require the legacy hostname (such as DNS requests or in HTTP request headers). If that flag is not present, this function returns the International Domain Name (IDN) in Unicode form, according to the list of permissible top-level domains (seeidnWhitelist()
).All other flags are ignored. Host names cannot contain control or percent characters, so the returned value can be considered fully decoded.
- static PySide2.QtCore.QUrl.idnWhitelist()¶
- Return type:
list of strings
Returns the current whitelist of top-level domains that are allowed to have non-ASCII characters in their compositions.
See
setIdnWhitelist()
for the rationale of this list.See also
- PySide2.QtCore.QUrl.isEmpty()¶
- Return type:
bool
Returns
true
if the URL has no data; otherwise returnsfalse
.See also
- PySide2.QtCore.QUrl.isLocalFile()¶
- Return type:
bool
Returns
true
if this URL is pointing to a local file path. A URL is a local file path if the scheme is “file”.Note that this function considers URLs with hostnames to be local file paths, even if the eventual file path cannot be opened with
open()
.See also
- PySide2.QtCore.QUrl.isParentOf(url)¶
- Parameters:
url –
PySide2.QtCore.QUrl
- Return type:
bool
Returns
true
if this URL is a parent ofchildUrl
.childUrl
is a child of this URL if the two URLs share the same scheme and authority, and this URL’s path is a parent of the path ofchildUrl
.
- PySide2.QtCore.QUrl.isRelative()¶
- Return type:
bool
Returns
true
if the URL is relative; otherwise returnsfalse
. A URL is relative reference if its scheme is undefined; this function is therefore equivalent to callingscheme()
.isEmpty()
.Relative references are defined in RFC 3986 section 4.2.
See also
Relative URLs vs Relative Paths
- PySide2.QtCore.QUrl.isValid()¶
- Return type:
bool
Returns
true
if the URL is non-empty and valid; otherwise returnsfalse
.The URL is run through a conformance test. Every part of the URL must conform to the standard encoding rules of the URI standard for the URL to be reported as valid.
def checkUrl(url): if !url.isValid(): print "Invalid URL: %s" % url.toString() return False return True
- PySide2.QtCore.QUrl.matches(url, options)¶
- Parameters:
url –
PySide2.QtCore.QUrl
options –
FormattingOptions
- Return type:
bool
Returns
true
if this URL and the givenurl
are equal after applyingoptions
to both; otherwise returnsfalse
.This is equivalent to calling adjusted(options) on both URLs and comparing the resulting urls, but faster.
- PySide2.QtCore.QUrl.__ne__(url)¶
- Parameters:
url –
PySide2.QtCore.QUrl
- Return type:
bool
Returns
true
if this URL and the givenurl
are not equal; otherwise returnsfalse
.See also
- PySide2.QtCore.QUrl.__lt__(url)¶
- Parameters:
url –
PySide2.QtCore.QUrl
- Return type:
bool
- PySide2.QtCore.QUrl.operator=(url)
- Parameters:
url – str
- Return type:
- PySide2.QtCore.QUrl.__eq__(url)¶
- Parameters:
url –
PySide2.QtCore.QUrl
- Return type:
bool
Returns
true
if this URL and the givenurl
are equal; otherwise returnsfalse
.See also
- PySide2.QtCore.QUrl.password([arg__1=QUrl.FullyDecoded])¶
- Parameters:
arg__1 –
ComponentFormattingOptions
- Return type:
str
Returns the password of the URL if it is defined; otherwise an empty string is returned.
The
options
argument controls how to format the user name component. All values produce an unambiguous result. WithFullyDecoded
, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form inQString
.Note that
FullyDecoded
may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context, such as setting inQAuthenticator
or negotiating a login.See also
- PySide2.QtCore.QUrl.path([options=QUrl.FullyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Returns the path of the URL.
qDebug() << QUrl("file:file.txt").path(); // "file.txt" qDebug() << QUrl("/home/user/file.txt").path(); // "/home/user/file.txt" qDebug() << QUrl("http://www.example.com/test/123").path(); // "/test/123"
The
options
argument controls how to format the path component. All values produce an unambiguous result. WithFullyDecoded
, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form inQString
.Note that
FullyDecoded
may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context, such as sending to an FTP server.An example of data loss is when you have non-Unicode percent-encoded sequences and use
FullyDecoded
(the default):qDebug() << QUrl("/foo%FFbar").path();
In this example, there will be some level of data loss because the
%FF
cannot be converted.Data loss can also occur when the path contains sub-delimiters (such as
+
):qDebug() << QUrl("/foo+bar%2B").path(); // "/foo+bar+"
Other decoding examples:
const QUrl url("/tmp/Mambo %235%3F.mp3"); qDebug() << url.path(QUrl::FullyDecoded); // "/tmp/Mambo #5?.mp3" qDebug() << url.path(QUrl::PrettyDecoded); // "/tmp/Mambo #5?.mp3" qDebug() << url.path(QUrl::FullyEncoded); // "/tmp/Mambo%20%235%3F.mp3"
See also
- PySide2.QtCore.QUrl.port([defaultPort=-1])¶
- Parameters:
defaultPort – int
- Return type:
int
Returns the port of the URL, or
defaultPort
if the port is unspecified.Example:
ftp = QFtp() ftp.connectToHost(url.host(), url.port(21))
See also
- PySide2.QtCore.QUrl.query([arg__1=QUrl.PrettyDecoded])¶
- Parameters:
arg__1 –
ComponentFormattingOptions
- Return type:
str
Returns the query string of the URL if there’s a query string, or an empty result if not. To determine if the parsed URL contained a query string, use
hasQuery()
.The
options
argument controls how to format the query component. All values produce an unambiguous result. WithFullyDecoded
, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form inQString
.Note that use of
FullyDecoded
in queries is discouraged, as queries often contain data that is supposed to remain percent-encoded, including the use of the “%2B” sequence to represent a plus character (‘+’).See also
- PySide2.QtCore.QUrl.resolved(relative)¶
- Parameters:
relative –
PySide2.QtCore.QUrl
- Return type:
Returns the result of the merge of this URL with
relative
. This URL is used as a base to convertrelative
to an absolute URL.If
relative
is not a relative URL, this function will returnrelative
directly. Otherwise, the paths of the two URLs are merged, and the new URL returned has the scheme and authority of the base URL, but with the merged path, as in the following example:baseUrl = QUrl("http://qtsoftware.com/support") relativeUrl = QUrl("../products/solutions") print baseUrl.resolved(relativeUrl).toString() # prints "http://qtsoftware.com/products/solutions"
Calling with “..” returns a
QUrl
whose directory is one level higher than the original. Similarly, calling with “../..” removes two levels from the path. Ifrelative
is “/”, the path becomes “/”.See also
- PySide2.QtCore.QUrl.scheme()¶
- Return type:
str
Returns the scheme of the URL. If an empty string is returned, this means the scheme is undefined and the URL is then relative.
The scheme can only contain US-ASCII letters or digits, which means it cannot contain any character that would otherwise require encoding. Additionally, schemes are always returned in lowercase form.
See also
- PySide2.QtCore.QUrl.setAuthority(authority[, mode=TolerantMode])¶
- Parameters:
authority – str
mode –
ParsingMode
Sets the authority of the URL to
authority
.The authority of a URL is the combination of user info, a host name and a port. All of these elements are optional; an empty authority is therefore valid.
The user info and host are separated by a ‘@’, and the host and port are separated by a ‘:’. If the user info is empty, the ‘@’ must be omitted; although a stray ‘:’ is permitted if the port is empty.
The following example shows a valid authority string:
The
authority
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
(the default), all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters.This function does not allow
mode
to beDecodedMode
. To set fully decoded data, callsetUserName()
,setPassword()
,setHost()
andsetPort()
individually.See also
- PySide2.QtCore.QUrl.setFragment(fragment[, mode=TolerantMode])¶
- Parameters:
fragment – str
mode –
ParsingMode
Sets the fragment of the URL to
fragment
. The fragment is the last part of the URL, represented by a ‘#’ followed by a string of characters. It is typically used in HTTP for referring to a certain link or point on a page:The fragment is sometimes also referred to as the URL “reference”.
Passing an argument of QString() (a null
QString
) will unset the fragment. Passing an argument ofQString
(“”) (an empty but not nullQString
) will set the fragment to an empty string (as if the original URL had a lone “#”).The
fragment
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
, all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters. InDecodedMode
, ‘%’ stand for themselves and encoded characters are not possible.DecodedMode
should be used when setting the fragment from a data source which is not a URL or with a fragment obtained by callingfragment()
with theFullyDecoded
formatting option.See also
- PySide2.QtCore.QUrl.setHost(host[, mode=DecodedMode])¶
- Parameters:
host – str
mode –
ParsingMode
Sets the host of the URL to
host
. The host is part of the authority.The
host
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
, all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters. InDecodedMode
, ‘%’ stand for themselves and encoded characters are not possible.Note that, in all cases, the result of the parsing must be a valid hostname according to STD 3 rules, as modified by the Internationalized Resource Identifiers specification (RFC 3987). Invalid hostnames are not permitted and will cause
isValid()
to become false.See also
- static PySide2.QtCore.QUrl.setIdnWhitelist(arg__1)¶
- Parameters:
arg__1 – list of strings
Sets the whitelist of Top-Level Domains (TLDs) that are allowed to have non-ASCII characters in domains to the value of
list
.Note that if you call this function, you need to do so before you start any threads that might access
idnWhitelist()
.Qt comes with a default list that contains the Internet top-level domains that have published support for Internationalized Domain Names (IDNs) and rules to guarantee that no deception can happen between similarly-looking characters (such as the Latin lowercase letter
'a'
and the Cyrillic equivalent, which in most fonts are visually identical).This list is periodically maintained, as registrars publish new rules.
This function is provided for those who need to manipulate the list, in order to add or remove a TLD. It is not recommended to change its value for purposes other than testing, as it may expose users to security risks.
See also
- PySide2.QtCore.QUrl.setPassword(password[, mode=DecodedMode])¶
- Parameters:
password – str
mode –
ParsingMode
Sets the URL’s password to
password
. Thepassword
is part of the user info element in the authority of the URL, as described insetUserInfo()
.The
password
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
, all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters. InDecodedMode
, ‘%’ stand for themselves and encoded characters are not possible.DecodedMode
should be used when setting the password from a data source which is not a URL, such as a password dialog shown to the user or with a password obtained by callingpassword()
with theFullyDecoded
formatting option.See also
- PySide2.QtCore.QUrl.setPath(path[, mode=DecodedMode])¶
- Parameters:
path – str
mode –
ParsingMode
Sets the path of the URL to
path
. The path is the part of the URL that comes after the authority but before the query string.For non-hierarchical schemes, the path will be everything following the scheme declaration, as in the following example:
The
path
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
, all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters. InDecodedMode
, ‘%’ stand for themselves and encoded characters are not possible.DecodedMode
should be used when setting the path from a data source which is not a URL, such as a dialog shown to the user or with a path obtained by callingpath()
with theFullyDecoded
formatting option.See also
- PySide2.QtCore.QUrl.setPort(port)¶
- Parameters:
port – int
Sets the port of the URL to
port
. The port is part of the authority of the URL, as described insetAuthority()
.port
must be between 0 and 65535 inclusive. Setting the port to -1 indicates that the port is unspecified.See also
- PySide2.QtCore.QUrl.setQuery(query)¶
- Parameters:
query –
PySide2.QtCore.QUrlQuery
This is an overloaded function.
Sets the query string of the URL to
query
.This function reconstructs the query string from the
QUrlQuery
object and sets on thisQUrl
object. This function does not have parsing parameters because theQUrlQuery
contains data that is already parsed.See also
- PySide2.QtCore.QUrl.setQuery(query[, mode=TolerantMode])
- Parameters:
query – str
mode –
ParsingMode
Sets the query string of the URL to
query
.This function is useful if you need to pass a query string that does not fit into the key-value pattern, or that uses a different scheme for encoding special characters than what is suggested by
QUrl
.Passing a value of QString() to
query
(a nullQString
) unsets the query completely. However, passing a value ofQString
(“”) will set the query to an empty value, as if the original URL had a lone “?”.The
query
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
, all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters. InDecodedMode
, ‘%’ stand for themselves and encoded characters are not possible.Query strings often contain percent-encoded sequences, so use of
DecodedMode
is discouraged. One special sequence to be aware of is that of the plus character (‘+’).QUrl
does not convert spaces to plus characters, even though HTML forms posted by web browsers do. In order to represent an actual plus character in a query, the sequence “%2B” is usually used. This function will leave “%2B” sequences untouched inTolerantMode
orStrictMode
.See also
- PySide2.QtCore.QUrl.setScheme(scheme)¶
- Parameters:
scheme – str
Sets the scheme of the URL to
scheme
. As a scheme can only contain ASCII characters, no conversion or decoding is done on the input. It must also start with an ASCII letter.The scheme describes the type (or protocol) of the URL. It’s represented by one or more ASCII characters at the start the URL.
A scheme is strictly RFC 3986 -compliant:
scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
The following example shows a URL where the scheme is “ftp”:
To set the scheme, the following call is used:
QUrl url; url.setScheme("ftp");
The scheme can also be empty, in which case the URL is interpreted as relative.
See also
- PySide2.QtCore.QUrl.setUrl(url[, mode=TolerantMode])¶
- Parameters:
url – str
mode –
ParsingMode
Parses
url
and sets this object to that value.QUrl
will automatically percent encode all characters that are not allowed in a URL and decode the percent-encoded sequences that represent an unreserved character (letters, digits, hyphens, undercores, dots and tildes). All other characters are left in their original forms.Parses the
url
using the parser modeparsingMode
. InTolerantMode
(the default),QUrl
will correct certain mistakes, notably the presence of a percent character (‘%’) not followed by two hexadecimal digits, and it will accept any character in any position. InStrictMode
, encoding mistakes will not be tolerated andQUrl
will also check that certain forbidden characters are not present in unencoded form. If an error is detected inStrictMode
,isValid()
will return false. The parsing modeDecodedMode
is not permitted in this context and will produce a run-time warning.See also
- PySide2.QtCore.QUrl.setUserInfo(userInfo[, mode=TolerantMode])¶
- Parameters:
userInfo – str
mode –
ParsingMode
Sets the user info of the URL to
userInfo
. The user info is an optional part of the authority of the URL, as described insetAuthority()
.The user info consists of a user name and optionally a password, separated by a ‘:’. If the password is empty, the colon must be omitted. The following example shows a valid user info string:
The
userInfo
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
(the default), all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters.This function does not allow
mode
to beDecodedMode
. To set fully decoded data, callsetUserName()
andsetPassword()
individually.
- PySide2.QtCore.QUrl.setUserName(userName[, mode=DecodedMode])¶
- Parameters:
userName – str
mode –
ParsingMode
Sets the URL’s user name to
userName
. TheuserName
is part of the user info element in the authority of the URL, as described insetUserInfo()
.The
userName
data is interpreted according tomode
: inStrictMode
, any ‘%’ characters must be followed by exactly two hexadecimal characters and some characters (including space) are not allowed in undecoded form. InTolerantMode
(the default), all characters are accepted in undecoded form and the tolerant parser will correct stray ‘%’ not followed by two hex characters. InDecodedMode
, ‘%’ stand for themselves and encoded characters are not possible.DecodedMode
should be used when setting the user name from a data source which is not a URL, such as a password dialog shown to the user or with a user name obtained by callinguserName()
with theFullyDecoded
formatting option.See also
- PySide2.QtCore.QUrl.swap(other)¶
- Parameters:
other –
PySide2.QtCore.QUrl
Swaps URL
other
with this URL. This operation is very fast and never fails.
- static PySide2.QtCore.QUrl.toAce(arg__1)¶
- Parameters:
arg__1 – str
- Return type:
Returns the ASCII Compatible Encoding of the given domain name
domain
. The result of this function is considered equivalent todomain
.The ASCII-Compatible Encoding (ACE) is defined by RFC 3490, RFC 3491 and RFC 3492. It is part of the Internationalizing Domain Names in Applications (IDNA) specification, which allows for domain names (like
"example.com"
) to be written using international characters.This function returns an empty
QByteArray
ifdomain
is not a valid hostname. Note, in particular, that IPv6 literals are not valid domain names.
- PySide2.QtCore.QUrl.toDisplayString([options=QUrl.FormattingOptions(PrettyDecoded)])¶
- Parameters:
options –
FormattingOptions
- Return type:
str
Returns a human-displayable string representation of the URL. The output can be customized by passing flags with
options
. The optionRemovePassword
is always enabled, since passwords should never be shown back to users.With the default options, the resulting
QString
can be passed back to aQUrl
later on, but any password that was present initially will be lost.See also
FormattingOptions
toEncoded()
toString()
- PySide2.QtCore.QUrl.toEncoded([options=QUrl.FullyEncoded])¶
- Parameters:
options –
FormattingOptions
- Return type:
Returns the encoded representation of the URL if it’s valid; otherwise an empty
QByteArray
is returned. The output can be customized by passing flags withoptions
.The user info, path and fragment are all converted to UTF-8, and all non-ASCII characters are then percent encoded. The host name is encoded using Punycode.
- PySide2.QtCore.QUrl.toLocalFile()¶
- Return type:
str
Returns the path of this URL formatted as a local file path. The path returned will use forward slashes, even if it was originally created from one with backslashes.
If this URL contains a non-empty hostname, it will be encoded in the returned value in the form found on SMB networks (for example, “//servername/path/to/file.txt”).
qDebug() << QUrl("file:file.txt").toLocalFile(); // "file.txt" qDebug() << QUrl("file:/home/user/file.txt").toLocalFile(); // "/home/user/file.txt" qDebug() << QUrl("file.txt").toLocalFile(); // ""; wasn't a local file as it had no scheme
Note: if the path component of this URL contains a non-UTF-8 binary sequence (such as %80), the behaviour of this function is undefined.
See also
- static PySide2.QtCore.QUrl.toPercentEncoding(arg__1[, exclude=QByteArray()[, include=QByteArray()]])¶
- Parameters:
arg__1 – str
exclude –
PySide2.QtCore.QByteArray
include –
PySide2.QtCore.QByteArray
- Return type:
Returns an encoded copy of
input
.input
is first converted to UTF-8, and all ASCII-characters that are not in the unreserved group are percent encoded. To prevent characters from being percent encoded pass them toexclude
. To force characters to be percent encoded pass them toinclude
.Unreserved is defined as:
ALPHA / DIGIT / "-" / "." / "_" / "~"
ba = QUrl.toPercentEncoding("{a fishy string?}", "{}", "s") print ba # prints "{a fi%73hy %73tring%3F}"
- PySide2.QtCore.QUrl.toString([options=QUrl.FormattingOptions(PrettyDecoded)])¶
- Parameters:
options –
FormattingOptions
- Return type:
str
Returns a string representation of the URL. The output can be customized by passing flags with
options
. The optionFullyDecoded
is not permitted in this function since it would generate ambiguous data.The default formatting option is
PrettyDecoded
.
- static PySide2.QtCore.QUrl.toStringList(uris[, options=QUrl.FormattingOptions(PrettyDecoded)])¶
- Parameters:
uris –
options –
FormattingOptions
- Return type:
list of strings
Converts a list of
urls
into a list ofQString
objects, usingtoString
(options
).
- PySide2.QtCore.QUrl.topLevelDomain([options=QUrl.FullyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Note
This function is deprecated.
Returns the TLD (Top-Level Domain) of the URL, (e.g. .co.uk, .net). Note that the return value is prefixed with a ‘.’ unless the URL does not contain a valid TLD, in which case the function returns an empty string.
Note that this function considers a TLD to be any domain that allows users to register subdomains under, including many home, dynamic DNS websites and blogging providers. This is useful for determining whether two websites belong to the same infrastructure and communication should be allowed, such as browser cookies: two domains should be considered part of the same website if they share at least one label in addition to the value returned by this function.
foo.co.uk
andfoo.com
do not share a top-level domainfoo.co.uk
andbar.co.uk
share the.co.uk
domain, but the next label is differentwww.foo.co.uk
andftp.foo.co.uk
share the same top-level domain and one more label, so they are considered part of the same site
If
options
includesEncodeUnicode
, the returned string will be in ASCII Compatible Encoding.
- PySide2.QtCore.QUrl.url([options=QUrl.FormattingOptions(PrettyDecoded)])¶
- Parameters:
options –
FormattingOptions
- Return type:
str
Returns a string representation of the URL. The output can be customized by passing flags with
options
. The optionFullyDecoded
is not permitted in this function since it would generate ambiguous data.The resulting
QString
can be passed back to aQUrl
later on.Synonym for
toString
(options).See also
setUrl()
FormattingOptions
toEncoded()
toString()
- PySide2.QtCore.QUrl.userInfo([options=QUrl.PrettyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Returns the user info of the URL, or an empty string if the user info is undefined.
This function returns an unambiguous value, which may contain that characters still percent-encoded, plus some control sequences not representable in decoded form in
QString
.The
options
argument controls how to format the user info component. The value ofFullyDecoded
is not permitted in this function. If you need to obtain fully decoded data, calluserName()
andpassword()
individually.See also
- PySide2.QtCore.QUrl.userName([options=QUrl.FullyDecoded])¶
- Parameters:
options –
ComponentFormattingOptions
- Return type:
str
Returns the user name of the URL if it is defined; otherwise an empty string is returned.
The
options
argument controls how to format the user name component. All values produce an unambiguous result. WithFullyDecoded
, all percent-encoded sequences are decoded; otherwise, the returned value may contain some percent-encoded sequences for some control sequences not representable in decoded form inQString
.Note that
FullyDecoded
may cause data loss if those non-representable sequences are present. It is recommended to use that value when the result will be used in a non-URL context, such as setting inQAuthenticator
or negotiating a login.See also
© 2022 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.