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

Uploaded Source

Built Distributions

yarl-0.9.4-cp35-cp35m-win_amd64.whl (80.7 kB view details)

Uploaded CPython 3.5m Windows x86-64

yarl-0.9.4-cp35-cp35m-win32.whl (77.6 kB view details)

Uploaded CPython 3.5m Windows x86

yarl-0.9.4-cp35-cp35m-manylinux1_x86_64.whl (165.1 kB view details)

Uploaded CPython 3.5m

yarl-0.9.4-cp35-cp35m-manylinux1_i686.whl (157.5 kB view details)

Uploaded CPython 3.5m

yarl-0.9.4-cp34-cp34m-win_amd64.whl (79.6 kB view details)

Uploaded CPython 3.4m Windows x86-64

yarl-0.9.4-cp34-cp34m-win32.whl (77.7 kB view details)

Uploaded CPython 3.4m Windows x86

yarl-0.9.4-cp34-cp34m-manylinux1_x86_64.whl (167.8 kB view details)

Uploaded CPython 3.4m

yarl-0.9.4-cp34-cp34m-manylinux1_i686.whl (160.7 kB view details)

Uploaded CPython 3.4m

File details

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

File metadata

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

File hashes

Hashes for yarl-0.9.4.tar.gz
Algorithm Hash digest
SHA256 e1fa6c38ecdadeb53c8d5b41c7f26dbc08bc48e6d5e6c64d257cfe987e7f1c92
MD5 e4e7581f4c3bf3c62288aa0fbd0b2c4d
BLAKE2b-256 5b8298d351b1c2bf53895e8c4cabd4053b4a33b19b05cebadf046595f7f19f4f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 315096393eabf2e9470fae82c33be3a70bc8c4199181f5ca7c8ea40642207e36
MD5 c9c0133f2b1bcec4027dcdf5d8bcef1a
BLAKE2b-256 beffb44feb26d8a634d001a14e73087d507c5a3c750ee4354540e43b35613bc9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 5397a65a9eb6f5e77a1c941ddec514d7fe9e2630fe561d392ed2ddbc2a311247
MD5 731fa69bd0bd3f0b03eae523dea026aa
BLAKE2b-256 310f931e18368721f3c8064f4d0456eb2108f10f8124c7dade6be87610e2bf0c

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d082536593e8c4191f9f9fc1e123769203baa84bb601791d3f9803aa2cf90997
MD5 4b7f3c1f80d526e93db43c64135a0b54
BLAKE2b-256 db6890e47a9a4d3fd2849017fa804f32699334628058e0a856ce466685aecc04

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp35-cp35m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 1cca8c5a5c90345edf7cf7aabca7a2c74e5dca7756347ca31060bf9b0cda244e
MD5 bbe90a250501b8ad0d376d700978a19a
BLAKE2b-256 bd1bfd993c61d7bfee89179190334966c6c9afef6c9f8960110e37c81dbbbc83

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp34-cp34m-win_amd64.whl
Algorithm Hash digest
SHA256 b377cdd159d8517d6f74f578dfe38f13adc349a27bbb9eadb578eba310f0b0b7
MD5 b1bac387c579c59066b801e70a7a4850
BLAKE2b-256 01be6252dc12aee2298f430a9533a4161d73f84195a49dedc0af8c21b11caa1b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp34-cp34m-win32.whl
Algorithm Hash digest
SHA256 982343855ab624e85cfd00291160bd70e3ed68b84b8df2e3acb5df3c71b7e0b6
MD5 fc54a1747a9fd441ce0247872e73fa7f
BLAKE2b-256 782fce8ccf225051f23cb233c9735909291fcb1a9608f1e29b58167610fe6ecd

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 d4580ae96e49b3d0cd308a0f37b04300eeff93d3e02410bf9d4d847d702ca66e
MD5 424e8797fb4bbfde46bac3c6fabf6229
BLAKE2b-256 4c520da0dcba0fa5bc4eed8b4c8da1306506d03caa25cc855ae90f8fa26b75fa

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for yarl-0.9.4-cp34-cp34m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 c043ae4d4ce278205c7a54f8f1ed77c17dad0e832cacca38c8ae5ed12b2693af
MD5 c9e491bb319fc7acf0315cad31606090
BLAKE2b-256 0788d8e064c44761b2bc875106e02d5194f477dd8bcd3b33dd0fd7d766c8cef0

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