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, 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.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 counstruction 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 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.7.1.tar.gz (117.9 kB view details)

Uploaded Source

Built Distributions

yarl-0.7.1-cp35-cp35m-win_amd64.whl (70.6 kB view details)

Uploaded CPython 3.5m Windows x86-64

yarl-0.7.1-cp35-cp35m-win32.whl (68.1 kB view details)

Uploaded CPython 3.5m Windows x86

yarl-0.7.1-cp35-cp35m-manylinux1_x86_64.whl (130.5 kB view details)

Uploaded CPython 3.5m

yarl-0.7.1-cp35-cp35m-manylinux1_i686.whl (124.8 kB view details)

Uploaded CPython 3.5m

yarl-0.7.1-cp34-cp34m-win_amd64.whl (69.4 kB view details)

Uploaded CPython 3.4m Windows x86-64

yarl-0.7.1-cp34-cp34m-win32.whl (67.9 kB view details)

Uploaded CPython 3.4m Windows x86

yarl-0.7.1-cp34-cp34m-manylinux1_x86_64.whl (132.4 kB view details)

Uploaded CPython 3.4m

yarl-0.7.1-cp34-cp34m-manylinux1_i686.whl (126.3 kB view details)

Uploaded CPython 3.4m

File details

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

File metadata

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

File hashes

Hashes for yarl-0.7.1.tar.gz
Algorithm Hash digest
SHA256 0fb975fa020d8ea44523efa1be92360fe4707d86e6e10980b36e2e440d073ef7
MD5 265b20d6844bb17aa89134c568abe5b6
BLAKE2b-256 e6d10de27bc2350e679ac0f241f6641f75229e5b88ae8a7a0f2b8f79c871afca

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 0718dd0aef4c155de13d63e4ba153fcea4653c9ed3f66b222af447b1c8381d97
MD5 db26920c16d568d680f5188c5ad8f34b
BLAKE2b-256 1e474f06f516b75864fc33fb70c6b5f33f8311ce5d223389ce129a97ecb1f27c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 3b955c304fde409fef3a8ad717f9fb29b944a57b36923d28046fcab49b8bfd8f
MD5 331a2cbf03dd3e0d097e656101171d7d
BLAKE2b-256 75168f1b680276400fcbae721a5771bcb84229b1e351476af6e54b0d0ca46e7b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 11914bf4e8a4b1aca44a3a2ba0600ab58cf2ff9985b8277f51aedddbd6aaa7de
MD5 9ea1202fceeb74593e70f3030e86db4e
BLAKE2b-256 f3f1acf529c33d68aa82e49b9ad67c3a818933efa852f264b0042e92c0d1eb63

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp35-cp35m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 21df2a1f39afb4b1b4fc7bcd86b5ea426fb9137188e637483f9c02f314c11cd2
MD5 558dd0ccc30913bd68152a6975ab77fa
BLAKE2b-256 00ea9d457639df96eba137c7ce8e86897e76c68fae4b4d15bf5bab28e2e04e89

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp34-cp34m-win_amd64.whl
Algorithm Hash digest
SHA256 86ec66faf8f3d5522ea7f04f1730135880ee67ea2baa618c9f0f82e1c305683a
MD5 b45ecabe521a8cb752548915d11b2212
BLAKE2b-256 bea0f82c07bfdf08bad22203c8be0958a5efd7b794087d0e5af131fc9a6a7dc4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp34-cp34m-win32.whl
Algorithm Hash digest
SHA256 f7534b6529d0fc43aa3203d482cf1ef39c8a034605f6f6d209db9e8bf8059437
MD5 4a69fe79389765cd17050e12b336a8ab
BLAKE2b-256 fd4b8504c4445fdb3efae7cb850efa5d57f626e7ad6b532d9f8af938d359fee7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 483b153315bb077b86252585581d261df11157ddcd1a6808d285bbd81b89ac8a
MD5 463a07372fcec6d41b071794770dd719
BLAKE2b-256 63f722b729698ced8f6b937c8454e0b456778aa41954b1e9db2f6dcfac87d782

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.7.1-cp34-cp34m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 16ea38d44b21f12189f9bf22f1e4c25d2e19bc4e6d87ed90ccbf19533a575a3e
MD5 59dbced04c9b0b9934e641b3319b669f
BLAKE2b-256 0f4de1433bb3c8614b66330f862a44b520a6fe474072c4cc58f52bce334386ad

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