pyquery: a jquery-like library for python

.. image:: https://github.com/gawel/pyquery/actions/workflows/tox.yml/badge.svg
:alt: Build Status
:target: https://github.com/gawel/pyquery/actions/workflows/tox.yml

pyquery allows you to make jquery queries on xml documents.
The API is as much as possible similar to jquery. pyquery uses lxml for fast
xml and html manipulation.

This is not (or at least not yet) a library to produce or interact with
javascript code. I just liked the jquery API and I missed it in python so I
told myself "Hey let's make jquery in python". This is the result.

The project_ is being actively developed on a git repository on Github. I
have the policy of giving push access to anyone who wants it and then reviewing
what they do. So if you want to contribute just email me.

Please report bugs on the github <https://github.com/gawel/pyquery/issues>_ issue
tracker.

.. _deliverance: http://www.gawel.org/weblog/en/2008/12/skinning-with-pyquery-and-deliverance
.. _project: https://github.com/gawel/pyquery/

..

(urlopen, your_url, path_to_html_file) = getfixture('readme_fixt')

Quickstart

You can use the PyQuery class to load an xml document from a string, a lxml
document, from a file or from an url::

>>> from pyquery import PyQuery as pq
>>> from lxml import etree
>>> import urllib
>>> d = pq("<html></html>")
>>> d = pq(etree.fromstring("<html></html>"))
>>> d = pq(url=your_url)
>>> d = pq(url=your_url,
...        opener=lambda url, **kw: urlopen(url).read())
>>> d = pq(filename=path_to_html_file)

Now d is like the $ in jquery::

