werkzeug.urls.BaseURL

class documentation

class BaseURL(_URLTuple): (source)

Known subclasses: werkzeug.urls.BytesURL, werkzeug.urls.URL

View In Hierarchy

Superclass of :py:class:`URL` and :py:class:`BytesURL`.

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 :func:`url_decode` on the query argument. The arguments and keyword arguments are forwarded to :func:`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 :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.
Class Variable __slots__ Undocumented
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
Class Variable _at Undocumented
Class Variable _colon Undocumented
Class Variable _lbracket Undocumented
Class Variable _rbracket Undocumented

Inherited from _URLTuple:

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)
overridden in werkzeug.urls.BytesURL

Undocumented

def decode_netloc(self) -> str: (source)

Decodes the netloc part into a string.

def decode_query(self, *args: t.Any, **kwargs: t.Any) -> ds.MultiDict[str, str]: (source)

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.

def encode_netloc(self) -> str: (source)
overridden in werkzeug.urls.BytesURL

Encodes the netloc part to an ASCII safe URL as bytes.

def get_file_location(self, pathformat: t.Optional[str] = None) -> t.Tuple[t.Optional[str], t.Optional[str]]: (source)

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``. The `pathformat` by default is autodetection but needs to be set when working with URLs of a specific system. The supported values are ``'windows'`` when working with Windows or DOS paths and ``'posix'`` when working with posix paths. If the URL does not point to a local file, the server and location are both represented as ``None``. :param pathformat: The expected format of the path component. Currently ``'windows'`` and ``'posix'`` are supported. Defaults to ``None`` which is autodetect.

def join(self, *args: t.Any, **kwargs: t.Any) -> BaseURL: (source)

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.

def replace(self, **kwargs: t.Any) -> BaseURL: (source)

Return an URL with the same values, except for those parameters given new values by whichever keyword arguments are specified.

def to_iri_tuple(self) -> BaseURL: (source)

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. It's usually more interesting to directly call :meth:`uri_to_iri` which will return a string.

def to_uri_tuple(self) -> BaseURL: (source)

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. It's usually more interesting to directly call :meth:`iri_to_uri` which will return a string.

def to_url(self) -> str: (source)

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.

__slots__: tuple = (source)
overridden in werkzeug.urls.BytesURL, werkzeug.urls.URL

Undocumented

@property
ascii_host: t.Optional[str] = (source)

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: t.Optional[str] = (source)

The authentication part in the URL if available, `None` otherwise.

@property
host: t.Optional[str] = (source)

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: t.Optional[str] = (source)

The password if it was part of the URL, `None` otherwise. This undergoes URL decoding and will always be a string.

@property
port: t.Optional[int] = (source)

The port in the URL as an integer if it was present, `None` otherwise. This does not fill in default ports.

@property
raw_password: t.Optional[str] = (source)

The password if it was part of the URL, `None` otherwise. Unlike :attr:`password` this one is not being decoded.

@property
raw_username: t.Optional[str] = (source)

The username if it was part of the URL, `None` otherwise. Unlike :attr:`username` this one is not being decoded.

@property
username: t.Optional[str] = (source)

The username if it was part of the URL, `None` otherwise. This undergoes URL decoding and will always be a string.

def _split_auth(self) -> t.Tuple[t.Optional[str], t.Optional[str]]: (source)

Undocumented

def _split_host(self) -> t.Tuple[t.Optional[str], t.Optional[str]]: (source)

Undocumented

def _split_netloc(self) -> t.Tuple[t.Optional[str], str]: (source)

Undocumented

_at: str = (source)
overridden in werkzeug.urls.BytesURL, werkzeug.urls.URL

Undocumented

_colon: str = (source)
overridden in werkzeug.urls.BytesURL, werkzeug.urls.URL

Undocumented

_lbracket: str = (source)
overridden in werkzeug.urls.BytesURL, werkzeug.urls.URL

Undocumented

_rbracket: str = (source)
overridden in werkzeug.urls.BytesURL, werkzeug.urls.URL

Undocumented