GLib.Uri

Fields

None

Methods

class	build (flags, scheme, userinfo, host, port, path, query, fragment)
class	build_with_user (flags, scheme, user, password, auth_params, host, port, path, query, fragment)
class	error_quark ()
class	escape_bytes (unescaped, reserved_chars_allowed)
class	escape_string (unescaped, reserved_chars_allowed, allow_utf8)
class	is_valid (uri_string, flags)
class	join (flags, scheme, userinfo, host, port, path, query, fragment)
class	join_with_user (flags, scheme, user, password, auth_params, host, port, path, query, fragment)
class	list_extract_uris (uri_list)
class	parse (uri_string, flags)
class	parse_params (params, length, separators, flags)
class	parse_scheme (uri)
class	peek_scheme (uri)
class	resolve_relative (base_uri_string, uri_ref, flags)
class	split (uri_ref, flags)
class	split_network (uri_string, flags)
class	split_with_user (uri_ref, flags)
class	unescape_bytes (escaped_string, length, illegal_characters)
class	unescape_segment (escaped_string, escaped_string_end, illegal_characters)
class	unescape_string (escaped_string, illegal_characters)
	get_auth_params ()
	get_flags ()
	get_fragment ()
	get_host ()
	get_password ()
	get_path ()
	get_port ()
	get_query ()
	get_scheme ()
	get_user ()
	get_userinfo ()
	parse_relative (uri_ref, flags)
	to_string ()
	to_string_partial (flags)

Details

class GLib.Uri

The GUri type and related functions can be used to parse URIs into their components, and build valid URIs from individual components.

Since GUri only represents absolute URIs, all GUri``s will have a URI scheme, so [method`GLib`.Uri.get\_scheme] will always return a non-``NULL answer. Likewise, by definition, all URIs have a path component, so [method`GLib`.Uri.get_path] will always return a non-NULL string (which may be empty).

