Metadata-Version: 2.0
Name: yarl
Version: 0.8.1
Summary: Yet another URL library
Home-page: https://github.com/aio-libs/yarl/
Author: Andrew Svetlov
Author-email: andrew.svetlov@gmail.com
License: Apache 2
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Dist: multidict (>=2.0)
yarl
====
.. image:: https://travis-ci.org/aio-libs/yarl.svg?branch=master
:target: https://travis-ci.org/aio-libs/yarl
:align: right
.. image:: https://codecov.io/gh/aio-libs/yarl/branch/master/graph/badge.svg
:target: https://codecov.io/gh/aio-libs/yarl
.. image:: https://badge.fury.io/py/yarl.svg
:target: https://badge.fury.io/py/yarl
.. image:: https://readthedocs.org/projects/yarl/badge/?version=latest
:target: https://yarl.readthedocs.io
.. image:: https://img.shields.io/pypi/pyversions/yarl.svg
:target: https://pypi.python.org/pypi/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*, *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.python.org/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.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 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
<https://github.com/aio-libs/yarl/issues>`_ if you have found a bug
or have some suggestion in order to improve the library.
The library uses `Travis <https://travis-ci.org/aio-libs/yarl>`_ 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.
.. _GitHub: https://github.com/aio-libs/yarl
.. _multidict: https://github.com/aio-libs/multidict
CHANGES
=======
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 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)
------------------
* 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 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.