yarl.rtfd.io

https://yarl.rtfd.io/en/latest

py:module

Identifier Project Name Version Location Display Name Usage example
yarl yarl 1.9 api/#module-yarl - :py:mod:`yarl`

py:class

Identifier Project Name Version Location Display Name Usage example
yarl.URL yarl 1.9 api/#yarl.URL - :py:class:`yarl.URL`

py:attribute

Identifier Project Name Version Location Display Name Usage example
yarl.URL.authority yarl 1.9 api/#yarl.URL.authority - :py:attribute:`yarl.URL.authority`
yarl.URL.explicit_port yarl 1.9 api/#yarl.URL.explicit_port - :py:attribute:`yarl.URL.explicit_port`
yarl.URL.fragment yarl 1.9 api/#yarl.URL.fragment - :py:attribute:`yarl.URL.fragment`
yarl.URL.host yarl 1.9 api/#yarl.URL.host - :py:attribute:`yarl.URL.host`
yarl.URL.name yarl 1.9 api/#yarl.URL.name - :py:attribute:`yarl.URL.name`
yarl.URL.parent yarl 1.9 api/#yarl.URL.parent - :py:attribute:`yarl.URL.parent`
yarl.URL.parts yarl 1.9 api/#yarl.URL.parts - :py:attribute:`yarl.URL.parts`
yarl.URL.password yarl 1.9 api/#yarl.URL.password - :py:attribute:`yarl.URL.password`
yarl.URL.path yarl 1.9 api/#yarl.URL.path - :py:attribute:`yarl.URL.path`
yarl.URL.path_qs yarl 1.9 api/#yarl.URL.path_qs - :py:attribute:`yarl.URL.path_qs`
yarl.URL.port yarl 1.9 api/#yarl.URL.port - :py:attribute:`yarl.URL.port`
yarl.URL.query yarl 1.9 api/#yarl.URL.query - :py:attribute:`yarl.URL.query`
yarl.URL.query_string yarl 1.9 api/#yarl.URL.query_string - :py:attribute:`yarl.URL.query_string`
yarl.URL.raw_authority yarl 1.9 api/#yarl.URL.raw_authority - :py:attribute:`yarl.URL.raw_authority`
yarl.URL.raw_fragment yarl 1.9 api/#yarl.URL.raw_fragment - :py:attribute:`yarl.URL.raw_fragment`
yarl.URL.raw_host yarl 1.9 api/#yarl.URL.raw_host - :py:attribute:`yarl.URL.raw_host`
yarl.URL.raw_name yarl 1.9 api/#yarl.URL.raw_name - :py:attribute:`yarl.URL.raw_name`
yarl.URL.raw_parts yarl 1.9 api/#yarl.URL.raw_parts - :py:attribute:`yarl.URL.raw_parts`
yarl.URL.raw_password yarl 1.9 api/#yarl.URL.raw_password - :py:attribute:`yarl.URL.raw_password`
yarl.URL.raw_path yarl 1.9 api/#yarl.URL.raw_path - :py:attribute:`yarl.URL.raw_path`
yarl.URL.raw_path_qs yarl 1.9 api/#yarl.URL.raw_path_qs - :py:attribute:`yarl.URL.raw_path_qs`
yarl.URL.raw_query_string yarl 1.9 api/#yarl.URL.raw_query_string - :py:attribute:`yarl.URL.raw_query_string`
yarl.URL.raw_suffix yarl 1.9 api/#yarl.URL.raw_suffix - :py:attribute:`yarl.URL.raw_suffix`
yarl.URL.raw_suffixes yarl 1.9 api/#yarl.URL.raw_suffixes - :py:attribute:`yarl.URL.raw_suffixes`
yarl.URL.raw_user yarl 1.9 api/#yarl.URL.raw_user - :py:attribute:`yarl.URL.raw_user`
yarl.URL.scheme yarl 1.9 api/#yarl.URL.scheme - :py:attribute:`yarl.URL.scheme`
yarl.URL.suffix yarl 1.9 api/#yarl.URL.suffix - :py:attribute:`yarl.URL.suffix`
yarl.URL.suffixes yarl 1.9 api/#yarl.URL.suffixes - :py:attribute:`yarl.URL.suffixes`
yarl.URL.user yarl 1.9 api/#yarl.URL.user - :py:attribute:`yarl.URL.user`

py:method

