Skip to main content

Yet another URL library

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

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, passsword, 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 libray has a rich functionality but furl object is mutable.

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

    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 transormations 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

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 sequience 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 REAMDE, old version used obsolete AIP

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


Release history Release notifications | RSS feed

Download files

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

Source Distribution

yarl-0.5.0b3.tar.gz (115.4 kB view details)

Uploaded Source

Built Distributions

yarl-0.5.0b3-cp35-cp35m-manylinux1_x86_64.whl (123.0 kB view details)

Uploaded CPython 3.5m

yarl-0.5.0b3-cp35-cp35m-manylinux1_i686.whl (117.7 kB view details)

Uploaded CPython 3.5m

yarl-0.5.0b3-cp34-cp34m-manylinux1_x86_64.whl (124.9 kB view details)

Uploaded CPython 3.4m

yarl-0.5.0b3-cp34-cp34m-manylinux1_i686.whl (119.6 kB view details)

Uploaded CPython 3.4m

File details

Details for the file yarl-0.5.0b3.tar.gz.

File metadata

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

File hashes

Hashes for yarl-0.5.0b3.tar.gz
Algorithm Hash digest
SHA256 214810193d0ddd2e49b4ac709f9a5611c2df56601a49307148a5b6894a2f19e3
MD5 2d15210d37d0e3db5af4d0b5c9d54fdb
BLAKE2b-256 8493edc9f911c658f8f8a59a448cf26e4c43a4964e9e36d389f80b84162b38b7

See more details on using hashes here.

Provenance

File details

Details for the file yarl-0.5.0b3-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for yarl-0.5.0b3-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d716e7bba908720ff043e72afd2a35430117272208e9cf6defefba5840bd9000
MD5 24266b1200d1f7da651798fddccd651c
BLAKE2b-256 17fb81972e70a3e43532715d2675100d2dbdb01c6b2997ad64e596b215a405b8

See more details on using hashes here.

Provenance

File details

Details for the file yarl-0.5.0b3-cp35-cp35m-manylinux1_i686.whl.

File metadata

File hashes

Hashes for yarl-0.5.0b3-cp35-cp35m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 a2bddd6500fabf183a0358213727b07eb66225966aae1acb18e7324710e39d56
MD5 469e1aad0b02955d9e18bcd3a986db1d
BLAKE2b-256 8edbabcb039b54d6ffe4967d9d4b7a125f42f37461b87f28fee7ebc71c2c54c1

See more details on using hashes here.

Provenance

File details

Details for the file yarl-0.5.0b3-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for yarl-0.5.0b3-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 7b712b6cafd81b4af221e5f2b964a364d7e0d099813a921cdf2b0b89ae414018
MD5 57ec302d474d98ac0fdff223087d1613
BLAKE2b-256 535236c5bccad0206d61c27b560ebefea322ab05707725d00ea06330e7c83986

See more details on using hashes here.

Provenance

File details

Details for the file yarl-0.5.0b3-cp34-cp34m-manylinux1_i686.whl.

File metadata

File hashes

Hashes for yarl-0.5.0b3-cp34-cp34m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 c322181289d42cc3b40ece5519e858c3baa71d2e459a9fb1712e0ab1c81960ae
MD5 4db5c6198dd7fbb126fcdeea7dffec3d
BLAKE2b-256 cf5ea46c358e36860550e0752582de53eaab02c41b81b8f152b944f35ddca9e2

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