Skip to content

Latest commit

 

History

History
233 lines (170 loc) · 6.69 KB

README.md

File metadata and controls

233 lines (170 loc) · 6.69 KB
Raw

dominic

Version 0.1.4 (unreleased)

What

python-pure implementation of CSS selectors, and DOM traversing

Basic usage

install:

user@machine:~$ [sudo] pip install dominic

documentation

from dominic import DOM

html = """<html>
  <head>
    <title>My Title</title>
  </head>
  <body>
    <p class="paragraph" id="main">Hello!</p>
    <input type="text" id="string" value="value" />
    <div class="one two three">
      <span id="the-span">text here!</span>
    </div>
  </body>
</html>"""

dom = DOM(html)

body_elements = dom.find("body *")

assert body_elements.length is 4

p1 = for p in dom.find("p")[0]
p2 = for p in dom.find("p").first()

p3 = for p in dom.find("#main").first()
p4 = for p in dom.find(".paragraph").first()

assert p1.text() == p2.text()
assert p2.text() == p3.text()
assert p3.text() == p4.text()
assert p4.text() == "Hello!"
assert p4.html() == "<p class="paragraph" id="main">Hello!</p>"

span = dom.find("div.one.two.three > span#the-span").first()

assert span.text() == 'text here!'

assert span.text('reflect changes')

assert span.text() == 'reflect changes'
assert span.html() == '<span id="the-span">reflect changes</span>'

assert dom.html() == """<html>
  <head>
    <title>My Title</title>
  </head>
  <body>
    <p class="paragraph" id="main">Hello!</p>
    <input type="text" id="string" value="value" />
    <div class="one two three">
      <span id="the-span">reflect changes</span>
    </div>
  </body>
</html>"""

lists_html = """<html>
  <head>
    <title>My Lists</title>
  </head>
  <body>
    <ul>
      <li id="nice-ball">kicks</li>
      <li id="nice-star">sparks</li>
      <li id=almost-nice-moon">so beautiful</li>
      <li id="awful-ball">that does not kick</li>
      <li id="awful-star">that has no light</li>
    </ul>
  </body>
</html>"""

lists_dom = DOM(lists_html)

ball, star = lists_dom.find("ul > [id^=nice]")

assert ball.text() == 'kicks'
assert star.text() == 'sparks'

ball, star, moon = lists_dom.find("ul > [id*=nice]")

assert ball.text() == 'kicks'
assert star.text() == 'sparks'
assert moon.text() == 'so beautiful'

good, bad = lists_dom.find("ul > [id$=star]")

assert good.text() == 'sparks'
assert bad.text() == 'that has no light'

links = DOM("""
    <a href="example.html" hreflang="en">American English</a>
    <a href="example.html" hreflang="en-UK">British English</a>
    <a href="example.html" hreflang="pt-BR">Brazilian Portuguese</a>
""")

found = links.find("a[hreflang|=en]")

assert len(found) is 2

assert found[0].text() == 'American English'
assert found[1].text() == 'British English'

also works with quoted attribute values

lists_html = """<html>
  <head>
    <title>My Lists</title>
  </head>
  <body>
    <ul>
      <li id="nice-ball">kicks</li>
      <li id="nice-star">sparks</li>
      <li id="awful-ball">that does not kick</li>
      <li id="awful-star">that has no light</li>
      <li id="capitalized word">Word</li>
      <li id=lower word case">word</li>
      <li id=word upper cased">WORD</li>
    </ul>
  </body>
</html>"""

lists_dom = DOM(lists_html)

ball, star = lists_dom.find('ul > [id^="nice"]')

assert ball.text() == 'kicks'
assert star.text() == 'sparks'

words = lists_dom.find('ul > [id~="word"]')

assert len(words) is 3
assert words[0].text() == 'Word'
assert words[1].text() == 'word'
assert words[2].text() == 'WORD'

Why ?

As a webdeveloper I have to handle HTML nodes within python code all the time.

Hence this I love lxml and have a extensively use of it's CSSSelector, I mean, totally.

Althrough, lxml is built with C-based python extensions, and whenever I need to use it in a sandboxed environment, Google App Engine, for example, I cannot use lxml.

So that, when I've met py-dom-xpath, I decided to write my own python implementation of CSSSelector, which translates into xpath paths.

Humm, BTW it supports non well-formed HTML :)

Inspiration and thanks

dominic's test suite is a python port of sizzle's test suite.

thanks to @jeresig for its TERRIFIC work on sizzle, such a clean and easy-to-understand test suite.

thanks to py-dom-xpath crew, it rocks out loud!

contribute!

install dependencies

user@machine:~$ [sudo] pip install sure

run tests

user@machine:~Projects/dominic$ make test

license

dominic is under MIT license, so that it can be embedded into your project, and ran within your sandbox. It can also be put together with py-dom-xpath

Copyright (C) <2010>  Gabriel Falcão <[email protected]>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

3rd party libraries disclaimer

py-dom-xpath

dominic includes a modified fork of py-dom-xpath which includes more
test coverage and more features than the original project. This fork
will be maintained as long as those contributions are not accepted and
commited py-dom-xpath in mainstream codebase.

py-dom-xpath is also under MIT License, and its original codebase is located here