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 https://img.shields.io/pypi/pyversions/yarl.svg

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

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


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.9.7.tar.gz (125.8 kB view details)

Uploaded Source

Built Distributions

yarl-0.9.7-cp35-cp35m-win_amd64.whl (81.0 kB view details)

Uploaded CPython 3.5m Windows x86-64

yarl-0.9.7-cp35-cp35m-win32.whl (77.9 kB view details)

Uploaded CPython 3.5m Windows x86

yarl-0.9.7-cp35-cp35m-manylinux1_x86_64.whl (165.3 kB view details)

Uploaded CPython 3.5m

yarl-0.9.7-cp35-cp35m-manylinux1_i686.whl (157.8 kB view details)

Uploaded CPython 3.5m

yarl-0.9.7-cp34-cp34m-win_amd64.whl (79.9 kB view details)

Uploaded CPython 3.4m Windows x86-64

yarl-0.9.7-cp34-cp34m-win32.whl (77.9 kB view details)

Uploaded CPython 3.4m Windows x86

yarl-0.9.7-cp34-cp34m-manylinux1_x86_64.whl (168.1 kB view details)

Uploaded CPython 3.4m

yarl-0.9.7-cp34-cp34m-manylinux1_i686.whl (161.0 kB view details)

Uploaded CPython 3.4m

File details

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

File metadata

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

File hashes

Hashes for yarl-0.9.7.tar.gz
Algorithm Hash digest
SHA256 4313ededdb852c65525db2ad1f2649b9274a12b1447543ebc3355b4f52d638aa
MD5 ad471458521abbac5c5a1aafc068aebf
BLAKE2b-256 14237826e2fd0947049553aeeb3937a1fe49ccfdebc70ee5b992498506ba8d84

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 3bbecd989ca4a5c78fe5f9c38e459386f69f81dc42a7c7adcb4d00a16d5c302f
MD5 642d5ab2f3f598495031bdc2697f8059
BLAKE2b-256 e0008f8f4d91fc39fcf42e9ff02ca049df0a93d3e6c262ba69181f7217c3d78e

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 1ad9f4321e59ce361cb6dcaea178510c4be27cc25527a74131d2881275ca2eb3
MD5 0a18bccb7b1bf3f52144fca4875fbb02
BLAKE2b-256 ba6f82eb9ae3a69cbbc832319d64cd7a272bcf929427fada6bf0509f04ddd165

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 968795e383107ce7546f0531c1ca5401e57d8c16d5f32f0dcdc35f5b7d094742
MD5 ce164d65794e3bfbe82ad43dd963eabb
BLAKE2b-256 6c22c4bf7e8f3b72c15349365632a5336fa4132b9991935856ee02d608adffde

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp35-cp35m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 71aa7d060b3d6a7ddb4785d46150837ca266090790f4f027a1e1fe86e139c2f9
MD5 33427665db7f327843d04db019d219aa
BLAKE2b-256 b3db05ab35600cdedf7e69c042d35d86df5bc6a3ea120344f60ff0fea3958ce1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp34-cp34m-win_amd64.whl
Algorithm Hash digest
SHA256 c3c9b18e8a27297a6b8cc3e4fbb12e5fc0b986c41b3b1553f752ed23d691be48
MD5 7dcc4f0355b880bf157fb1521e0850c5
BLAKE2b-256 89826ff94585a7f898fc42440eb8e17b2c3a423fc4c8ee3bf033a94209695e5c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp34-cp34m-win32.whl
Algorithm Hash digest
SHA256 9187d23931202489afada0d06ec216542b1d4568e39ad1c73713e58560d26826
MD5 25a875d06c375c3f43c0168b31db7b2c
BLAKE2b-256 3e3342263430fff67b968c2e741053c89b9ef6d5e2746743d13a0b09c4445e5c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 3b6cdaa6c6fe0f94382a31d90caeeb19b4f7b688e0ff4d89d85fa35f3b598d8c
MD5 f54aa438f0d2797454d7d3b1c3e0b849
BLAKE2b-256 f5a9ed34c896e4a01e70f18d7a2177da505e09144661274b30d2a39904f7f21c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.7-cp34-cp34m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 668acb5065fd2224ce64b1491e6783c09a754d35f389370467af28ba197b2b2c
MD5 4db44df71de7dd323cfd509b92269d8f
BLAKE2b-256 fc99b56ce17caa7f6a407396303b8823dd4c7c601199e64b3e5d10060b191a37

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