If the URI string has an ‘authority’ component (that is, if the scheme is followed by :// rather than just :), then the GUri will contain a hostname, and possibly a port and ‘userinfo’. Additionally, depending on how the GUri was constructed/parsed (for example, using the G_URI_FLAGS_HAS_PASSWORD and G_URI_FLAGS_HAS_AUTH_PARAMS flags), the userinfo may be split out into a username, password, and additional authorization-related parameters.

Normally, the components of a GUri will have all %-encoded characters decoded. However, if you construct/parse a GUri with G_URI_FLAGS_ENCODED, then the %-encoding will be preserved instead in the userinfo, path, and query fields (and in the host field if also created with G_URI_FLAGS_NON_DNS). In particular, this is necessary if the URI may contain binary data or non-UTF-8 text, or if decoding the components might change the interpretation of the URI.

For example, with the encoded flag:

``c g_autoptr(GUri) uri = g_uri_parse (”http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue”, G_URI_FLAGS_ENCODED, &err); g_assert_cmpstr (g_uri_get_query (uri), ==, “query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue”); ``

While the default %-decoding behaviour would give:

``c g_autoptr(GUri) uri = g_uri_parse (”http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue”, G_URI_FLAGS_NONE, &err); g_assert_cmpstr (g_uri_get_query (uri), ==, “query=http://host/path?param=value”); ``

During decoding, if an invalid UTF-8 string is encountered, parsing will fail with an error indicating the bad string location:

``c g_autoptr(GUri) uri = g_uri_parse (”http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fbad%3D%00alue”, G_URI_FLAGS_NONE, &err); g_assert_error (err, G_URI_ERROR, G_URI_ERROR_BAD_QUERY); ``

You should pass G_URI_FLAGS_ENCODED or G_URI_FLAGS_ENCODED_QUERY if you need to handle that case manually. In particular, if the query string contains = characters that are %-encoded, you should let [func`GLib`.Uri.parse_params] do the decoding once of the query.

GUri is immutable once constructed, and can safely be accessed from multiple threads. Its reference counting is atomic.

Note that the scope of GUri is to help manipulate URIs in various applications, following RFC 3986. In particular, it doesn’t intend to cover web browser needs, and doesn’t implement the WHATWG URL standard. No APIs are provided to help prevent homograph attacks, so GUri is not suitable for formatting URIs for display to the user for making security-sensitive decisions.

Relative and absolute URIs

As defined in RFC 3986, the hierarchical nature of URIs means that they can either be ‘relative references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for clarity, ‘URIs’ are referred to in this documentation as ‘absolute URIs’ — although in constrast to RFC 3986, fragment identifiers are always allowed).

Relative references have one or more components of the URI missing. In particular, they have no scheme. Any other component, such as hostname, query, etc. may be missing, apart from a path, which has to be specified (but may be empty). The path may be relative, starting with ./ rather than /.

For example, a valid relative reference is ./path?query, /?query#fragment or //example.com.

Absolute URIs have a scheme specified. Any other components of the URI which are missing are specified as explicitly unset in the URI, rather than being resolved relative to a base URI using [method`GLib`.Uri.parse_relative].

For example, a valid absolute URI is file:///home/bob or https://search.com?query=string.

A GUri instance is always an absolute URI. A string may be an absolute URI or a relative reference; see the documentation for individual functions as to what forms they accept.

Parsing URIs

The most minimalist APIs for parsing URIs are [func`GLib`.Uri.split] and [func`GLib`.Uri.split_with_user]. These split a URI into its component parts, and return the parts; the difference between the two is that [func`GLib`.Uri.split] treats the ‘userinfo’ component of the URI as a single element, while [func`GLib`.Uri.split_with_user] can (depending on the [flags`GLib`.UriFlags] you pass) treat it as containing a username, password, and authentication parameters. Alternatively, [func`GLib`.Uri.split_network] can be used when you are only interested in the components that are needed to initiate a network connection to the service (scheme, host, and port).

[func`GLib`.Uri.parse] is similar to [func`GLib`.Uri.split], but instead of returning individual strings, it returns a GUri structure (and it requires that the URI be an absolute URI).

[func`GLib`.Uri.resolve_relative] and [method`GLib`.Uri.parse_relative] allow you to resolve a relative URI relative to a base URI. [func`GLib`.Uri.resolve_relative] takes two strings and returns a string, and [method`GLib`.Uri.parse_relative] takes a GUri and a string and returns a GUri.

All of the parsing functions take a [flags`GLib`.UriFlags] argument describing exactly how to parse the URI; see the documentation for that type for more details on the specific flags that you can pass. If you need to choose different flags based on the type of URI, you can use [func`GLib`.Uri.peek_scheme] on the URI string to check the scheme first, and use that to decide what flags to parse it with.

For example, you might want to use G_URI_PARAMS_WWW_FORM when parsing the params for a web URI, so compare the result of [func`GLib`.Uri.peek_scheme] against http and https.

Building URIs

[func`GLib`.Uri.join] and [func`GLib`.Uri.join_with_user] can be used to construct valid URI strings from a set of component strings. They are the inverse of [func`GLib`.Uri.split] and [func`GLib`.Uri.split_with_user].

Similarly, [func`GLib`.Uri.build] and [func`GLib`.Uri.build_with_user] can be used to construct a GUri from a set of component strings.

As with the parsing functions, the building functions take a [flags`GLib`.UriFlags] argument. In particular, it is important to keep in mind whether the URI components you are using are already %-encoded. If so, you must pass the G_URI_FLAGS_ENCODED flag.

file:// URIs

Note that Windows and Unix both define special rules for parsing file:// URIs (involving non-UTF-8 character sets on Unix, and the interpretation of path separators on Windows). GUri does not implement these rules. Use [func`GLib`.filename_from_uri] and [func`GLib`.filename_to_uri] if you want to properly convert between file:// URIs and local filenames.

URI Equality

Note that there is no g_uri_equal () function, because comparing URIs usefully requires scheme-specific knowledge that GUri does not have. GUri can help with normalization if you use the various encoded [flags`GLib`.UriFlags] as well as G_URI_FLAGS_SCHEME_NORMALIZE however it is not comprehensive. For example, data:,foo and data:;base64,Zm9v resolve to the same thing according to the data: URI specification which GLib does not handle.

New in version 2.66.

classmethod build(flags, scheme, userinfo, host, port, path, query, fragment)

Parameters:

• flags (GLib.UriFlags) – flags describing how to build the GLib.Uri

• scheme (str) – the URI scheme

• userinfo (str or None) – the userinfo component, or None

• host (str or None) – the host component, or None

• port (int) – the port, or -1

• path (str) – the path component

• query (str or None) – the query component, or None

• fragment (str or None) – the fragment, or None

Returns:

a new GLib.Uri

Return type:

GLib.Uri

Creates a new GLib.Uri from the given components according to flags.

See also GLib.Uri.build_with_user(), which allows specifying the components of the “userinfo” separately.

New in version 2.66.

classmethod build_with_user(flags, scheme, user, password, auth_params, host, port, path, query, fragment)

Parameters:

• flags (GLib.UriFlags) – flags describing how to build the GLib.Uri

• scheme (str) – the URI scheme

• user (str or None) – the user component of the userinfo, or None

• password (str or None) – the password component of the userinfo, or None

• auth_params (str or None) – the auth params of the userinfo, or None

• host (str or None) – the host component, or None

• port (int) – the port, or -1

• path (str) – the path component

• query (str or None) – the query component, or None

• fragment (str or None) – the fragment, or None

Returns:

a new GLib.Uri

Return type:

GLib.Uri

Creates a new GLib.Uri from the given components according to flags (GLib.UriFlags.HAS_PASSWORD is added unconditionally). The flags must be coherent with the passed values, in particular use %-encoded values with GLib.UriFlags.ENCODED.

In contrast to GLib.Uri.build(), this allows specifying the components of the ‘userinfo’ field separately. Note that user must be non-None if either password or auth_params is non-None.

New in version 2.66.

classmethod error_quark()

Return type:

int

classmethod escape_bytes(unescaped, reserved_chars_allowed)

Parameters:

• unescaped (bytes) – the unescaped input data.

• reserved_chars_allowed (str or None) – a string of reserved characters that are allowed to be used, or None.

Returns:

an escaped version of unescaped. The returned string should be freed when no longer needed.

Return type:

str

Escapes arbitrary data for use in a URI.

Normally all characters that are not ‘unreserved’ (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in reserved_chars_allowed they are not escaped. This is useful for the ‘reserved’ characters in the URI specification, since those are allowed unescaped in some portions of a URI.

Though technically incorrect, this will also allow escaping nul bytes as `%` 00.

New in version 2.66.

classmethod escape_string(unescaped, reserved_chars_allowed, allow_utf8)

Parameters:

• unescaped (str) – the unescaped input string.

• reserved_chars_allowed (str or None) – a string of reserved characters that are allowed to be used, or None.

• allow_utf8 (bool) – True if the result can include UTF-8 characters.

Returns:

an escaped version of unescaped. The returned string should be freed when no longer needed.

Return type:

str

Escapes a string for use in a URI.

Normally all characters that are not “unreserved” (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in reserved_chars_allowed they are not escaped. This is useful for the “reserved” characters in the URI specification, since those are allowed unescaped in some portions of a URI.

New in version 2.16.

classmethod is_valid(uri_string, flags)

Parameters:

• uri_string (str) – a string containing an absolute URI

• flags (GLib.UriFlags) – flags for parsing uri_string

Raises:

GLib.Error

Returns:

True if uri_string is a valid absolute URI, False on error.

Return type:

bool

Parses uri_string according to flags, to determine whether it is a valid absolute URI, i.e. it does not need to be resolved relative to another URI using GLib.Uri.parse_relative().

If it’s not a valid URI, an error is returned explaining how it’s invalid.

See GLib.Uri.split(), and the definition of GLib.UriFlags, for more information on the effect of flags.

New in version 2.66.

classmethod join(flags, scheme, userinfo, host, port, path, query, fragment)

Parameters:

• flags (GLib.UriFlags) – flags describing how to build the URI string

• scheme (str or None) – the URI scheme, or None

• userinfo (str or None) – the userinfo component, or None

• host (str or None) – the host component, or None

• port (int) – the port, or -1

• path (str) – the path component

• query (str or None) – the query component, or None

• fragment (str or None) – the fragment, or None

Returns:

an absolute URI string

Return type:

str

Joins the given components together according to flags to create an absolute URI string. path may not be None (though it may be the empty string).

When host is present, path must either be empty or begin with a slash (/) character. When host is not present, path cannot begin with two slash characters (//). See RFC 3986, section 3.

See also GLib.Uri.join_with_user(), which allows specifying the components of the ‘userinfo’ separately.

GLib.UriFlags.HAS_PASSWORD and GLib.UriFlags.HAS_AUTH_PARAMS are ignored if set in flags.

New in version 2.66.

classmethod join_with_user(flags, scheme, user, password, auth_params, host, port, path, query, fragment)

Parameters:

• flags (GLib.UriFlags) – flags describing how to build the URI string

• scheme (str or None) – the URI scheme, or None

• user (str or None) – the user component of the userinfo, or None

• password (str or None) – the password component of the userinfo, or None

• auth_params (str or None) – the auth params of the userinfo, or None

• host (str or None) – the host component, or None

• port (int) – the port, or -1

• path (str) – the path component

• query (str or None) – the query component, or None

• fragment (str or None) – the fragment, or None

Returns:

an absolute URI string

Return type:

str

Joins the given components together according to flags to create an absolute URI string. path may not be None (though it may be the empty string).

In contrast to GLib.Uri.join(), this allows specifying the components of the ‘userinfo’ separately. It otherwise behaves the same.

GLib.UriFlags.HAS_PASSWORD and GLib.UriFlags.HAS_AUTH_PARAMS are ignored if set in flags.

New in version 2.66.

classmethod list_extract_uris(uri_list)

Parameters:

uri_list (str) – an URI list

Returns:

a newly allocated None-terminated list of strings holding the individual URIs. The array should be freed with GLib.strfreev().

Return type:

[str]

Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated.

New in version 2.6.

classmethod parse(uri_string, flags)

Parameters:

• uri_string (str) – a string representing an absolute URI

• flags (GLib.UriFlags) – flags describing how to parse uri_string

Raises:

GLib.Error

Returns:

a new GLib.Uri, or None on error.

Return type:

GLib.Uri

Parses uri_string according to flags. If the result is not a valid absolute URI, it will be discarded, and an error returned.

New in version 2.66.

classmethod parse_params(params, length, separators, flags)

Parameters:

• params (str) – a %-encoded string containing attribute=value parameters

• length (int) – the length of params, or -1 if it is nul-terminated

• separators (str) – the separator byte character set between parameters. (usually &, but sometimes ; or both &;). Note that this function works on bytes not characters, so it can’t be used to delimit UTF-8 strings for anything but ASCII characters. You may pass an empty set, in which case no splitting will occur.

• flags (GLib.UriParamsFlags) – flags to modify the way the parameters are handled.

Raises:

GLib.Error

Returns:

A hash table of attribute/value pairs, with both names and values fully-decoded; or None on error.

Return type:

{str: str}

Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use GLib.UriParamsIter.

The params string is assumed to still be %-encoded, but the returned values will be fully decoded. (Thus it is possible that the returned values may contain = or separators, if the value was encoded in the input.) Invalid %-encoding is treated as with the GLib.UriFlags.PARSE_RELAXED rules for GLib.Uri.parse(). (However, if params is the path or query string from a GLib.Uri that was parsed without GLib.UriFlags.PARSE_RELAXED and GLib.UriFlags.ENCODED, then you already know that it does not contain any invalid encoding.)

GLib.UriParamsFlags.WWW_FORM is handled as documented for GLib.UriParamsIter.init().

If GLib.UriParamsFlags.CASE_INSENSITIVE is passed to flags, attributes will be compared case-insensitively, so a params string attr=123&Attr=456 will only return a single attribute–value pair, Attr=456. Case will be preserved in the returned attributes.

If params cannot be parsed (for example, it contains two separators characters in a row), then error is set and None is returned.

New in version 2.66.

classmethod parse_scheme(uri)

Parameters:

uri (str) – a valid URI.

Returns:

The ‘scheme’ component of the URI, or None on error. The returned string should be freed when no longer needed.

Return type:

str or None

Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as:

URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

Common schemes include file, https, svn+ssh, etc.

New in version 2.16.

classmethod peek_scheme(uri)

Parameters:

uri (str) – a valid URI.

Returns:

The ‘scheme’ component of the URI, or None on error. The returned string is normalized to all-lowercase, and interned via GLib.intern_string(), so it does not need to be freed.

Return type:

str or None

Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as:

URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]

Common schemes include file, https, svn+ssh, etc.

Unlike GLib.Uri.parse_scheme(), the returned scheme is normalized to all-lowercase and does not need to be freed.

New in version 2.66.

classmethod resolve_relative(base_uri_string, uri_ref, flags)

Parameters:

• base_uri_string (str or None) – a string representing a base URI

• uri_ref (str) – a string representing a relative or absolute URI

• flags (GLib.UriFlags) – flags describing how to parse uri_ref

Raises:

GLib.Error

Returns:

the resolved URI string, or None on error.

Return type:

str

Parses uri_ref according to flags and, if it is a relative URI, resolves it relative to base_uri_string. If the result is not a valid absolute URI, it will be discarded, and an error returned.

(If base_uri_string is None, this just returns uri_ref, or None if uri_ref is invalid or not absolute.)

New in version 2.66.

classmethod split(uri_ref, flags)

Parameters:

• uri_ref (str) – a string containing a relative or absolute URI

• flags (GLib.UriFlags) – flags for parsing uri_ref

Raises:

GLib.Error

Returns:

True if uri_ref parsed successfully, False on error.

scheme:

on return, contains the scheme (converted to lowercase), or None

userinfo:

on return, contains the userinfo, or None

host:

on return, contains the host, or None

port:

on return, contains the port, or -1

path:

on return, contains the path

query:

on return, contains the query, or None

fragment:

on return, contains the fragment, or None

Return type:

(bool, scheme: str or None, userinfo: str or None, host: str or None, port: int, path: str, query: str or None, fragment: str or None)

Parses uri_ref (which can be an absolute or relative URI) according to flags, and returns the pieces. Any component that doesn’t appear in uri_ref will be returned as None (but note that all URIs always have a path component, though it may be the empty string).

If flags contains GLib.UriFlags.ENCODED, then %-encoded characters in uri_ref will remain encoded in the output strings. (If not, then all such characters will be decoded.) Note that decoding will only work if the URI components are ASCII or UTF-8, so you will need to use GLib.UriFlags.ENCODED if they are not.

Note that the GLib.UriFlags.HAS_PASSWORD and GLib.UriFlags.HAS_AUTH_PARAMS flags are ignored by GLib.Uri.split(), since it always returns only the full userinfo; use GLib.Uri.split_with_user() if you want it split up.

New in version 2.66.

classmethod split_network(uri_string, flags)

Parameters:

• uri_string (str) – a string containing an absolute URI

• flags (GLib.UriFlags) – flags for parsing uri_string

Raises:

GLib.Error

Returns:

True if uri_string parsed successfully, False on error.

scheme:

on return, contains the scheme (converted to lowercase), or None

host:

on return, contains the host, or None

port:

on return, contains the port, or -1

Return type:

(bool, scheme: str or None, host: str or None, port: int)

Parses uri_string (which must be an absolute URI) according to flags, and returns the pieces relevant to connecting to a host. See the documentation for GLib.Uri.split() for more details; this is mostly a wrapper around that function with simpler arguments. However, it will return an error if uri_string is a relative URI, or does not contain a hostname component.

New in version 2.66.

classmethod split_with_user(uri_ref, flags)

Parameters:

• uri_ref (str) – a string containing a relative or absolute URI

• flags (GLib.UriFlags) – flags for parsing uri_ref

Raises:

GLib.Error

Returns:

True if uri_ref parsed successfully, False on error.

scheme:

on return, contains the scheme (converted to lowercase), or None

user:

on return, contains the user, or None

password:

on return, contains the password, or None

auth_params:

on return, contains the auth_params, or None

host:

on return, contains the host, or None

port:

on return, contains the port, or -1

path:

on return, contains the path

query:

on return, contains the query, or None

fragment:

on return, contains the fragment, or None

Return type:

(bool, scheme: str or None, user: str or None, password: str or None, auth_params: str or None, host: str or None, port: int, path: str, query: str or None, fragment: str or None)

Parses uri_ref (which can be an absolute or relative URI) according to flags, and returns the pieces. Any component that doesn’t appear in uri_ref will be returned as None (but note that all URIs always have a path component, though it may be the empty string).

See GLib.Uri.split(), and the definition of GLib.UriFlags, for more information on the effect of flags. Note that password will only be parsed out if flags contains GLib.UriFlags.HAS_PASSWORD, and auth_params will only be parsed out if flags contains GLib.UriFlags.HAS_AUTH_PARAMS.

New in version 2.66.

classmethod unescape_bytes(escaped_string, length, illegal_characters)

Parameters:

• escaped_string (str) – A URI-escaped string

• length (int) – the length (in bytes) of escaped_string to escape, or -1 if it is nul-terminated.

• illegal_characters (str or None) – a string of illegal characters not to be allowed, or None.

Raises:

GLib.Error

Returns:

an unescaped version of escaped_string or None on error (if decoding failed, using GLib.UriError.FAILED error code). The returned GLib.Bytes should be unreffed when no longer needed.

Return type:

GLib.Bytes

Unescapes a segment of an escaped string as binary data.

Note that in contrast to GLib.Uri.unescape_string(), this does allow nul bytes to appear in the output.

If any of the characters in illegal_characters appears as an escaped character in escaped_string, then that is an error and None will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

New in version 2.66.

classmethod unescape_segment(escaped_string, escaped_string_end, illegal_characters)

Parameters:

• escaped_string (str or None) – A string, may be None

• escaped_string_end (str or None) – Pointer to end of escaped_string, may be None

• illegal_characters (str or None) – An optional string of illegal characters not to be allowed, may be None

Returns:

an unescaped version of escaped_string, or None on error. The returned string should be freed when no longer needed. As a special case if None is given for escaped_string, this function will return None.

Return type:

str or None

Unescapes a segment of an escaped string.

If any of the characters in illegal_characters or the NUL character appears as an escaped character in escaped_string, then that is an error and None will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

Note: NUL byte is not accepted in the output, in contrast to GLib.Uri.unescape_bytes().

New in version 2.16.

classmethod unescape_string(escaped_string, illegal_characters)

Parameters:

• escaped_string (str) – an escaped string to be unescaped.

• illegal_characters (str or None) – a string of illegal characters not to be allowed, or None.

Returns:

an unescaped version of escaped_string. The returned string should be freed when no longer needed.

Return type:

str or None

Unescapes a whole escaped string.

If any of the characters in illegal_characters or the NUL character appears as an escaped character in escaped_string, then that is an error and None will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

New in version 2.16.

get_auth_params()

Returns:

self's authentication parameters.

Return type:

str or None

Gets self's authentication parameters, which may contain %-encoding, depending on the flags with which self was created. (If self was not created with GLib.UriFlags.HAS_AUTH_PARAMS then this will be None.)

Depending on the URI scheme, GLib.Uri.parse_params() may be useful for further parsing this information.

New in version 2.66.

get_flags()

Returns:

self's flags.

Return type:

GLib.UriFlags

Gets self's flags set upon construction.

New in version 2.66.

get_fragment()

Returns:

self's fragment.

Return type:

str or None

Gets self's fragment, which may contain %-encoding, depending on the flags with which self was created.

New in version 2.66.

get_host()

Returns:

self's host.

Return type:

str or None

Gets self's host. This will never have %-encoded characters, unless it is non-UTF-8 (which can only be the case if self was created with GLib.UriFlags.NON_DNS).

If self contained an IPv6 address literal, this value will be just that address, without the brackets around it that are necessary in the string form of the URI. Note that in this case there may also be a scope ID attached to the address. Eg, `fe80::1234%` em1 (or `fe80::1234%` 25em1 if the string is still encoded).

New in version 2.66.

get_password()

Returns:

self's password.

Return type:

str or None

Gets self's password, which may contain %-encoding, depending on the flags with which self was created. (If self was not created with GLib.UriFlags.HAS_PASSWORD then this will be None.)

New in version 2.66.

get_path()

Returns:

self's path.

Return type:

str

Gets self's path, which may contain %-encoding, depending on the flags with which self was created.

New in version 2.66.

get_port()

Returns:

self's port, or -1 if no port was specified.

Return type:

int

Gets self's port.

New in version 2.66.

get_query()

Returns:

self's query.

Return type:

str or None

Gets self's query, which may contain %-encoding, depending on the flags with which self was created.

For queries consisting of a series of name=value parameters, GLib.UriParamsIter or GLib.Uri.parse_params() may be useful.

New in version 2.66.

get_scheme()

Returns:

self's scheme.

Return type:

str

Gets self's scheme. Note that this will always be all-lowercase, regardless of the string or strings that self was created from.

New in version 2.66.

get_user()

Returns:

self's user.

Return type:

str or None

Gets the ‘username’ component of self's userinfo, which may contain %-encoding, depending on the flags with which self was created. If self was not created with GLib.UriFlags.HAS_PASSWORD or GLib.UriFlags.HAS_AUTH_PARAMS, this is the same as GLib.Uri.get_userinfo().

New in version 2.66.

get_userinfo()

Returns:

self's userinfo.

Return type:

str or None

Gets self's userinfo, which may contain %-encoding, depending on the flags with which self was created.

New in version 2.66.

parse_relative(uri_ref, flags)

Parameters:

• uri_ref (str) – a string representing a relative or absolute URI

• flags (GLib.UriFlags) – flags describing how to parse uri_ref

Raises:

GLib.Error

Returns:

a new GLib.Uri, or None on error.

Return type:

GLib.Uri

Parses uri_ref according to flags and, if it is a relative URI, resolves it relative to self. If the result is not a valid absolute URI, it will be discarded, and an error returned.

New in version 2.66.

to_string()

Returns:

a string representing self, which the caller must free.

Return type:

str

Returns a string representing self.

This is not guaranteed to return a string which is identical to the string that self was parsed from. However, if the source URI was syntactically correct (according to RFC 3986), and it was parsed with GLib.UriFlags.ENCODED, then GLib.Uri.to_string() is guaranteed to return a string which is at least semantically equivalent to the source URI (according to RFC 3986).

If self might contain sensitive details, such as authentication parameters, or private data in its query string, and the returned string is going to be logged, then consider using GLib.Uri.to_string_partial() to redact parts.

New in version 2.66.

to_string_partial(flags)

Parameters:

flags (GLib.UriHideFlags) – flags describing what parts of self to hide

Returns:

a string representing self, which the caller must free.

Return type:

str

Returns a string representing self, subject to the options in flags. See GLib.Uri.to_string() and GLib.UriHideFlags for more details.

New in version 2.66.