Yet another URL library

Navigation

Verified details

These details have been verified by PyPI
Owner
organization icon aio-libs
Maintainers
Avatar for Andrew.Svetlov from gravatar.com Andrew.Svetlov Avatar for webknjaz from gravatar.com webknjaz

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

yarl

https://travis-ci.org/aio-libs/yarl.svg?branch=master https://codecov.io/gh/aio-libs/yarl/branch/master/graph/badge.svg https://badge.fury.io/py/yarl.svg https://readthedocs.org/projects/yarl/badge/?version=latest https://img.shields.io/pypi/pyversions/yarl.svg Chat on Gitter

Introduction

Url is constructed from str:

>>> from yarl import URL
>>> url = URL('https://www.python.org/~guido?arg=1#frag')
>>> url
URL('https://www.python.org/~guido?arg=1#frag')

All url parts: scheme, user, password, host, port, path, query and fragment are accessible by properties:

>>> url.scheme
'https'
>>> url.host
'www.python.org'
>>> url.path
'/~guido'
>>> url.query_string
'arg=1'
>>> url.query
<MultiDictProxy('arg': '1')>
>>> url.fragment
'frag'

All url manipulations produces a new url object:

>>> url.parent / 'downloads/source'
URL('https://www.python.org/downloads/source')

Strings passed to constructor and modification methods are automatically encoded giving canonical representation as result:

>>> url = URL('https://www.python.org/путь')
>>> url
URL('https://www.python.org/%D0%BF%D1%83%D1%82%D1%8C')

Regular properties are percent-decoded, use raw_ versions for getting encoded strings:

>>> url.path
'/путь'

>>> url.raw_path
'/%D0%BF%D1%83%D1%82%D1%8C'

Human readable representation of URL is available as .human_repr():

>>> url.human_repr()
'https://www.python.org/путь'

For full documentation please read https://yarl.readthedocs.org.

Installation

$ pip install yarl

The library is Python 3 only!

Dependencies

YARL requires multidict library.

API documentation

The documentation is located at https://yarl.readthedocs.org

