{"author":"Andrew Svetlov","author_email":"andrew.svetlov@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Programming Language :: Cython","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Topic :: Internet :: WWW/HTTP","Topic :: Software Development :: Libraries :: Python Modules"],"description":"yarl\n====\n\nThe module provides handy URL class for URL parsing and changing.\n\n.. image:: https://github.com/aio-libs/yarl/workflows/CI/badge.svg\n :target: https://github.com/aio-libs/yarl/actions?query=workflow%3ACI\n :align: right\n\n.. image:: https://codecov.io/gh/aio-libs/yarl/graph/badge.svg?flag=pytest\n :target: https://app.codecov.io/gh/aio-libs/yarl?flags[]=pytest\n :alt: Codecov coverage for the pytest-driven measurements\n\n.. image:: https://img.shields.io/endpoint?url=https://codspeed.io/badge.json\n :target: https://codspeed.io/aio-libs/yarl\n\n.. image:: https://badge.fury.io/py/yarl.svg\n :target: https://badge.fury.io/py/yarl\n\n.. image:: https://readthedocs.org/projects/yarl/badge/?version=latest\n :target: https://yarl.aio-libs.org\n\n.. image:: https://img.shields.io/pypi/pyversions/yarl.svg\n :target: https://pypi.python.org/pypi/yarl\n\n.. image:: https://img.shields.io/matrix/aio-libs:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat\n :target: https://matrix.to/#/%23aio-libs:matrix.org\n :alt: Matrix Room — #aio-libs:matrix.org\n\n.. image:: https://img.shields.io/matrix/aio-libs-space:matrix.org?label=Discuss%20on%20Matrix%20at%20%23aio-libs-space%3Amatrix.org&logo=matrix&server_fqdn=matrix.org&style=flat\n :target: https://matrix.to/#/%23aio-libs-space:matrix.org\n :alt: Matrix Space — #aio-libs-space:matrix.org\n\n\nIntroduction\n------------\n\nUrl is constructed from ``str``:\n\n.. code-block:: pycon\n\n >>> from yarl import URL\n >>> url = URL('https://www.python.org/~guido?arg=1#frag')\n >>> url\n URL('https://www.python.org/~guido?arg=1#frag')\n\nAll url parts: *scheme*, *user*, *password*, *host*, *port*, *path*,\n*query* and *fragment* are accessible by properties:\n\n.. code-block:: pycon\n\n >>> url.scheme\n 'https'\n >>> url.host\n 'www.python.org'\n >>> url.path\n '/~guido'\n >>> url.query_string\n 'arg=1'\n >>> url.query\n \n >>> url.fragment\n 'frag'\n\nAll url manipulations produce a new url object:\n\n.. code-block:: pycon\n\n >>> url = URL('https://www.python.org')\n >>> url / 'foo' / 'bar'\n URL('https://www.python.org/foo/bar')\n >>> url / 'foo' % {'bar': 'baz'}\n URL('https://www.python.org/foo?bar=baz')\n\nStrings passed to constructor and modification methods are\nautomatically encoded giving canonical representation as result:\n\n.. code-block:: pycon\n\n >>> url = URL('https://www.python.org/шлях')\n >>> url\n URL('https://www.python.org/%D1%88%D0%BB%D1%8F%D1%85')\n\nRegular properties are *percent-decoded*, use ``raw_`` versions for\ngetting *encoded* strings:\n\n.. code-block:: pycon\n\n >>> url.path\n '/шлях'\n\n >>> url.raw_path\n '/%D1%88%D0%BB%D1%8F%D1%85'\n\nHuman readable representation of URL is available as ``.human_repr()``:\n\n.. code-block:: pycon\n\n >>> url.human_repr()\n 'https://www.python.org/шлях'\n\nFor full documentation please read https://yarl.aio-libs.org.\n\n\nInstallation\n------------\n\n::\n\n $ pip install yarl\n\nThe library is Python 3 only!\n\nPyPI contains binary wheels for Linux, Windows and MacOS. If you want to install\n``yarl`` on another operating system where wheels are not provided,\nthe tarball will be used to compile the library from\nthe source code. It requires a C compiler and and Python headers installed.\n\nTo skip the compilation you must explicitly opt-in by using a PEP 517\nconfiguration setting ``pure-python``, or setting the ``YARL_NO_EXTENSIONS``\nenvironment variable to a non-empty value, e.g.:\n\n.. code-block:: console\n\n $ pip install yarl --config-settings=pure-python=false\n\nPlease note that the pure-Python (uncompiled) version is much slower. However,\nPyPy always uses a pure-Python implementation, and, as such, it is unaffected\nby this variable.\n\nDependencies\n------------\n\nYARL requires multidict_ and propcache_ libraries.\n\n\nAPI documentation\n------------------\n\nThe documentation is located at https://yarl.aio-libs.org.\n\n\nWhy isn't boolean supported by the URL query API?\n-------------------------------------------------\n\nThere is no standard for boolean representation of boolean values.\n\nSome systems prefer ``true``/``false``, others like ``yes``/``no``, ``on``/``off``,\n``Y``/``N``, ``1``/``0``, etc.\n\n``yarl`` cannot make an unambiguous decision on how to serialize ``bool`` values because\nit is specific to how the end-user's application is built and would be different for\ndifferent apps. The library doesn't accept booleans in the API; a user should convert\nbools into strings using own preferred translation protocol.\n\n\nComparison with other URL libraries\n------------------------------------\n\n* furl (https://pypi.python.org/pypi/furl)\n\n The library has rich functionality but the ``furl`` object is mutable.\n\n I'm afraid to pass this object into foreign code: who knows if the\n code will modify my url in a terrible way while I just want to send URL\n with handy helpers for accessing URL properties.\n\n ``furl`` has other non-obvious tricky things but the main objection\n is mutability.\n\n* URLObject (https://pypi.python.org/pypi/URLObject)\n\n URLObject is immutable, that's pretty good.\n\n Every URL change generates a new URL object.\n\n But the library doesn't do any decode/encode transformations leaving the\n end user to cope with these gory details.\n\n\nSource code\n-----------\n\nThe project is hosted on GitHub_\n\nPlease file an issue on the `bug tracker\n`_ if you have found a bug\nor have some suggestion in order to improve the library.\n\nDiscussion list\n---------------\n\n*aio-libs* google group: https://groups.google.com/forum/#!forum/aio-libs\n\nFeel free to post your questions and ideas here.\n\n\nAuthors and License\n-------------------\n\nThe ``yarl`` package is written by Andrew Svetlov.\n\nIt's *Apache 2* licensed and freely available.\n\n\n.. _GitHub: https://github.com/aio-libs/yarl\n\n.. _multidict: https://github.com/aio-libs/multidict\n\n.. _propcache: https://github.com/aio-libs/propcache\n\n=========\nChangelog\n=========\n\n..\n You should *NOT* be adding new change log entries to this file, this\n file is managed by towncrier. You *may* edit previous change logs to\n fix problems like typo corrections or such.\n To add a new change log entry, please see\n https://pip.pypa.io/en/latest/development/#adding-a-news-entry\n we named the news folder \"changes\".\n\n WARNING: Don't drop the next directive!\n\n.. towncrier release notes start\n\n1.20.0\n======\n\n*(2025-04-16)*\n\n\nFeatures\n--------\n\n- Implemented support for the free-threaded build of CPython 3.13 -- by `@lysnikolaou `__.\n\n *Related issues and pull requests on GitHub:*\n `#1456 `__.\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- Started building wheels for the free-threaded build of CPython 3.13 -- by `@lysnikolaou `__.\n\n *Related issues and pull requests on GitHub:*\n `#1456 `__.\n\n\n----\n\n\n1.19.0\n======\n\n*(2025-04-05)*\n\n\nBug fixes\n---------\n\n- Fixed entire name being re-encoded when using ``yarl.URL.with_suffix()`` -- by `@NTFSvolume `__.\n\n *Related issues and pull requests on GitHub:*\n `#1468 `__.\n\n\nFeatures\n--------\n\n- Started building armv7l wheels for manylinux -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1495 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- GitHub Actions CI/CD is now configured to manage caching pip-ecosystem\n dependencies using `re-actors/cache-python-deps`_ -- an action by\n `@webknjaz `__ that takes into account ABI stability and the exact\n version of Python runtime.\n\n .. _`re-actors/cache-python-deps`:\n https://github.com/marketplace/actions/cache-python-deps\n\n *Related issues and pull requests on GitHub:*\n `#1471 `__.\n\n- Increased minimum `propcache`_ version to 0.2.1 to fix failing tests -- by `@bdraco `__.\n\n .. _`propcache`:\n https://github.com/aio-libs/propcache\n\n *Related issues and pull requests on GitHub:*\n `#1479 `__.\n\n- Added all hidden folders to pytest's ``norecursedirs`` to prevent it\n from trying to collect tests there -- by `@lysnikolaou `__.\n\n *Related issues and pull requests on GitHub:*\n `#1480 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved accuracy of type annotations -- by `@Dreamsorcerer `__.\n\n *Related issues and pull requests on GitHub:*\n `#1484 `__.\n\n- Improved performance of parsing query strings -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1493 `__, `#1497 `__.\n\n- Improved performance of the C unquoter -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1496 `__, `#1498 `__.\n\n\n----\n\n\n1.18.3\n======\n\n*(2024-12-01)*\n\n\nBug fixes\n---------\n\n- Fixed uppercase ASCII hosts being rejected by ``URL.build()()`` and ``yarl.URL.with_host()`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#954 `__, `#1442 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performances of multiple path properties on cache miss -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1443 `__.\n\n\n----\n\n\n1.18.2\n======\n\n*(2024-11-29)*\n\n\nNo significant changes.\n\n\n----\n\n\n1.18.1\n======\n\n*(2024-11-29)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved cache performance when ``~yarl.URL`` objects are constructed from ``yarl.URL.build()`` with ``encoded=True`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1432 `__.\n\n- Improved cache performance for operations that produce a new ``~yarl.URL`` object -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1434 `__, `#1436 `__.\n\n\n----\n\n\n1.18.0\n======\n\n*(2024-11-21)*\n\n\nFeatures\n--------\n\n- Added ``keep_query`` and ``keep_fragment`` flags in the ``yarl.URL.with_path()``, ``yarl.URL.with_name()`` and ``yarl.URL.with_suffix()`` methods, allowing users to optionally retain the query string and fragment in the resulting URL when replacing the path -- by `@paul-nameless `__.\n\n *Related issues and pull requests on GitHub:*\n `#111 `__, `#1421 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- Started running downstream ``aiohttp`` tests in CI -- by `@Cycloctane `__.\n\n *Related issues and pull requests on GitHub:*\n `#1415 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of converting ``~yarl.URL`` to a string -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1422 `__.\n\n\n----\n\n\n1.17.2\n======\n\n*(2024-11-17)*\n\n\nBug fixes\n---------\n\n- Stopped implicitly allowing the use of Cython pre-release versions when\n building the distribution package -- by `@ajsanchezsanz `__ and\n `@markgreene74 `__.\n\n *Related issues and pull requests on GitHub:*\n `#1411 `__, `#1412 `__.\n\n- Fixed a bug causing ``~yarl.URL.port`` to return the default port when the given port was zero\n -- by `@gmacon `__.\n\n *Related issues and pull requests on GitHub:*\n `#1413 `__.\n\n\nFeatures\n--------\n\n- Make error messages include details of incorrect type when ``port`` is not int in ``yarl.URL.build()``.\n -- by `@Cycloctane `__.\n\n *Related issues and pull requests on GitHub:*\n `#1414 `__.\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- Stopped implicitly allowing the use of Cython pre-release versions when\n building the distribution package -- by `@ajsanchezsanz `__ and\n `@markgreene74 `__.\n\n *Related issues and pull requests on GitHub:*\n `#1411 `__, `#1412 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of the ``yarl.URL.joinpath()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1418 `__.\n\n\n----\n\n\n1.17.1\n======\n\n*(2024-10-30)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of many ``~yarl.URL`` methods -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1396 `__, `#1397 `__, `#1398 `__.\n\n- Improved performance of passing a `dict` or `str` to ``yarl.URL.extend_query()`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1401 `__.\n\n\n----\n\n\n1.17.0\n======\n\n*(2024-10-28)*\n\n\nFeatures\n--------\n\n- Added ``~yarl.URL.host_port_subcomponent`` which returns the ``3986#section-3.2.2`` host and ``3986#section-3.2.3`` port subcomponent -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1375 `__.\n\n\n----\n\n\n1.16.0\n======\n\n*(2024-10-21)*\n\n\nBug fixes\n---------\n\n- Fixed blocking I/O to load Python code when creating a new ``~yarl.URL`` with non-ascii characters in the network location part -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1342 `__.\n\n\nRemovals and backward incompatible breaking changes\n---------------------------------------------------\n\n- Migrated to using a single cache for encoding hosts -- by `@bdraco `__.\n\n Passing ``ip_address_size`` and ``host_validate_size`` to ``yarl.cache_configure()`` is deprecated in favor of the new ``encode_host_size`` parameter and will be removed in a future release. For backwards compatibility, the old parameters affect the ``encode_host`` cache size.\n\n *Related issues and pull requests on GitHub:*\n `#1348 `__, `#1357 `__, `#1363 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of constructing ``~yarl.URL`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1336 `__.\n\n- Improved performance of calling ``yarl.URL.build()`` and constructing unencoded ``~yarl.URL`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1345 `__.\n\n- Reworked the internal encoding cache to improve performance on cache hit -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1369 `__.\n\n\n----\n\n\n1.15.5\n======\n\n*(2024-10-18)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of the ``yarl.URL.joinpath()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1304 `__.\n\n- Improved performance of the ``yarl.URL.extend_query()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1305 `__.\n\n- Improved performance of the ``yarl.URL.origin()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1306 `__.\n\n- Improved performance of the ``yarl.URL.with_path()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1307 `__.\n\n- Improved performance of the ``yarl.URL.with_query()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1308 `__, `#1328 `__.\n\n- Improved performance of the ``yarl.URL.update_query()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1309 `__, `#1327 `__.\n\n- Improved performance of the ``yarl.URL.join()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1313 `__.\n\n- Improved performance of ``~yarl.URL`` equality checks -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1315 `__.\n\n- Improved performance of ``~yarl.URL`` methods that modify the network location -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1316 `__.\n\n- Improved performance of the ``yarl.URL.with_fragment()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1317 `__.\n\n- Improved performance of calculating the hash of ``~yarl.URL`` objects -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1318 `__.\n\n- Improved performance of the ``yarl.URL.relative()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1319 `__.\n\n- Improved performance of the ``yarl.URL.with_name()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1320 `__.\n\n- Improved performance of ``~yarl.URL.parent`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1321 `__.\n\n- Improved performance of the ``yarl.URL.with_scheme()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1322 `__.\n\n\n----\n\n\n1.15.4\n======\n\n*(2024-10-16)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of the quoter when all characters are safe -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1288 `__.\n\n- Improved performance of unquoting strings -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1292 `__, `#1293 `__.\n\n- Improved performance of calling ``yarl.URL.build()`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1297 `__.\n\n\n----\n\n\n1.15.3\n======\n\n*(2024-10-15)*\n\n\nBug fixes\n---------\n\n- Fixed ``yarl.URL.build()`` failing to validate paths must start with a ``/`` when passing ``authority`` -- by `@bdraco `__.\n\n The validation only worked correctly when passing ``host``.\n\n *Related issues and pull requests on GitHub:*\n `#1265 `__.\n\n\nRemovals and backward incompatible breaking changes\n---------------------------------------------------\n\n- Removed support for Python 3.8 as it has reached end of life -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1203 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of constructing ``~yarl.URL`` when the net location is only the host -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1271 `__.\n\n\n----\n\n\n1.15.2\n======\n\n*(2024-10-13)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of converting ``~yarl.URL`` to a string -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1234 `__.\n\n- Improved performance of ``yarl.URL.joinpath()`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1248 `__, `#1250 `__.\n\n- Improved performance of constructing query strings from ``~multidict.MultiDict`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1256 `__.\n\n- Improved performance of constructing query strings with ``int`` values -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1259 `__.\n\n\n----\n\n\n1.15.1\n======\n\n*(2024-10-12)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of calling ``yarl.URL.build()`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1222 `__.\n\n- Improved performance of all ``~yarl.URL`` methods that create new ``~yarl.URL`` objects -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1226 `__.\n\n- Improved performance of ``~yarl.URL`` methods that modify the network location -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1229 `__.\n\n\n----\n\n\n1.15.0\n======\n\n*(2024-10-11)*\n\n\nBug fixes\n---------\n\n- Fixed validation with ``yarl.URL.with_scheme()`` when passed scheme is not lowercase -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1189 `__.\n\n\nFeatures\n--------\n\n- Started building ``armv7l`` wheels -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1204 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of constructing unencoded ``~yarl.URL`` objects -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1188 `__.\n\n- Added a cache for parsing hosts to reduce overhead of encoding ``~yarl.URL`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1190 `__.\n\n- Improved performance of constructing query strings from ``~collections.abc.Mapping`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1193 `__.\n\n- Improved performance of converting ``~yarl.URL`` objects to strings -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1198 `__.\n\n\n----\n\n\n1.14.0\n======\n\n*(2024-10-08)*\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- Switched to using the ``propcache`` package for property caching\n -- by `@bdraco `__.\n\n The ``propcache`` package is derived from the property caching\n code in ``yarl`` and has been broken out to avoid maintaining it for multiple\n projects.\n\n *Related issues and pull requests on GitHub:*\n `#1169 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- Started testing with Hypothesis -- by `@webknjaz `__ and `@bdraco `__.\n\n Special thanks to `@Zac-HD `__ for helping us get started with this framework.\n\n *Related issues and pull requests on GitHub:*\n `#860 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of ``yarl.URL.is_default_port()`` when no explicit port is set -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1168 `__.\n\n- Improved performance of converting ``~yarl.URL`` to a string when no explicit port is set -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1170 `__.\n\n- Improved performance of the ``yarl.URL.origin()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1175 `__.\n\n- Improved performance of encoding hosts -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1176 `__.\n\n\n----\n\n\n1.13.1\n======\n\n*(2024-09-27)*\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of calling ``yarl.URL.build()`` with ``authority`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1163 `__.\n\n\n----\n\n\n1.13.0\n======\n\n*(2024-09-26)*\n\n\nBug fixes\n---------\n\n- Started rejecting ASCII hostnames with invalid characters. For host strings that\n look like authority strings, the exception message includes advice on what to do\n instead -- by `@mjpieters `__.\n\n *Related issues and pull requests on GitHub:*\n `#880 `__, `#954 `__.\n\n- Fixed IPv6 addresses missing brackets when the ``~yarl.URL`` was converted to a string -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1157 `__, `#1158 `__.\n\n\nFeatures\n--------\n\n- Added ``~yarl.URL.host_subcomponent`` which returns the ``3986#section-3.2.2`` host subcomponent -- by `@bdraco `__.\n\n The only current practical difference between ``~yarl.URL.raw_host`` and ``~yarl.URL.host_subcomponent`` is that IPv6 addresses are returned bracketed.\n\n *Related issues and pull requests on GitHub:*\n `#1159 `__.\n\n\n----\n\n\n1.12.1\n======\n\n*(2024-09-23)*\n\n\nNo significant changes.\n\n\n----\n\n\n1.12.0\n======\n\n*(2024-09-23)*\n\n\nFeatures\n--------\n\n- Added ``~yarl.URL.path_safe`` to be able to fetch the path without ``%2F`` and ``%25`` decoded -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1150 `__.\n\n\nRemovals and backward incompatible breaking changes\n---------------------------------------------------\n\n- Restore decoding ``%2F`` (``/``) in ``URL.path`` -- by `@bdraco `__.\n\n This change restored the behavior before `#1057 `__.\n\n *Related issues and pull requests on GitHub:*\n `#1151 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of processing paths -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1143 `__.\n\n\n----\n\n\n1.11.1\n======\n\n*(2024-09-09)*\n\n\nBug fixes\n---------\n\n- Allowed scheme replacement for relative URLs if the scheme does not require a host -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#280 `__, `#1138 `__.\n\n- Allowed empty host for URL schemes other than the special schemes listed in the WHATWG URL spec -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1136 `__.\n\n\nFeatures\n--------\n\n- Loosened restriction on integers as query string values to allow classes that implement ``__int__`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1139 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of normalizing paths -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1137 `__.\n\n\n----\n\n\n1.11.0\n======\n\n*(2024-09-08)*\n\n\nFeatures\n--------\n\n- Added ``URL.extend_query()()`` method, which can be used to extend parameters without replacing same named keys -- by `@bdraco `__.\n\n This method was primarily added to replace the inefficient hand rolled method currently used in ``aiohttp``.\n\n *Related issues and pull requests on GitHub:*\n `#1128 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of the Cython ``cached_property`` implementation -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1122 `__.\n\n- Simplified computing ports by removing unnecessary code -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1123 `__.\n\n- Improved performance of encoding non IPv6 hosts -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1125 `__.\n\n- Improved performance of ``URL.build()()`` when the path, query string, or fragment is an empty string -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1126 `__.\n\n- Improved performance of the ``URL.update_query()()`` method -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1130 `__.\n\n- Improved performance of processing query string changes when arguments are ``str`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1131 `__.\n\n\n----\n\n\n1.10.0\n======\n\n*(2024-09-06)*\n\n\nBug fixes\n---------\n\n- Fixed joining a path when the existing path was empty -- by `@bdraco `__.\n\n A regression in ``URL.join()()`` was introduced in `#1082 `__.\n\n *Related issues and pull requests on GitHub:*\n `#1118 `__.\n\n\nFeatures\n--------\n\n- Added ``URL.without_query_params()()`` method, to drop some parameters from query string -- by `@hongquan `__.\n\n *Related issues and pull requests on GitHub:*\n `#774 `__, `#898 `__, `#1010 `__.\n\n- The previously protected types ``_SimpleQuery``, ``_QueryVariable``, and ``_Query`` are now available for use externally as ``SimpleQuery``, ``QueryVariable``, and ``Query`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1050 `__, `#1113 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- Replaced all ``~typing.Optional`` with ``~typing.Union`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1095 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Significantly improved performance of parsing the network location -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1112 `__.\n\n- Added internal types to the cache to prevent future refactoring errors -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1117 `__.\n\n\n----\n\n\n1.9.11\n======\n\n*(2024-09-04)*\n\n\nBug fixes\n---------\n\n- Fixed a ``TypeError`` with ``MultiDictProxy`` and Python 3.8 -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1084 `__, `#1105 `__, `#1107 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of encoding hosts -- by `@bdraco `__.\n\n Previously, the library would unconditionally try to parse a host as an IP Address. The library now avoids trying to parse a host as an IP Address if the string is not in one of the formats described in ``3986#section-3.2.2``.\n\n *Related issues and pull requests on GitHub:*\n `#1104 `__.\n\n\n----\n\n\n1.9.10\n======\n\n*(2024-09-04)*\n\n\nBug fixes\n---------\n\n- ``URL.join()()`` has been changed to match\n ``3986`` and align with\n ``/ operation()`` and ``URL.joinpath()()``\n when joining URLs with empty segments.\n Previously ``urllib.parse.urljoin`` was used,\n which has known issues with empty segments\n (`python/cpython#84774 `_).\n\n Due to the semantics of ``URL.join()()``, joining an\n URL with scheme requires making it relative, prefixing with ``./``.\n\n .. code-block:: pycon\n\n >>> URL(\"https://web.archive.org/web/\").join(URL(\"./https://github.com/aio-libs/yarl\"))\n URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')\n\n\n Empty segments are honored in the base as well as the joined part.\n\n .. code-block:: pycon\n\n >>> URL(\"https://web.archive.org/web/https://\").join(URL(\"github.com/aio-libs/yarl\"))\n URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')\n\n\n\n -- by `@commonism `__\n\n This change initially appeared in 1.9.5 but was reverted in 1.9.6 to resolve a problem with query string handling.\n\n *Related issues and pull requests on GitHub:*\n `#1039 `__, `#1082 `__.\n\n\nFeatures\n--------\n\n- Added ``~yarl.URL.absolute`` which is now preferred over ``URL.is_absolute()`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1100 `__.\n\n\n----\n\n\n1.9.9\n=====\n\n*(2024-09-04)*\n\n\nBug fixes\n---------\n\n- Added missing type on ``~yarl.URL.port`` -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1097 `__.\n\n\n----\n\n\n1.9.8\n=====\n\n*(2024-09-03)*\n\n\nFeatures\n--------\n\n- Covered the ``~yarl.URL`` object with types -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1084 `__.\n\n- Cache parsing of IP Addresses when encoding hosts -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1086 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- Covered the ``~yarl.URL`` object with types -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1084 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of handling ports -- by `@bdraco `__.\n\n *Related issues and pull requests on GitHub:*\n `#1081 `__.\n\n\n----\n\n\n1.9.7\n=====\n\n*(2024-09-01)*\n\n\nRemovals and backward incompatible breaking changes\n---------------------------------------------------\n\n- Removed support ``3986#section-3.2.3`` port normalization when the scheme is not one of ``http``, ``https``, ``wss``, or ``ws`` -- by `@bdraco `__.\n\n Support for port normalization was recently added in `#1033 `__ and contained code that would do blocking I/O if the scheme was not one of the four listed above. The code has been removed because this library is intended to be safe for usage with ``asyncio``.\n\n *Related issues and pull requests on GitHub:*\n `#1076 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- Improved performance of property caching -- by `@bdraco `__.\n\n The ``reify`` implementation from ``aiohttp`` was adapted to replace the internal ``cached_property`` implementation.\n\n *Related issues and pull requests on GitHub:*\n `#1070 `__.\n\n\n----\n\n\n1.9.6\n=====\n\n*(2024-08-30)*\n\n\nBug fixes\n---------\n\n- Reverted ``3986`` compatible ``URL.join()()`` honoring empty segments which was introduced in `#1039 `__.\n\n This change introduced a regression handling query string parameters with joined URLs. The change was reverted to maintain compatibility with the previous behavior.\n\n *Related issues and pull requests on GitHub:*\n `#1067 `__.\n\n\n----\n\n\n1.9.5\n=====\n\n*(2024-08-30)*\n\n\nBug fixes\n---------\n\n- Joining URLs with empty segments has been changed\n to match ``3986``.\n\n Previously empty segments would be removed from path,\n breaking use-cases such as\n\n .. code-block:: python\n\n URL(\"https://web.archive.org/web/\") / \"https://github.com/\"\n\n Now ``/ operation()`` and ``URL.joinpath()()``\n keep empty segments, but do not introduce new empty segments.\n e.g.\n\n .. code-block:: python\n\n URL(\"https://example.org/\") / \"\"\n\n does not introduce an empty segment.\n\n -- by `@commonism `__ and `@youtux `__\n\n *Related issues and pull requests on GitHub:*\n `#1026 `__.\n\n- The default protocol ports of well-known URI schemes are now taken into account\n during the normalization of the URL string representation in accordance with\n ``3986#section-3.2.3``.\n\n Specified ports are removed from the ``str`` representation of a ``~yarl.URL``\n if the port matches the scheme's default port -- by `@commonism `__.\n\n *Related issues and pull requests on GitHub:*\n `#1033 `__.\n\n- ``URL.join()()`` has been changed to match\n ``3986`` and align with\n ``/ operation()`` and ``URL.joinpath()()``\n when joining URLs with empty segments.\n Previously ``urllib.parse.urljoin`` was used,\n which has known issues with empty segments\n (`python/cpython#84774 `_).\n\n Due to the semantics of ``URL.join()()``, joining an\n URL with scheme requires making it relative, prefixing with ``./``.\n\n .. code-block:: pycon\n\n >>> URL(\"https://web.archive.org/web/\").join(URL(\"./https://github.com/aio-libs/yarl\"))\n URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')\n\n\n Empty segments are honored in the base as well as the joined part.\n\n .. code-block:: pycon\n\n >>> URL(\"https://web.archive.org/web/https://\").join(URL(\"github.com/aio-libs/yarl\"))\n URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')\n\n\n\n -- by `@commonism `__\n\n *Related issues and pull requests on GitHub:*\n `#1039 `__.\n\n\nRemovals and backward incompatible breaking changes\n---------------------------------------------------\n\n- Stopped decoding ``%2F`` (``/``) in ``URL.path``, as this could lead to code incorrectly treating it as a path separator\n -- by `@Dreamsorcerer `__.\n\n *Related issues and pull requests on GitHub:*\n `#1057 `__.\n\n- Dropped support for Python 3.7 -- by `@Dreamsorcerer `__.\n\n *Related issues and pull requests on GitHub:*\n `#1016 `__.\n\n\nImproved documentation\n----------------------\n\n- On the ``Contributing docs`` page,\n a link to the ``Towncrier philosophy`` has been fixed.\n\n *Related issues and pull requests on GitHub:*\n `#981 `__.\n\n- The pre-existing ``/ magic method()``\n has been documented in the API reference -- by `@commonism `__.\n\n *Related issues and pull requests on GitHub:*\n `#1026 `__.\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- A flaw in the logic for copying the project directory into a\n temporary folder that led to infinite recursion when ``TMPDIR``\n was set to a project subdirectory path. This was happening in Fedora\n and its downstream due to the use of `pyproject-rpm-macros\n `__. It was\n only reproducible with ``pip wheel`` and was not affecting the\n ``pyproject-build`` users.\n\n -- by `@hroncok `__ and `@webknjaz `__\n\n *Related issues and pull requests on GitHub:*\n `#992 `__, `#1014 `__.\n\n- Support Python 3.13 and publish non-free-threaded wheels\n\n *Related issues and pull requests on GitHub:*\n `#1054 `__.\n\n\nContributor-facing changes\n--------------------------\n\n- The CI/CD setup has been updated to test ``arm64`` wheels\n under macOS 14, except for Python 3.7 that is unsupported\n in that environment -- by `@webknjaz `__.\n\n *Related issues and pull requests on GitHub:*\n `#1015 `__.\n\n- Removed unused type ignores and casts -- by `@hauntsaninja `__.\n\n *Related issues and pull requests on GitHub:*\n `#1031 `__.\n\n\nMiscellaneous internal changes\n------------------------------\n\n- ``port``, ``scheme``, and ``raw_host`` are now ``cached_property`` -- by `@bdraco `__.\n\n ``aiohttp`` accesses these properties quite often, which cause ``urllib`` to build the ``_hostinfo`` property every time. ``port``, ``scheme``, and ``raw_host`` are now cached properties, which will improve performance.\n\n *Related issues and pull requests on GitHub:*\n `#1044 `__, `#1058 `__.\n\n\n----\n\n\n1.9.4 (2023-12-06)\n==================\n\nBug fixes\n---------\n\n- Started raising ``TypeError`` when a string value is passed into\n ``yarl.URL.build()`` as the ``port`` argument -- by `@commonism `__.\n\n Previously the empty string as port would create malformed URLs when rendered as string representations. (`#883 `__)\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- The leading ``--`` has been dropped from the `PEP 517 `__ in-tree build\n backend config setting names. ``--pure-python`` is now just ``pure-python``\n -- by `@webknjaz `__.\n\n The usage now looks as follows:\n\n .. code-block:: console\n\n $ python -m build \\\n --config-setting=pure-python=true \\\n --config-setting=with-cython-tracing=true\n\n (`#963 `__)\n\n\nContributor-facing changes\n--------------------------\n\n- A step-by-step ``Release Guide`` guide has\n been added, describing how to release *yarl* -- by `@webknjaz `__.\n\n This is primarily targeting maintainers. (`#960 `__)\n- Coverage collection has been implemented for the Cython modules\n -- by `@webknjaz `__.\n\n It will also be reported to Codecov from any non-release CI jobs.\n\n To measure coverage in a development environment, *yarl* can be\n installed in editable mode:\n\n .. code-block:: console\n\n $ python -Im pip install -e .\n\n Editable install produces C-files required for the Cython coverage\n plugin to map the measurements back to the PYX-files.\n\n `#961 `__\n\n- It is now possible to request line tracing in Cython builds using the\n ``with-cython-tracing`` `PEP 517 `__ config setting\n -- `@webknjaz `__.\n\n This can be used in CI and development environment to measure coverage\n on Cython modules, but is not normally useful to the end-users or\n downstream packagers.\n\n Here's a usage example:\n\n .. code-block:: console\n\n $ python -Im pip install . --config-settings=with-cython-tracing=true\n\n For editable installs, this setting is on by default. Otherwise, it's\n off unless requested explicitly.\n\n The following produces C-files required for the Cython coverage\n plugin to map the measurements back to the PYX-files:\n\n .. code-block:: console\n\n $ python -Im pip install -e .\n\n Alternatively, the ``YARL_CYTHON_TRACING=1`` environment variable\n can be set to do the same as the `PEP 517 `__ config setting.\n\n `#962 `__\n\n\n1.9.3 (2023-11-20)\n==================\n\nBug fixes\n---------\n\n- Stopped dropping trailing slashes in ``yarl.URL.joinpath()`` -- by `@gmacon `__. (`#862 `__, `#866 `__)\n- Started accepting string subclasses in ``yarl.URL.__truediv__()`` operations (``URL / segment``) -- by `@mjpieters `__. (`#871 `__, `#884 `__)\n- Fixed the human representation of URLs with square brackets in usernames and passwords -- by `@mjpieters `__. (`#876 `__, `#882 `__)\n- Updated type hints to include ``URL.missing_port()``, ``URL.__bytes__()``\n and the ``encoding`` argument to ``yarl.URL.joinpath()``\n -- by `@mjpieters `__. (`#891 `__)\n\n\nPackaging updates and notes for downstreams\n-------------------------------------------\n\n- Integrated Cython 3 to enable building *yarl* under Python 3.12 -- by `@mjpieters `__. (`#829 `__, `#881 `__)\n- Declared modern ``setuptools.build_meta`` as the `PEP 517 `__ build\n backend in ``pyproject.toml`` explicitly -- by `@webknjaz `__. (`#886 `__)\n- Converted most of the packaging setup into a declarative ``setup.cfg``\n config -- by `@webknjaz `__. (`#890 `__)\n- The packaging is replaced from an old-fashioned ``setup.py`` to an\n in-tree `PEP 517 `__ build backend -- by `@webknjaz `__.\n\n Whenever the end-users or downstream packagers need to build ``yarl`` from\n source (a Git checkout or an sdist), they may pass a ``config_settings``\n flag ``--pure-python``. If this flag is not set, a C-extension will be built\n and included into the distribution.\n\n Here is how this can be done with ``pip``:\n\n .. code-block:: console\n\n $ python -m pip install . --config-settings=--pure-python=false\n\n This will also work with ``-e | --editable``.\n\n The same can be achieved via ``pypa/build``:\n\n .. code-block:: console\n\n $ python -m build --config-setting=--pure-python=false\n\n Adding ``-w | --wheel`` can force ``pypa/build`` produce a wheel from source\n directly, as opposed to building an ``sdist`` and then building from it. (`#893 `__)\n\n .. attention::\n\n v1.9.3 was the only version using the ``--pure-python`` setting name.\n Later versions dropped the ``--`` prefix, making it just ``pure-python``.\n\n- Declared Python 3.12 supported officially in the distribution package metadata\n -- by `@edgarrmondragon `__. (`#942 `__)\n\n\nContributor-facing changes\n--------------------------\n\n- A regression test for no-host URLs was added per `#821 `__\n and ``3986`` -- by `@kenballus `__. (`#821 `__, `#822 `__)\n- Started testing *yarl* against Python 3.12 in CI -- by `@mjpieters `__. (`#881 `__)\n- All Python 3.12 jobs are now marked as required to pass in CI\n -- by `@edgarrmondragon `__. (`#942 `__)\n- MyST is now integrated in Sphinx -- by `@webknjaz `__.\n\n This allows the contributors to author new documents in Markdown\n when they have difficulties with going straight RST. (`#953 `__)\n\n\n1.9.2 (2023-04-25)\n==================\n\nBugfixes\n--------\n\n- Fix regression with ``yarl.URL.__truediv__()`` and absolute URLs with empty paths causing the raw path to lack the leading ``/``.\n (`#854 `_)\n\n\n1.9.1 (2023-04-21)\n==================\n\nBugfixes\n--------\n\n- Marked tests that fail on older Python patch releases (< 3.7.10, < 3.8.8 and < 3.9.2) as expected to fail due to missing a security fix for CVE-2021-23336. (`#850 `_)\n\n\n1.9.0 (2023-04-19)\n==================\n\nThis release was never published to PyPI, due to issues with the build process.\n\nFeatures\n--------\n\n- Added ``URL.joinpath(*elements)``, to create a new URL appending multiple path elements. (`#704 `_)\n- Made ``URL.__truediv__()()`` return ``NotImplemented`` if called with an\n unsupported type — by `@michaeljpeters `__.\n (`#832 `_)\n\n\nBugfixes\n--------\n\n- Path normalization for absolute URLs no longer raises a ValueError exception\n when ``..`` segments would otherwise go beyond the URL path root.\n (`#536 `_)\n- Fixed an issue with update_query() not getting rid of the query when argument is None. (`#792 `_)\n- Added some input restrictions on with_port() function to prevent invalid boolean inputs or out of valid port inputs; handled incorrect 0 port representation. (`#793 `_)\n- Made ``yarl.URL.build()`` raise a ``TypeError`` if the ``host`` argument is ``None`` — by `@paulpapacz `__. (`#808 `_)\n- Fixed an issue with ``update_query()`` getting rid of the query when the argument\n is empty but not ``None``. (`#845 `_)\n\n\nMisc\n----\n\n- `#220 `_\n\n\n1.8.2 (2022-12-03)\n==================\n\nThis is the first release that started shipping wheels for Python 3.11.\n\n\n1.8.1 (2022-08-01)\n==================\n\nMisc\n----\n\n- `#694 `_, `#699 `_, `#700 `_, `#701 `_, `#702 `_, `#703 `_, `#739 `_\n\n\n1.8.0 (2022-08-01)\n==================\n\nFeatures\n--------\n\n- Added ``URL.raw_suffix``, ``URL.suffix``, ``URL.raw_suffixes``, ``URL.suffixes``, ``URL.with_suffix``. (`#613 `_)\n\n\nImproved Documentation\n----------------------\n\n- Fixed broken internal references to ``yarl.URL.human_repr()``.\n (`#665 `_)\n- Fixed broken external references to ``multidict:index`` docs. (`#665 `_)\n\n\nDeprecations and Removals\n-------------------------\n\n- Dropped Python 3.6 support. (`#672 `_)\n\n\nMisc\n----\n\n- `#646 `_, `#699 `_, `#701 `_\n\n\n1.7.2 (2021-11-01)\n==================\n\nBugfixes\n--------\n\n- Changed call in ``with_port()`` to stop reencoding parts of the URL that were already encoded. (`#623 `_)\n\n\n1.7.1 (2021-10-07)\n==================\n\nBugfixes\n--------\n\n- Fix 1.7.0 build error\n\n1.7.0 (2021-10-06)\n==================\n\nFeatures\n--------\n\n- Add ``__bytes__()`` magic method so that ``bytes(url)`` will work and use optimal ASCII encoding.\n (`#582 `_)\n- Started shipping platform-specific arm64 wheels for Apple Silicon. (`#622 `_)\n- Started shipping platform-specific wheels with the ``musl`` tag targeting typical Alpine Linux runtimes. (`#622 `_)\n- Added support for Python 3.10. (`#622 `_)\n\n\n1.6.3 (2020-11-14)\n==================\n\nBugfixes\n--------\n\n- No longer loose characters when decoding incorrect percent-sequences (like ``%e2%82%f8``). All non-decodable percent-sequences are now preserved.\n `#517 `_\n- Provide x86 Windows wheels.\n `#535 `_\n\n\n----\n\n\n1.6.2 (2020-10-12)\n==================\n\n\nBugfixes\n--------\n\n- Provide generated ``.c`` files in TarBall distribution.\n `#530 `_\n\n1.6.1 (2020-10-12)\n==================\n\nFeatures\n--------\n\n- Provide wheels for ``aarch64``, ``i686``, ``ppc64le``, ``s390x`` architectures on\n Linux as well as ``x86_64``.\n `#507 `_\n- Provide wheels for Python 3.9.\n `#526 `_\n\nBugfixes\n--------\n\n- ``human_repr()`` now always produces valid representation equivalent to the original URL (if the original URL is valid).\n `#511 `_\n- Fixed requoting a single percent followed by a percent-encoded character in the Cython implementation.\n `#514 `_\n- Fix ValueError when decoding ``%`` which is not followed by two hexadecimal digits.\n `#516 `_\n- Fix decoding ``%`` followed by a space and hexadecimal digit.\n `#520 `_\n- Fix annotation of ``with_query()``/``update_query()`` methods for ``key=[val1, val2]`` case.\n `#528 `_\n\nRemoval\n-------\n\n- Drop Python 3.5 support; Python 3.6 is the minimal supported Python version.\n\n\n----\n\n\n1.6.0 (2020-09-23)\n==================\n\nFeatures\n--------\n\n- Allow for int and float subclasses in query, while still denying bool.\n `#492 `_\n\n\nBugfixes\n--------\n\n- Do not requote arguments in ``URL.build()``, ``with_xxx()`` and in ``/`` operator.\n `#502 `_\n- Keep IPv6 brackets in ``origin()``.\n `#504 `_\n\n\n----\n\n\n1.5.1 (2020-08-01)\n==================\n\nBugfixes\n--------\n\n- Fix including relocated internal ``yarl._quoting_c`` C-extension into published PyPI dists.\n `#485 `_\n\n\nMisc\n----\n\n- `#484 `_\n\n\n----\n\n\n1.5.0 (2020-07-26)\n==================\n\nFeatures\n--------\n\n- Convert host to lowercase on URL building.\n `#386 `_\n- Allow using ``mod`` operator (``%``) for updating query string (an alias for ``update_query()`` method).\n `#435 `_\n- Allow use of sequences such as ``list`` and ``tuple`` in the values\n of a mapping such as ``dict`` to represent that a key has many values::\n\n url = URL(\"http://example.com\")\n assert url.with_query({\"a\": [1, 2]}) == URL(\"http://example.com/?a=1&a=2\")\n\n `#443 `_\n- Support ``URL.build()`` with scheme and path (creates a relative URL).\n `#464 `_\n- Cache slow IDNA encode/decode calls.\n `#476 `_\n- Add ``@final`` / ``Final`` type hints\n `#477 `_\n- Support URL authority/raw_authority properties and authority argument of ``URL.build()`` method.\n `#478 `_\n- Hide the library implementation details, make the exposed public list very clean.\n `#483 `_\n\n\nBugfixes\n--------\n\n- Fix tests with newer Python (3.7.6, 3.8.1 and 3.9.0+).\n `#409 `_\n- Fix a bug where query component, passed in a form of mapping or sequence, is unquoted in unexpected way.\n `#426 `_\n- Hide ``Query`` and ``QueryVariable`` type aliases in ``__init__.pyi``, now they are prefixed with underscore.\n `#431 `_\n- Keep IPv6 brackets after updating port/user/password.\n `#451 `_\n\n\n----\n\n\n1.4.2 (2019-12-05)\n==================\n\nFeatures\n--------\n\n- Workaround for missing ``str.isascii()`` in Python 3.6\n `#389 `_\n\n\n----\n\n\n1.4.1 (2019-11-29)\n==================\n\n* Fix regression, make the library work on Python 3.5 and 3.6 again.\n\n1.4.0 (2019-11-29)\n==================\n\n* Distinguish an empty password in URL from a password not provided at all (#262)\n\n* Fixed annotations for optional parameters of ``URL.build`` (#309)\n\n* Use None as default value of ``user`` parameter of ``URL.build`` (#309)\n\n* Enforce building C Accelerated modules when installing from source tarball, use\n ``YARL_NO_EXTENSIONS`` environment variable for falling back to (slower) Pure Python\n implementation (#329)\n\n* Drop Python 3.5 support\n\n* Fix quoting of plus in path by pure python version (#339)\n\n* Don't create a new URL if fragment is unchanged (#292)\n\n* Included in error message the path that produces starting slash forbidden error (#376)\n\n* Skip slow IDNA encoding for ASCII-only strings (#387)\n\n\n1.3.0 (2018-12-11)\n==================\n\n* Fix annotations for ``query`` parameter (#207)\n\n* An incoming query sequence can have int variables (the same as for\n Mapping type) (#208)\n\n* Add ``URL.explicit_port`` property (#218)\n\n* Give a friendlier error when port can't be converted to int (#168)\n\n* ``bool(URL())`` now returns ``False`` (#272)\n\n1.2.6 (2018-06-14)\n==================\n\n* Drop Python 3.4 trove classifier (#205)\n\n1.2.5 (2018-05-23)\n==================\n\n* Fix annotations for ``build`` (#199)\n\n1.2.4 (2018-05-08)\n==================\n\n* Fix annotations for ``cached_property`` (#195)\n\n1.2.3 (2018-05-03)\n==================\n\n* Accept ``str`` subclasses in ``URL`` constructor (#190)\n\n1.2.2 (2018-05-01)\n==================\n\n* Fix build\n\n1.2.1 (2018-04-30)\n==================\n\n* Pin minimal required Python to 3.5.3 (#189)\n\n1.2.0 (2018-04-30)\n==================\n\n* Forbid inheritance, replace ``__init__`` with ``__new__`` (#171)\n\n* Support PEP-561 (provide type hinting marker) (#182)\n\n1.1.1 (2018-02-17)\n==================\n\n* Fix performance regression: don't encode empty ``netloc`` (#170)\n\n1.1.0 (2018-01-21)\n==================\n\n* Make pure Python quoter consistent with Cython version (#162)\n\n1.0.0 (2018-01-15)\n==================\n\n* Use fast path if quoted string does not need requoting (#154)\n\n* Speed up quoting/unquoting by ``_Quoter`` and ``_Unquoter`` classes (#155)\n\n* Drop ``yarl.quote`` and ``yarl.unquote`` public functions (#155)\n\n* Add custom string writer, reuse static buffer if available (#157)\n Code is 50-80 times faster than Pure Python version (was 4-5 times faster)\n\n* Don't recode IP zone (#144)\n\n* Support ``encoded=True`` in ``yarl.URL.build()`` (#158)\n\n* Fix updating query with multiple keys (#160)\n\n0.18.0 (2018-01-10)\n===================\n\n* Fallback to IDNA 2003 if domain name is not IDNA 2008 compatible (#152)\n\n0.17.0 (2017-12-30)\n===================\n\n* Use IDNA 2008 for domain name processing (#149)\n\n0.16.0 (2017-12-07)\n===================\n\n* Fix raising ``TypeError`` by ``url.query_string()`` after\n ``url.with_query({})`` (empty mapping) (#141)\n\n0.15.0 (2017-11-23)\n===================\n\n* Add ``raw_path_qs`` attribute (#137)\n\n0.14.2 (2017-11-14)\n===================\n\n* Restore ``strict`` parameter as no-op in ``quote`` / ``unquote``\n\n0.14.1 (2017-11-13)\n===================\n\n* Restore ``strict`` parameter as no-op for sake of compatibility with\n aiohttp 2.2\n\n0.14.0 (2017-11-11)\n===================\n\n* Drop strict mode (#123)\n\n* Fix ``\"ValueError: Unallowed PCT %\"`` when there's a ``\"%\"`` in the URL (#124)\n\n0.13.0 (2017-10-01)\n===================\n\n* Document ``encoded`` parameter (#102)\n\n* Support relative URLs like ``'?key=value'`` (#100)\n\n* Unsafe encoding for QS fixed. Encode ``;`` character in value parameter (#104)\n\n* Process passwords without user names (#95)\n\n0.12.0 (2017-06-26)\n===================\n\n* Properly support paths without leading slash in ``URL.with_path()`` (#90)\n\n* Enable type annotation checks\n\n0.11.0 (2017-06-26)\n===================\n\n* Normalize path (#86)\n\n* Clear query and fragment parts in ``.with_path()`` (#85)\n\n0.10.3 (2017-06-13)\n===================\n\n* Prevent double URL arguments unquoting (#83)\n\n0.10.2 (2017-05-05)\n===================\n\n* Unexpected hash behavior (#75)\n\n\n0.10.1 (2017-05-03)\n===================\n\n* Unexpected compare behavior (#73)\n\n* Do not quote or unquote + if not a query string. (#74)\n\n\n0.10.0 (2017-03-14)\n===================\n\n* Added ``URL.build`` class method (#58)\n\n* Added ``path_qs`` attribute (#42)\n\n\n0.9.8 (2017-02-16)\n==================\n\n* Do not quote ``:`` in path\n\n\n0.9.7 (2017-02-16)\n==================\n\n* Load from pickle without _cache (#56)\n\n* Percent-encoded pluses in path variables become spaces (#59)\n\n\n0.9.6 (2017-02-15)\n==================\n\n* Revert backward incompatible change (BaseURL)\n\n\n0.9.5 (2017-02-14)\n==================\n\n* Fix BaseURL rich comparison support\n\n\n0.9.4 (2017-02-14)\n==================\n\n* Use BaseURL\n\n\n0.9.3 (2017-02-14)\n==================\n\n* Added BaseURL\n\n\n0.9.2 (2017-02-08)\n==================\n\n* Remove debug print\n\n\n0.9.1 (2017-02-07)\n==================\n\n* Do not lose tail chars (#45)\n\n\n0.9.0 (2017-02-07)\n==================\n\n* Allow to quote ``%`` in non strict mode (#21)\n\n* Incorrect parsing of query parameters with %3B (;) inside (#34)\n\n* Fix core dumps (#41)\n\n* ``tmpbuf`` - compiling error (#43)\n\n* Added ``URL.update_path()`` method\n\n* Added ``URL.update_query()`` method (#47)\n\n\n0.8.1 (2016-12-03)\n==================\n\n* Fix broken aiohttp: revert back ``quote`` / ``unquote``.\n\n\n0.8.0 (2016-12-03)\n==================\n\n* Support more verbose error messages in ``.with_query()`` (#24)\n\n* Don't percent-encode ``@`` and ``:`` in path (#32)\n\n* Don't expose ``yarl.quote`` and ``yarl.unquote``, these functions are\n part of private API\n\n0.7.1 (2016-11-18)\n==================\n\n* Accept not only ``str`` but all classes inherited from ``str`` also (#25)\n\n0.7.0 (2016-11-07)\n==================\n\n* Accept ``int`` as value for ``.with_query()``\n\n0.6.0 (2016-11-07)\n==================\n\n* Explicitly use UTF8 encoding in ``setup.py`` (#20)\n* Properly unquote non-UTF8 strings (#19)\n\n0.5.3 (2016-11-02)\n==================\n\n* Don't use ``typing.NamedTuple`` fields but indexes on URL construction\n\n0.5.2 (2016-11-02)\n==================\n\n* Inline ``_encode`` class method\n\n0.5.1 (2016-11-02)\n==================\n\n* Make URL construction faster by removing extra classmethod calls\n\n0.5.0 (2016-11-02)\n==================\n\n* Add Cython optimization for quoting/unquoting\n* Provide binary wheels\n\n0.4.3 (2016-09-29)\n==================\n\n* Fix typing stubs\n\n0.4.2 (2016-09-29)\n==================\n\n* Expose ``quote()`` and ``unquote()`` as public API\n\n0.4.1 (2016-09-28)\n==================\n\n* Support empty values in query (``'/path?arg'``)\n\n0.4.0 (2016-09-27)\n==================\n\n* Introduce ``relative()`` (#16)\n\n0.3.2 (2016-09-27)\n==================\n\n* Typo fixes #15\n\n0.3.1 (2016-09-26)\n==================\n\n* Support sequence of pairs as ``with_query()`` parameter\n\n0.3.0 (2016-09-26)\n==================\n\n* Introduce ``is_default_port()``\n\n0.2.1 (2016-09-26)\n==================\n\n* Raise ValueError for URLs like 'http://:8080/'\n\n0.2.0 (2016-09-18)\n==================\n\n* Avoid doubling slashes when joining paths (#13)\n\n* Appending path starting from slash is forbidden (#12)\n\n0.1.4 (2016-09-09)\n==================\n\n* Add ``kwargs`` support for ``with_query()`` (#10)\n\n0.1.3 (2016-09-07)\n==================\n\n* Document ``with_query()``, ``with_fragment()`` and ``origin()``\n\n* Allow ``None`` for ``with_query()`` and ``with_fragment()``\n\n0.1.2 (2016-09-07)\n==================\n\n* Fix links, tune docs theme.\n\n0.1.1 (2016-09-06)\n==================\n\n* Update README, old version used obsolete API\n\n0.1.0 (2016-09-06)\n==================\n\n* The library was deeply refactored, bytes are gone away but all\n accepted strings are encoded if needed.\n\n0.0.1 (2016-08-30)\n==================\n\n* The first release.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":"https://github.com/aio-libs/yarl","keywords":"cython, cext, yarl","license":"Apache-2.0","license_expression":null,"license_files":["LICENSE","NOTICE"],"maintainer":"aiohttp team ","maintainer_email":"team@aiohttp.org","name":"yarl","package_url":"https://pypi.org/project/yarl/","platform":null,"project_url":"https://pypi.org/project/yarl/","project_urls":{"CI: GitHub Workflows":"https://github.com/aio-libs/yarl/actions?query=branch:master","Chat: Matrix":"https://matrix.to/#/#aio-libs:matrix.org","Chat: Matrix Space":"https://matrix.to/#/#aio-libs-space:matrix.org","Code of Conduct":"https://github.com/aio-libs/.github/blob/master/CODE_OF_CONDUCT.md","Coverage: codecov":"https://codecov.io/github/aio-libs/yarl","Docs: Changelog":"https://yarl.aio-libs.org/en/latest/changes/","Docs: RTD":"https://yarl.aio-libs.org","GitHub: issues":"https://github.com/aio-libs/yarl/issues","GitHub: repo":"https://github.com/aio-libs/yarl","Homepage":"https://github.com/aio-libs/yarl"},"provides_extra":null,"release_url":"https://pypi.org/project/yarl/1.20.0/","requires_dist":["idna>=2.0","multidict>=4.0","propcache>=0.2.1"],"requires_python":">=3.9","summary":"Yet another URL library","version":"1.20.0","yanked":false,"yanked_reason":null}

Dependencies of yarl (3).
Dependency	Optional
idna	false
multidict	false
propcache	false

Package search

yarl

project_urls

Dependencies

All package metadata

Releases