werkzeug.urls.BytesURL

class documentation

class BytesURL(BaseURL): (source)

View In Hierarchy

Represents a parsed URL in bytes.

Method __str__ Undocumented
Method decode Decodes the URL to a tuple made out of strings. The charset is only being used for the path, query and fragment.
Method encode_netloc Returns the netloc unchanged as bytes.
Class Variable __slots__ Undocumented
Class Variable _at Undocumented
Class Variable _colon Undocumented
Class Variable _lbracket Undocumented
Class Variable _rbracket Undocumented

Inherited from BaseURL:

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 :func:`url_decode` on the query argument. The arguments and keyword arguments are forwarded to :func:`url_decode` unchanged.
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 :meth:`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 Returns a :class:`URL` tuple that holds a IRI. This will try to decode as much information as possible in the URL without losing information similar to how a web browser does it for the URL bar.
Method to_uri_tuple Returns a :class:`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 :meth:`url_unparse` for this URL.
Property ascii_host Works exactly like :attr:`host` but will return a result that is restricted to ASCII. If it finds a netloc that is not ASCII it will attempt to idna decode it. This is useful for socket operations when the URL might include internationalized characters.
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 :attr:`password` this one is not being decoded.
Property raw_username The username if it was part of the URL, `None` otherwise. Unlike :attr:`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 __str__(self) -> str: (source)
overrides werkzeug.urls.BaseURL.__str__

Undocumented

def decode(self, charset: str = 'utf-8', errors: str = 'replace') -> URL: (source)

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

def encode_netloc(self) -> bytes: (source)
overrides werkzeug.urls.BaseURL.encode_netloc

Returns the netloc unchanged as bytes.

__slots__: tuple = (source)
overrides werkzeug.urls.BaseURL.__slots__

Undocumented

_at: bytes = (source)
overrides werkzeug.urls.BaseURL._at

Undocumented

_colon: bytes = (source)
overrides werkzeug.urls.BaseURL._colon

Undocumented

_lbracket: bytes = (source)
overrides werkzeug.urls.BaseURL._lbracket

Undocumented

_rbracket: bytes = (source)
overrides werkzeug.urls.BaseURL._rbracket

Undocumented