.. automodule:: hyperlink._url
Before you can work with URLs, you must create URLs.
If you already have a textual URL, the easiest way to get URL objects is with the :func:`parse()` function:
.. autofunction:: hyperlink.parse
By default, :func:`~hyperlink.parse()` returns an instance of :class:`DecodedURL`, a URL type that handles all encoding for you, by wrapping the lower-level :class:`URL`.
.. autoclass:: hyperlink.DecodedURL
.. automethod:: hyperlink.DecodedURL.from_text
The lower-level :class:`URL` looks very similar to the :class:`DecodedURL`, but does not handle all encoding cases for you. Use with caution.
Note
:class:`URL` is also available as an alias,
hyperlink.EncodedURL for more explicit usage.
.. autoclass:: hyperlink.URL
.. automethod:: hyperlink.URL.from_text
Once a URL is created, some of the most common tasks are to transform it into other URLs and text.
.. automethod:: hyperlink.URL.to_text
.. automethod:: hyperlink.URL.to_uri
.. automethod:: hyperlink.URL.to_iri
.. automethod:: hyperlink.URL.replace
.. automethod:: hyperlink.URL.normalize
Go places with URLs. Simulate browser behavior and perform semantic path operations.
.. automethod:: hyperlink.URL.click
.. automethod:: hyperlink.URL.sibling
.. automethod:: hyperlink.URL.child
CRUD operations on the query string multimap.
.. automethod:: hyperlink.URL.get
.. automethod:: hyperlink.URL.add
.. automethod:: hyperlink.URL.set
.. automethod:: hyperlink.URL.remove
URLs have many parts, and URL objects have many attributes to represent them.
.. autoattribute:: hyperlink.URL.absolute
.. autoattribute:: hyperlink.URL.scheme
.. autoattribute:: hyperlink.URL.host
.. autoattribute:: hyperlink.URL.port
.. autoattribute:: hyperlink.URL.path
.. autoattribute:: hyperlink.URL.query
.. autoattribute:: hyperlink.URL.fragment
.. autoattribute:: hyperlink.URL.userinfo
.. autoattribute:: hyperlink.URL.user
.. autoattribute:: hyperlink.URL.rooted
A couple of notable helpers used by the :class:`~hyperlink.URL` type.
.. autoclass:: hyperlink.URLParseError
.. autofunction:: hyperlink.register_scheme
.. autofunction:: hyperlink.parse