URLSpec¶

class URLSpec¶

A container for a URL, e.g. “http://server:port/path”.

The URLSpec object is similar to a Filename in that it contains logic to identify the various parts of a URL and return (or modify) them separately.

Inheritance diagram

digraph inheritance6cbcb16ec2 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "URLSpec" [URL="acron.core.URLSpec.html#acron.core.URLSpec",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "URLSpec" [arrowsize=0.75,style=""]; }

URLSpec.__eq__()¶

URLSpec.__getitem__()¶

URLSpec.__init__()¶: Creates a URLSpec by appending a path to the end of the old URLSpec, inserting an intervening forward slash if necessary.

URLSpec.__lt__()¶

URLSpec.__ne__()¶

URLSpec.assign()¶

URLSpec.c_str()¶

URLSpec.compare_to()¶: Returns a number less than zero if this URLSpec sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent.

URLSpec.empty()¶: Returns false if the URLSpec is valid (not empty), or true if it is an empty string.

URLSpec.get_authority()¶: Returns the authority specified by the URL (this includes username, server, and/or port), or empty string if no authority is specified.

static URLSpec.get_default_port_for_scheme()¶: Returns the default port number for the indicated scheme, or 0 if there is no known default.

URLSpec.get_hash()¶

URLSpec.get_path()¶: Returns the path specified by the URL, or “/” if no path is specified.

URLSpec.get_path_and_query()¶: Returns the path (or “/” if no path is specified), followed by the query if it is specified.

URLSpec.get_port()¶: Returns the port number specified by the URL, or the default port if not specified.

URLSpec.get_port_str()¶: Returns the port specified by the URL as a string, or the empty string if no port is specified. Compare this with get_port(), which returns a default port number if no port is specified.

URLSpec.get_query()¶: Returns the query specified by the URL, or empty string if no query is specified.

URLSpec.get_scheme()¶: Returns the scheme specified by the URL, or empty string if no scheme is specified.

URLSpec.get_server()¶: Returns the server name specified by the URL, if any. In case of an IPv6 address, does not include the enclosing brackets.

URLSpec.get_server_and_port()¶: Returns a string consisting of the server name, followed by a colon, followed by the port number. If the port number is not explicitly given in the URL, this string will include the implicit port number. If the server is an IPv6 address, it will be enclosed in square brackets.

URLSpec.get_url()¶: Returns the complete URL specification.

URLSpec.get_username()¶: Returns the username specified by the URL, if any. This might also include a password, e.g. “username:password”, although putting a password on the URL is probably a bad idea.

URLSpec.has_authority()¶: Returns true if the URL specifies an authority (this includes username, server, and/or port), false otherwise.

URLSpec.has_path()¶: Returns true if the URL includes a path specification (that is, the particular filename on the server to retrieve), false otherwise.

URLSpec.has_port()¶: Returns true if the URL specifies a port number, false otherwise.

URLSpec.has_query()¶: Returns true if the URL includes a query specification, false otherwise.

URLSpec.has_scheme()¶: Returns true if the URL specifies a scheme (e.g. “http:”), false otherwise.

URLSpec.has_server()¶: Returns true if the URL specifies a server name, false otherwise.

URLSpec.has_username()¶: Returns true if the URL specifies a username (and/or password), false otherwise.

URLSpec.input()¶

URLSpec.is_default_port()¶: Returns true if the port number encoded in this URL is the default port number for the scheme (or if there is no port number), or false if it is a nonstandard port.

URLSpec.is_ssl()¶: Returns true if the URL’s scheme specifies an SSL-secured protocol such as https, or false otherwise.

URLSpec.length()¶

URLSpec.output()¶

static URLSpec.quote()¶: Returns the source string with all “unsafe” characters quoted, making a string suitable for placing in a URL. Letters, digits, and the underscore, comma, period, and hyphen characters, as well as any included in the safe string, are left alone; all others are converted to hex representation.

static URLSpec.quote_plus()¶: Behaves like quote() with the additional behavior of replacing spaces with plus signs.

URLSpec.set_authority()¶: Replaces the authority part of the URL specification. This includes the username, server, and port.

URLSpec.set_path()¶: Replaces the path part of the URL specification.

URLSpec.set_port()¶

Replaces the port part of the URL specification.

Replaces the port part of the URL specification, given a numeric port number.

URLSpec.set_query()¶: Replaces the query part of the URL specification.

URLSpec.set_scheme()¶: Replaces the scheme part of the URL specification.

URLSpec.set_server()¶: Replaces the server part of the URL specification. Unlike set_server_and_port, this method does not require IPv6 addresses to be enclosed in square brackets.

URLSpec.set_server_and_port()¶: Replaces the server and port parts of the URL specification simultaneously. The input string should be of the form “server:port”, or just “server” to make the port number implicit. Any IPv6 address must be enclosed in square brackets.

URLSpec.set_url()¶: Completely replaces the URL with the indicated string. If server_name_expected is true, it is a hint that an undecorated URL is probably a server name, not a local filename.

URLSpec.set_username()¶: Replaces the username part of the URL specification.

URLSpec.size()¶

static URLSpec.unquote()¶: Reverses the operation of quote(): converts escaped characters of the form “%xx” to their ascii equivalent.

static URLSpec.unquote_plus()¶: Reverses the operation of quote_plus(): converts escaped characters of the form “%xx” to their ascii equivalent, and also converts plus signs to spaces.