DESCRIPTION.rst 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. pyquery: a jquery-like library for python
  2. =========================================
  3. .. image:: https://travis-ci.org/gawel/pyquery.svg
  4. :alt: Build Status
  5. :target: https://travis-ci.org/gawel/pyquery
  6. pyquery allows you to make jquery queries on xml documents.
  7. The API is as much as possible the similar to jquery. pyquery uses lxml for fast
  8. xml and html manipulation.
  9. This is not (or at least not yet) a library to produce or interact with
  10. javascript code. I just liked the jquery API and I missed it in python so I
  11. told myself "Hey let's make jquery in python". This is the result.
  12. The `project`_ is being actively developped on a git repository on Github. I
  13. have the policy of giving push access to anyone who wants it and then to review
  14. what he does. So if you want to contribute just email me.
  15. Please report bugs on the `github
  16. <https://github.com/gawel/pyquery/issues>`_ issue
  17. tracker.
  18. .. _deliverance: http://www.gawel.org/weblog/en/2008/12/skinning-with-pyquery-and-deliverance
  19. .. _project: https://github.com/gawel/pyquery/
  20. Quickstart
  21. ==========
  22. You can use the PyQuery class to load an xml document from a string, a lxml
  23. document, from a file or from an url::
  24. >>> from pyquery import PyQuery as pq
  25. >>> from lxml import etree
  26. >>> import urllib
  27. >>> d = pq("<html></html>")
  28. >>> d = pq(etree.fromstring("<html></html>"))
  29. >>> d = pq(url=your_url)
  30. >>> d = pq(url=your_url,
  31. ... opener=lambda url, **kw: urlopen(url).read())
  32. >>> d = pq(filename=path_to_html_file)
  33. Now d is like the $ in jquery::
  34. >>> d("#hello")
  35. [<p#hello.hello>]
  36. >>> p = d("#hello")
  37. >>> print(p.html())
  38. Hello world !
  39. >>> p.html("you know <a href='http://python.org/'>Python</a> rocks")
  40. [<p#hello.hello>]
  41. >>> print(p.html())
  42. you know <a href="http://python.org/">Python</a> rocks
  43. >>> print(p.text())
  44. you know Python rocks
  45. You can use some of the pseudo classes that are available in jQuery but that
  46. are not standard in css such as :first :last :even :odd :eq :lt :gt :checked
  47. :selected :file::
  48. >>> d('p:first')
  49. [<p#hello.hello>]
  50. See http://pyquery.rtfd.org/ for the full documentation
  51. News
  52. ====
  53. 1.2.17 (2016-10-14)
  54. -------------------
  55. - ``PyQuery('<input value="">').val()`` is ``''``
  56. - ``PyQuery('<input>').val()`` is ``''``
  57. 1.2.16 (2016-10-14)
  58. -------------------
  59. - ``.attr('value', '')`` no longer removes the ``value`` attribute
  60. - ``<input type="checkbox">`` without ``value="..."`` have a ``.val()`` of
  61. ``'on'``
  62. - ``<input type="radio">`` without ``value="..."`` have a ``.val()`` of
  63. ``'on'``
  64. - ``<select>`` without ``<option selected>`` have the value of their first
  65. ``<option>`` (or ``None`` if there are no options)
  66. 1.2.15 (2016-10-11)
  67. -------------------
  68. - .val() should never raise
  69. - drop py26 support
  70. - improve .extend() by returning self
  71. 1.2.14 (2016-10-10)
  72. -------------------
  73. - fix val() for <textarea> and <select>, to match jQuery behavior
  74. 1.2.13 (2016-04-12)
  75. -------------------
  76. - Note explicit support for Python 3.5
  77. 1.2.12 (2016-04-12)
  78. -------------------
  79. - make_links_absolute now take care of whitespaces
  80. - added pseudo selector :has()
  81. - add cookies arguments as allowed arguments for requests
  82. 1.2.11 (2016-02-02)
  83. -------------------
  84. - Preserve namespaces attribute on PyQuery copies.
  85. - Do not raise an error when the http response code is 2XX
  86. 1.2.10 (2016-01-05)
  87. -------------------
  88. - Fixed #118: implemented usage ``lxml.etree.tostring`` within ``outer_html`` method
  89. - Fixed #117: Raise HTTP Error if HTTP status code is not equal to 200
  90. - Fixed #112: make_links_absolute does not apply to form actions
  91. - Fixed #98: contains act like jQuery
  92. 1.2.9 (2014-08-22)
  93. ------------------
  94. - Support for keyword arguments in PyQuery custom functions
  95. - Fixed #78: items must take care or the parent
  96. - Fixed #65 PyQuery.make_links_absolute() no longer creates 'href' attribute
  97. when it isn't there
  98. - Fixed #19. ``is_()`` was broken.
  99. - Fixed #9. ``.replaceWith(PyQuery element)`` raises error
  100. - Remove official python3.2 support (mostly because of 3rd party semi-deps)
  101. 1.2.8 (2013-12-21)
  102. ------------------
  103. - Fixed #22: Open by filename fails when file contains invalid xml
  104. - Bug fix in .remove_class()
  105. 1.2.7 (2013-12-21)
  106. ------------------
  107. - Use pep8 name for methods but keep an alias for camel case method.
  108. Eg: remove_attr and removeAttr works
  109. Fix #57
  110. - .text() now return an empty string instead of None if there is no text node.
  111. Fix #45
  112. - Fixed #23: removeClass adds class attribute to elements which previously
  113. lacked one
  114. 1.2.6 (2013-10-11)
  115. ------------------
  116. - README_fixt.py was not include in the release. Fix #54.
  117. 1.2.5 (2013-10-10)
  118. ------------------
  119. - cssselect compat. See https://github.com/SimonSapin/cssselect/pull/22
  120. - tests improvments. no longer require a eth connection.
  121. - fix #55
  122. 1.2.4
  123. -----
  124. - Moved to github. So a few files are renamed from .txt to .rst
  125. - Added .xhtml_to_html() and .remove_namespaces()
  126. - Use requests to fetch urls (if available)
  127. - Use restkit's proxy instead of Paste (which will die with py3)
  128. - Allow to open https urls
  129. - python2.5 is no longer supported (may work, but tests are broken)
  130. 1.2.3
  131. -----
  132. - Allow to pass this in .filter() callback
  133. - Add .contents() .items()
  134. - Add tox.ini
  135. - Bug fixes: fix #35 #55 #64 #66
  136. 1.2.2
  137. -----
  138. - Fix cssselectpatch to match the newer implementation of cssselect. Fixes issue #62, #52 and #59 (Haoyu Bai)
  139. - Fix issue #37 (Caleb Burns)
  140. 1.2.1
  141. -----
  142. - Allow to use a custom css translator.
  143. - Fix issue 44: case problem with xml documents
  144. 1.2
  145. ---
  146. - PyQuery now uses `cssselect <http://pypi.python.org/pypi/cssselect>`_. See issue 43.
  147. - Fix issue 40: forward .html() extra arguments to ``lxml.etree.tostring``
  148. 1.1.1
  149. -----
  150. - Minor release. Include test file so you can run tests from the tarball.
  151. 1.1
  152. ---
  153. - fix issues 30, 31, 32 - py3 improvements / webob 1.2+ support
  154. 1.0
  155. ---
  156. - fix issues 24
  157. 0.7
  158. ---
  159. - Python 3 compatible
  160. - Add __unicode__ method
  161. - Add root and encoding attribute
  162. - fix issues 19, 20, 22, 23
  163. 0.6.1
  164. ------
  165. - Move README.txt at package root
  166. - Add CHANGES.txt and add it to long_description
  167. 0.6
  168. ----
  169. - Added PyQuery.outerHtml
  170. - Added PyQuery.fn
  171. - Added PyQuery.map
  172. - Change PyQuery.each behavior to reflect jQuery api