Comparison with other URL libraries

  • furl (https://pypi-hypernode.com/pypi/furl)

    The library has a rich functionality but furl object is mutable.

    I afraid to pass this object into foreign code: who knows if the code will modify my url in a terrible way while I just want to send URL with handy helpers for accessing URL properties.

    furl has other non obvious tricky things but the main objection is mutability.

  • URLObject (https://pypi-hypernode.com/pypi/URLObject)

    URLObject is immutable, that’s pretty good.

    Every URL change generates a new URL object.

    But the library doesn’t any decode/encode transformations leaving end user to cope with these gory details.

Source code

The project is hosted on GitHub

Please file an issue on the bug tracker if you have found a bug or have some suggestion in order to improve the library.

The library uses Travis for Continuous Integration.

Discussion list

aio-libs google group: https://groups.google.com/forum/#!forum/aio-libs

Feel free to post your questions and ideas here.

Authors and License

The yarl package is written by Andrew Svetlov.

It’s Apache 2 licensed and freely available.

CHANGES

1.1.0 (2018-01-21)

  • Make pure Python quoter consistent with Cython version (#162)

1.0.0 (2018-01-15)

  • Use fast path if quoted string does not need requoting (#154)

  • Speed up quoting/unquoting by _Quoter and _Unquoter classes (#155)

  • Drop yarl.quote and yarl.unquote public functions (#155)

  • Add custom string writer, reuse static buffer if available (#157) Code is 50-80 times faster than Pure Python version (was 4-5 times faster)

  • Don’t recode IP zone (#144)

  • Support encoded=True in yarl.URL.build() (#158)

  • Fix updating query with multiple keys (#160)

0.18.0 (2018-01-10)

  • Fallback to IDNA 2003 if domain name is not IDNA 2008 compatible (#152)

0.17.0 (2017-12-30)

  • Use IDNA 2008 for domain name processing (#149)

0.16.0 (2017-12-07)

  • Fix raising TypeError by url.query_string() after url.with_query({}) (empty mapping) (#141)

0.15.0 (2017-11-23)

  • Add raw_path_qs attribute (#137)

0.14.2 (2017-11-14)

  • Restore strict parameter as no-op in quote/unquote

0.14.1 (2017-11-13)

  • Restore strict parameter as no-op for sake of compatibility with aiohttp 2.2

0.14.0 (2017-11-11)

  • Drop strict mode (#123)

  • Fix “ValueError: Unallowed PCT %” when there’s a “%” in the url (#124)

0.13.0 (2017-10-01)

  • Document encoded parameter (#102)

  • Support relative urls like ‘?key=value’ (#100)

  • Unsafe encoding for QS fixed. Encode ; char in value param (#104)

  • Process passwords without user names (#95)

0.12.0 (2017-06-26)

  • Properly support paths without leading slash in URL.with_path() (#90)

  • Enable type annotation checks

0.11.0 (2017-06-26)

  • Normalize path (#86)

  • Clear query and fragment parts in .with_path() (#85)

0.10.3 (2017-06-13)

  • Prevent double URL args unquoting (#83)

0.10.2 (2017-05-05)

  • Unexpected hash behaviour (#75)

0.10.1 (2017-05-03)

  • Unexpected compare behaviour (#73)

  • Do not quote or unquote + if not a query string. (#74)

0.10.0 (2017-03-14)

  • Added URL.build class method (#58)

  • Added path_qs attribute (#42)

0.9.8 (2017-02-16)

  • Do not quote “:” in path

0.9.7 (2017-02-16)

  • Load from pickle without _cache (#56)

  • Percent-encoded pluses in path variables become spaces (#59)

0.9.6 (2017-02-15)

  • Revert backward incompatible change (BaseURL)

0.9.5 (2017-02-14)

  • Fix BaseURL rich comparison support

0.9.4 (2017-02-14)

  • Use BaseURL

0.9.3 (2017-02-14)

  • Added BaseURL

0.9.2 (2017-02-08)

  • Remove debug print

0.9.1 (2017-02-07)

  • Do not lose tail chars (#45)

0.9.0 (2017-02-07)

  • Allow to quote % in non strict mode (#21)

  • Incorrect parsing of query parameters with %3B (;) inside (#34)

  • core dumps (#41)

  • tmpbuf - compiling error (#43)

  • Added URL.update_path() method

  • Added URL.update_query() method (#47)

0.8.1 (2016-12-03)

  • Fix broken aiohttp: revert back quote / unquote.

0.8.0 (2016-12-03)

  • Support more verbose error messages in .with_query() (#24)

  • Don’t percent-encode @ and : in path (#32)

  • Don’t expose yarl.quote and yarl.unquote, these functions are part of private API

0.7.1 (2016-11-18)

  • Accept not only str but all classes inherited from str also (#25)

0.7.0 (2016-11-07)

  • Accept int as value for .with_query()

0.6.0 (2016-11-07)

  • Explicitly use UTF8 encoding in setup.py (#20)

  • Properly unquote non-UTF8 strings (#19)

0.5.3 (2016-11-02)

  • Don’t use namedtuple fields but indexes on URL construction

0.5.2 (2016-11-02)

  • Inline _encode class method

0.5.1 (2016-11-02)

  • Make URL construction faster by removing extra classmethod calls

0.5.0 (2016-11-02)

  • Add cython optimization for quoting/unquoting

  • Provide binary wheels

0.4.3 (2016-09-29)

  • Fix typing stubs

0.4.2 (2016-09-29)

  • Expose quote() and unquote() as public API

0.4.1 (2016-09-28)

  • Support empty values in query (‘/path?arg’)

0.4.0 (2016-09-27)

  • Introduce relative() (#16)

0.3.2 (2016-09-27)

  • Typo fixes #15

0.3.1 (2016-09-26)

  • Support sequence of pairs as with_query() parameter

0.3.0 (2016-09-26)

  • Introduce is_default_port()

0.2.1 (2016-09-26)

0.2.0 (2016-09-18)

  • Avoid doubling slashes when joining paths (#13)

  • Appending path starting from slash is forbidden (#12)

0.1.4 (2016-09-09)

  • Add kwargs support for with_query() (#10)

0.1.3 (2016-09-07)

  • Document with_query(), with_fragment() and origin()

  • Allow None for with_query() and with_fragment()

0.1.2 (2016-09-07)

  • Fix links, tune docs theme.

0.1.1 (2016-09-06)

  • Update README, old version used obsolete API

0.1.0 (2016-09-06)

  • The library was deeply refactored, bytes are gone away but all accepted strings are encoded if needed.

0.0.1 (2016-08-30)

  • The first release.

Project details

Verified details

These details have been verified by PyPI
Owner
organization icon aio-libs
Maintainers
Avatar for Andrew.Svetlov from gravatar.com Andrew.Svetlov Avatar for webknjaz from gravatar.com webknjaz

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.17.1

1.17.0

1.16.0

1.16.0rc0 pre-release

1.15.5

1.15.4

1.15.3

1.15.2

1.15.1

1.15.0

1.14.0

1.13.1

1.13.0

1.12.1

1.12.0

1.11.1

1.11.0

1.10.0

1.9.11

1.9.10

1.9.9

1.9.8

1.9.8rc0 pre-release

1.9.7

1.9.6 yanked

Reason this release was yanked:

Performance regression: https://github.com/aio-libs/yarl/pull/1198

1.9.5 yanked

Reason this release was yanked:

Performance regression: https://github.com/aio-libs/yarl/pull/1198

1.9.4

1.9.3

1.9.2

1.9.1

1.8.2

1.8.1

1.8.0

1.7.2

1.7.0

1.7.0a4 pre-release

1.7.0a3 pre-release

1.7.0a0 pre-release

1.6.3

1.6.2

1.6.1

1.6.0

1.5.1

1.5.0 yanked

Reason this release was yanked:

Cython generated files are broken, please upgrade to 1.5.1

1.4.2

1.4.1

1.4.0

1.4.0b1 pre-release

1.4.0a11 pre-release

1.4.0a10 pre-release

1.4.0a9 pre-release

1.4.0a0 pre-release

1.3.0

1.2.6

1.2.5

1.2.5a5 pre-release

1.2.5a4 pre-release

1.2.5a3 pre-release

1.2.5a2 pre-release

1.2.5a1 pre-release

1.2.5a0 pre-release

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.1

This version

1.1.0

1.0.0

0.18.0

0.17.0

0.16.0

0.15.0

0.14.2

0.14.1

0.14.0

0.13.0

0.12.0

0.11.1

0.11.0

0.10.3

0.10.2

0.10.1

0.10.0

0.9.8

0.9.7

0.9.6

0.9.5

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.8.1

0.8.0

0.7.1

0.7.0

0.6.0

0.5.3

0.5.2

0.5.1

0.5.0

0.5.0b5 pre-release

0.5.0b4 pre-release

0.5.0b3 pre-release

0.5.0b2 pre-release

0.5.0b1 pre-release

0.5.0b0 pre-release

0.4.3

0.4.2

0.4.1

0.4.0

0.3.2

0.3.1

0.3.0

0.2.1

0.2.0

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yarl-1.1.0.tar.gz (156.2 kB view details)

Uploaded Source

Built Distributions

yarl-1.1.0-cp36-cp36m-win_amd64.whl (119.1 kB view details)

Uploaded CPython 3.6m Windows x86-64

yarl-1.1.0-cp36-cp36m-win32.whl (113.5 kB view details)

Uploaded CPython 3.6m Windows x86

yarl-1.1.0-cp36-cp36m-manylinux1_x86_64.whl (255.2 kB view details)

Uploaded CPython 3.6m

yarl-1.1.0-cp36-cp36m-manylinux1_i686.whl (247.4 kB view details)

Uploaded CPython 3.6m

yarl-1.1.0-cp35-cp35m-win_amd64.whl (118.6 kB view details)

Uploaded CPython 3.5m Windows x86-64

yarl-1.1.0-cp35-cp35m-win32.whl (113.2 kB view details)

Uploaded CPython 3.5m Windows x86

yarl-1.1.0-cp35-cp35m-manylinux1_x86_64.whl (250.2 kB view details)

Uploaded CPython 3.5m

yarl-1.1.0-cp35-cp35m-manylinux1_i686.whl (242.0 kB view details)

Uploaded CPython 3.5m

yarl-1.1.0-cp34-cp34m-win_amd64.whl (118.0 kB view details)

Uploaded CPython 3.4m Windows x86-64

yarl-1.1.0-cp34-cp34m-win32.whl (113.9 kB view details)

Uploaded CPython 3.4m Windows x86

yarl-1.1.0-cp34-cp34m-manylinux1_x86_64.whl (252.1 kB view details)

Uploaded CPython 3.4m

yarl-1.1.0-cp34-cp34m-manylinux1_i686.whl (243.7 kB view details)

Uploaded CPython 3.4m

File details

Details for the file yarl-1.1.0.tar.gz.

File metadata

  • Download URL: yarl-1.1.0.tar.gz
  • Upload date:
  • Size: 156.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for yarl-1.1.0.tar.gz
Algorithm Hash digest
SHA256 6af895b45bd49254cc309ac0fe6e1595636a024953d710e01114257736184698
MD5 d0337b9c56af38ca66281c31ab58c125
BLAKE2b-256 a30805b2d731ef5163b3bcb993f569c4d2b303642f7ee3cbdea373f59e4bd42a

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp36-cp36m-win_amd64.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 f96d8bd39ee85cb9e842e3c7ad8c7cfb875bebfe07d63e87ca3e3984cb2f1546
MD5 23757f97d3d7a631090a2ef353b86396
BLAKE2b-256 e101d0d6ef91dc7855713ea4fadcf91e86b66fa56ea6502fcc2e0f2d400c62ae

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp36-cp36m-win32.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp36-cp36m-win32.whl
Algorithm Hash digest
SHA256 2aec0ae0c50997e1a7af3ada4983e11caf212eee73eff6876ce26cf3a5072644
MD5 2b7adf5c88535bd153f7b745bcec1e37
BLAKE2b-256 b7aaa42eabd32ebd76cca2758edb0782adbd301875644cc758ae61a7da739e91

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c4c7682551c0b10b5c6fe0e359745759bd6298ab5839d9433ad0ed820def0d40
MD5 92f9c1e8f65f4ea7f134c478115eb0ca
BLAKE2b-256 9afe1fc0d9e277f1ff0d29ac44742f769c55f12cc7e66a89ab340f5321937179

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp36-cp36m-manylinux1_i686.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp36-cp36m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 9d25d6d6865979a5216b5bc2b9bd913dbaff636f74411baaa3e79c708ebeafbb
MD5 9e16120ca7e0b25ca8a7c640be85139e
BLAKE2b-256 2bdad020e813490d0c2d683183957fb2bc5c8568e7905ea3b5dac4060a3113e5

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp35-cp35m-win_amd64.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 c9adaa61e1d9487c69f40561a89fc68640dba05e014ed29315b586e106a95671
MD5 cc80a8d864c58732ae4bf7d47f1f24a1
BLAKE2b-256 d7abe6f3ab97e0c84d350ce5dd87ee49d212f5ff2601afcfd09da0b9d07409de

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp35-cp35m-win32.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 1f96aa307067766c3edfc075739e5da8c790178d98f95e033fc8e22b8f2bc920
MD5 88a89e5d82cf77731926535ac7ff04a5
BLAKE2b-256 ef814b9d1fe27aacb842e5ff924f9abf7d38dedab724f77bac5beaed79474fc8

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0a5d90f6d6ed6204e58b9d10882ef1a1193010e76e744ba39e848e8ddf96ab7a
MD5 0ec04a3b9309a13da5151d2488c3b75d
BLAKE2b-256 50ca990e55e5e0c4415d56c5f5c6ef3f7fc650d07aa15cb9bbeace9877eb6508

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp35-cp35m-manylinux1_i686.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp35-cp35m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 f00d067a08836c03646ace00baaf59697e978d2f1958b090c3a098c59221e175
MD5 54b4e9287db4f73ddd674f9039c28ff6
BLAKE2b-256 a226164a238e8feae78a9cef2d863e65872fba141ad66ebc37ce0b47caa8a489

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp34-cp34m-win_amd64.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp34-cp34m-win_amd64.whl
Algorithm Hash digest
SHA256 e2dbf932bc9519281393973187075f1c2261a9e58032265ae47b2e79ece30ad8
MD5 808174ccb1386b02d33cbb6077d058fa
BLAKE2b-256 a785af1f81f65f920d88af4dc3886045bcb3d4e00dacd06d423ebfccbaa45052

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp34-cp34m-win32.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp34-cp34m-win32.whl
Algorithm Hash digest
SHA256 d861e697e4f1dbd614c29c7594f0dd3dbc48144f1e1f9ed8380604c7dde6cb19
MD5 7a5f1390f7a76d794ce45117db8a6524
BLAKE2b-256 5a008ff33cf958636913b1ae25c52b6971a4608c9edc4d4badcb38d671f05cc5

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 42a7fc3d31c4c5b7fb7102380e1518e5af88e3bec7e89acf1213973e880bff6f
MD5 c1c536f6ccc1eea493d9ad905e65a2c7
BLAKE2b-256 52c845e40b583cda9420861fd44b5155b86fe9fa7e2a5ace6f626cb64182dcdf

See more details on using hashes here.

Provenance

File details

Details for the file yarl-1.1.0-cp34-cp34m-manylinux1_i686.whl.

File metadata

File hashes

Hashes for yarl-1.1.0-cp34-cp34m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 e938046ce94bcb21e4641712eee3f3c211fc1e5a4601fd89c031e638022097a3
MD5 0d5c355dd8026dde1ddf3a6850c98a3a
BLAKE2b-256 2cd80f979b1b6a6b9c7ccbaf5d2a704aaa0034d14477a778756738e623296c32

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page