yarl 0.13.0

Yet another URL library

yarl

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.python.org/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.python.org/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.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)

• Raise ValueError for URLs like ‘http://:8080/’

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.