werkzeug.urls.URL

class documentation

class URL(BaseURL):

Represents a parsed URL. This behaves like a regular tuple but also has some extra attributes that give further insight into the URL.

Method	`encode`	Encodes the URL to a tuple made out of bytes. The charset is only being used for the path, query and fragment.
Class Variable	`__slots__`	Undocumented
Class Variable	`_at`	Undocumented
Class Variable	`_colon`	Undocumented
Class Variable	`_lbracket`	Undocumented
Class Variable	`_rbracket`	Undocumented

Inherited from BaseURL:

Method	`__str__`	Undocumented
Method	`decode_netloc`	Decodes the netloc part into a string.
Method	`decode_query`	Decodes the query part of the URL. Ths is a shortcut for calling `url_decode` on the query argument. The arguments and keyword arguments are forwarded to `url_decode` unchanged.
Method	`encode_netloc`	Encodes the netloc part to an ASCII safe URL as bytes.
Method	`get_file_location`	Returns a tuple with the location of the file in the form `(server, location)`. If the netloc is empty in the URL or points to localhost, it's represented as `None`.
Method	`join`	Joins this URL with another one. This is just a convenience function for calling into `url_join` and then parsing the return value again.
Method	`replace`	Return an URL with the same values, except for those parameters given new values by whichever keyword arguments are specified.
Method	`to_iri_tuple`	No summary
Method	`to_uri_tuple`	Returns a `BytesURL` tuple that holds a URI. This will encode all the information in the URL properly to ASCII using the rules a web browser would follow.
Method	`to_url`	Returns a URL string or bytes depending on the type of the information stored. This is just a convenience function for calling `url_unparse` for this URL.
Property	`ascii_host`	No summary
Property	`auth`	The authentication part in the URL if available, `None` otherwise.
Property	`host`	The host part of the URL if available, otherwise `None`. The host is either the hostname or the IP address mentioned in the URL. It will not contain the port.
Property	`password`	The password if it was part of the URL, `None` otherwise. This undergoes URL decoding and will always be a string.
Property	`port`	The port in the URL as an integer if it was present, `None` otherwise. This does not fill in default ports.
Property	`raw_password`	The password if it was part of the URL, `None` otherwise. Unlike `password` this one is not being decoded.
Property	`raw_username`	The username if it was part of the URL, `None` otherwise. Unlike `username` this one is not being decoded.
Property	`username`	The username if it was part of the URL, `None` otherwise. This undergoes URL decoding and will always be a string.
Method	`_split_auth`	Undocumented
Method	`_split_host`	Undocumented
Method	`_split_netloc`	Undocumented

Inherited from _URLTuple (via BaseURL):

Class Variable	`fragment`	Undocumented
Class Variable	`netloc`	Undocumented
Class Variable	`path`	Undocumented
Class Variable	`query`	Undocumented
Class Variable	`scheme`	Undocumented

def encode(self, charset='utf-8', errors='replace'):

Encodes the URL to a tuple made out of bytes. The charset is only being used for the path, query and fragment.

Parameters
charset:`str`	Undocumented
errors:`str`	Undocumented
Returns
`BytesURL`	Undocumented

__slots__: tuple =

overrides werkzeug.urls.BaseURL.__slots__

Undocumented

_at: str =

overrides werkzeug.urls.BaseURL._at

Undocumented

_colon: str =

overrides werkzeug.urls.BaseURL._colon

Undocumented

_lbracket: str =

overrides werkzeug.urls.BaseURL._lbracket

Undocumented

_rbracket: str =

overrides werkzeug.urls.BaseURL._rbracket

Undocumented