>>> d("#hello")
[<p#hello.hello>]
>>> p = d("#hello")
>>> print(p.html())
Hello world !
>>> p.html("you know <a href='http://python.org/'>Python</a> rocks")
[<p#hello.hello>]
>>> print(p.html())
you know <a href="http://python.org/">Python</a> rocks
>>> print(p.text())
you know Python rocks

You can use some of the pseudo classes that are available in jQuery but that
are not standard in css such as :first :last :even :odd :eq :lt :gt :checked
:selected :file::

>>> d('p:first')
[<p#hello.hello>]

See http://pyquery.rtfd.org/ for the full documentation

News

2.0.1 (2024-08-30)

Breaking change: its seems no longer possible to use the html parser with a xml file so its no longer tested
Drop support for python 3.7

2.0.0 (2022-12-28)

Breaking change: inputs starting with "http://" or "https://" like
PyQuery("http://example.com") will no longer fetch the contents of the URL.
Users desiring the old behavior should switch to PyQuery(url="http://example.com").
Add nextUntil method
.remove() no longer inserts a space in place of the removed element
Fix escaping of top-level element text in .html() output
Support (and require) cssselect 1.2+
Drop support for python 3.5/3.6

1.4.3 (2020-11-21)

No longer use a universal wheel

1.4.2 (2020-11-21)

Fix exception raised when calling PyQuery("<textarea></textarea>").text()
python2 is no longer supported

1.4.1 (2019-10-26)

This is the latest release with py2 support
Remove py33, py34 support
web scraping improvements: default timeout and session support
Add API methods to serialize form-related elements according to spec
Include HTML markup when querying textarea text/value

1.4.0 (2018-01-11)

Refactoring of .text() to match firefox behavior.

1.3.0 (2017-10-21)

Remove some unmaintained modules: pyquery.ajax and pyquery.rules
Code cleanup. No longer use ugly hacks required by python2.6/python3.2.
Run tests with python3.6 on CI
Add a method argument to .outer_html()

1.2.17 (2016-10-14)

PyQuery('<input value="">').val() is ''
PyQuery('<input>').val() is ''

1.2.16 (2016-10-14)

.attr('value', '') no longer removes the value attribute
<input type="checkbox"> without value="..." have a .val() of
'on'
<input type="radio"> without value="..." have a .val() of
'on'
<select> without <option selected> have the value of their first
<option> (or None if there are no options)

1.2.15 (2016-10-11)

.val() should never raise
drop py26 support
improve .extend() by returning self

1.2.14 (2016-10-10)

fix val() for and <select>, to match jQuery behavior</li> </ul> <h2>1.2.13 (2016-04-12)</h2> <ul> <li>Note explicit support for Python 3.5</li> </ul> <h2>1.2.12 (2016-04-12)</h2> <ul> <li><p>make_links_absolute now take care of whitespaces</p> </li> <li><p>added pseudo selector :has()</p> </li> <li><p>add cookies arguments as allowed arguments for requests</p> </li> </ul> <h2>1.2.11 (2016-02-02)</h2> <ul> <li><p>Preserve namespaces attribute on PyQuery copies.</p> </li> <li><p>Do not raise an error when the http response code is 2XX</p> </li> </ul> <h2>1.2.10 (2016-01-05)</h2> <ul> <li><p>Fixed #118: implemented usage <code>lxml.etree.tostring</code> within <code>outer_html</code> method</p> </li> <li><p>Fixed #117: Raise HTTP Error if HTTP status code is not equal to 200</p> </li> <li><p>Fixed #112: make_links_absolute does not apply to form actions</p> </li> <li><p>Fixed #98: contains act like jQuery</p> </li> </ul> <h2>1.2.9 (2014-08-22)</h2> <ul> <li><p>Support for keyword arguments in PyQuery custom functions</p> </li> <li><p>Fixed #78: items must take care or the parent</p> </li> <li><p>Fixed #65 PyQuery.make_links_absolute() no longer creates 'href' attribute<br>when it isn't there</p> </li> <li><p>Fixed #19. <code>is_()</code> was broken.</p> </li> <li><p>Fixed #9. <code>.replaceWith(PyQuery element)</code> raises error</p> </li> <li><p>Remove official python3.2 support (mostly because of 3rd party semi-deps)</p> </li> </ul> <h2>1.2.8 (2013-12-21)</h2> <ul> <li><p>Fixed #22: Open by filename fails when file contains invalid xml</p> </li> <li><p>Bug fix in .remove_class()</p> </li> </ul> <h2>1.2.7 (2013-12-21)</h2> <ul> <li><p>Use pep8 name for methods but keep an alias for camel case method.<br>Eg: remove_attr and removeAttr works<br>Fix #57</p> </li> <li><p>.text() now return an empty string instead of None if there is no text node.<br>Fix #45</p> </li> <li><p>Fixed #23: removeClass adds class attribute to elements which previously<br>lacked one</p> </li> </ul> <h2>1.2.6 (2013-10-11)</h2> <ul> <li>README_fixt.py was not include in the release. Fix #54.</li> </ul> <h2>1.2.5 (2013-10-10)</h2> <ul> <li><p>cssselect compat. See <a href="https://github.com/SimonSapin/cssselect/pull/22">https://github.com/SimonSapin/cssselect/pull/22</a></p> </li> <li><p>tests improvements. no longer require a eth connection.</p> </li> <li><p>fix #55</p> </li> </ul> <h2>1.2.4</h2> <ul> <li><p>Moved to github. So a few files are renamed from .txt to .rst</p> </li> <li><p>Added .xhtml_to_html() and .remove_namespaces()</p> </li> <li><p>Use requests to fetch urls (if available)</p> </li> <li><p>Use restkit's proxy instead of Paste (which will die with py3)</p> </li> <li><p>Allow to open https urls</p> </li> <li><p>python2.5 is no longer supported (may work, but tests are broken)</p> </li> </ul> <h2>1.2.3</h2> <ul> <li><p>Allow to pass this in .filter() callback</p> </li> <li><p>Add .contents() .items()</p> </li> <li><p>Add tox.ini</p> </li> <li><p>Bug fixes: fix #35 #55 #64 #66</p> </li> </ul> <h2>1.2.2</h2> <ul> <li><p>Fix cssselectpatch to match the newer implementation of cssselect. Fixes issue #62, #52 and #59 (Haoyu Bai)</p> </li> <li><p>Fix issue #37 (Caleb Burns)</p> </li> </ul> <h2>1.2.1</h2> <ul> <li><p>Allow to use a custom css translator.</p> </li> <li><p>Fix issue 44: case problem with xml documents</p> </li> </ul> <h2>1.2</h2> <ul> <li><p>PyQuery now uses <code>cssselect <http://pypi.python.org/pypi/cssselect></code>_. See issue 43.</p> </li> <li><p>Fix issue 40: forward .html() extra arguments to <code>lxml.etree.tostring</code></p> </li> </ul> <h2>1.1.1</h2> <ul> <li>Minor release. Include test file so you can run tests from the tarball.</li> </ul> <h2>1.1</h2> <ul> <li>fix issues 30, 31, 32 - py3 improvements / webob 1.2+ support</li> </ul> <h2>1.0</h2> <ul> <li>fix issues 24</li> </ul> <h2>0.7</h2> <ul> <li><p>Python 3 compatible</p> </li> <li><p>Add <strong>unicode</strong> method</p> </li> <li><p>Add root and encoding attribute</p> </li> <li><p>fix issues 19, 20, 22, 23</p> </li> </ul> <h2>0.6.1</h2> <ul> <li><p>Move README.txt at package root</p> </li> <li><p>Add CHANGES.txt and add it to long_description</p> </li> </ul> <h2>0.6</h2> <ul> <li><p>Added PyQuery.outerHtml</p> </li> <li><p>Added PyQuery.fn</p> </li> <li><p>Added PyQuery.map</p> </li> <li><p>Change PyQuery.each behavior to reflect jQuery api</p> </li> </ul>

Dependency	Optional
cssselect	false
lxml	false
pytest	true
pytest-cov	true
requests	true
webob	true
webtest	true

Package profile

pyquery

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description