Identifier Project Name Version Location Display Name Usage example
yarl.URL.build yarl 1.9 api/#yarl.URL.build - :py:method:`yarl.URL.build`
yarl.URL.human_repr yarl 1.9 api/#yarl.URL.human_repr - :py:method:`yarl.URL.human_repr`
yarl.URL.is_absolute yarl 1.9 api/#yarl.URL.is_absolute - :py:method:`yarl.URL.is_absolute`
yarl.URL.is_default_port yarl 1.9 api/#yarl.URL.is_default_port - :py:method:`yarl.URL.is_default_port`
yarl.URL.join yarl 1.9 api/#yarl.URL.join - :py:method:`yarl.URL.join`
yarl.URL.joinpath yarl 1.9 api/#yarl.URL.joinpath - :py:method:`yarl.URL.joinpath`
yarl.URL.origin yarl 1.9 api/#yarl.URL.origin - :py:method:`yarl.URL.origin`
yarl.URL.relative yarl 1.9 api/#yarl.URL.relative - :py:method:`yarl.URL.relative`
yarl.URL.update_query yarl 1.9 api/#yarl.URL.update_query - :py:method:`yarl.URL.update_query`
yarl.URL.with_fragment yarl 1.9 api/#yarl.URL.with_fragment - :py:method:`yarl.URL.with_fragment`
yarl.URL.with_host yarl 1.9 api/#yarl.URL.with_host - :py:method:`yarl.URL.with_host`
yarl.URL.with_name yarl 1.9 api/#yarl.URL.with_name - :py:method:`yarl.URL.with_name`
yarl.URL.with_password yarl 1.9 api/#yarl.URL.with_password - :py:method:`yarl.URL.with_password`
yarl.URL.with_path yarl 1.9 api/#yarl.URL.with_path - :py:method:`yarl.URL.with_path`
yarl.URL.with_port yarl 1.9 api/#yarl.URL.with_port - :py:method:`yarl.URL.with_port`
yarl.URL.with_query yarl 1.9 api/#yarl.URL.with_query - :py:method:`yarl.URL.with_query`
yarl.URL.with_scheme yarl 1.9 api/#yarl.URL.with_scheme - :py:method:`yarl.URL.with_scheme`
yarl.URL.with_suffix yarl 1.9 api/#yarl.URL.with_suffix - :py:method:`yarl.URL.with_suffix`
yarl.URL.with_user yarl 1.9 api/#yarl.URL.with_user - :py:method:`yarl.URL.with_user`

py:function

Identifier Project Name Version Location Display Name Usage example
yarl.cache_clear yarl 1.9 api/#yarl.cache_clear - :py:function:`yarl.cache_clear`
yarl.cache_configure yarl 1.9 api/#yarl.cache_configure - :py:function:`yarl.cache_configure`
yarl.cache_info yarl 1.9 api/#yarl.cache_info - :py:function:`yarl.cache_info`

std:label

Identifier Project Name Version Location Display Name Usage example
adding change notes with your prs yarl 1.9 contributing/guidelines/#adding-change-notes-with-your-prs Adding change notes with your PRs :std:ref:`adding change notes with your prs`
genindex yarl 1.9 genindex/ Index :std:ref:`genindex`
modindex yarl 1.9 py-modindex/ Module Index :std:ref:`modindex`
py-modindex yarl 1.9 py-modindex/ Python Module Index :std:ref:`py-modindex`
search yarl 1.9 search/ Search Page :std:ref:`search`
yarl-api yarl 1.9 api/#yarl-api Public API :std:ref:`yarl-api`
yarl-api-default-ports yarl 1.9 api/#yarl-api-default-ports Default port substitution :std:ref:`yarl-api-default-ports`
yarl-api-relative-urls yarl 1.9 api/#yarl-api-relative-urls Absolute and relative URLs :std:ref:`yarl-api-relative-urls`
yarl-bools-support yarl 1.9 #yarl-bools-support Why isn’t boolean supported by the URL query API? :std:ref:`yarl-bools-support`
yarl_changes yarl 1.9 changes/#yarl-changes Changelog :std:ref:`yarl_changes`

std:doc

Identifier Project Name Version Location Display Name Usage example
api yarl 1.9 api/ Public API :std:doc:`api`
changes yarl 1.9 changes/ Changelog :std:doc:`changes`
contributing/guidelines yarl 1.9 contributing/guidelines/ Contributing docs :std:doc:`contributing/guidelines`
contributing/release_guide yarl 1.9 contributing/release_guide/ Release Guide :std:doc:`contributing/release_guide`
index yarl 1.9 yarl :std:doc:`index`