rushter / Selectolax

.. image:: docs/logo.png :alt: selectolax logo

.. image:: https://img.shields.io/pypi/v/selectolax.svg :target: https://pypi.python.org/pypi/selectolax

A fast HTML5 parser with CSS selectors using Modest engine <https://github.com/lexborisov/Modest/>_.

Installation

From PyPI using pip:

.. code-block:: bash

    pip install selectolax 

Development version from github:

.. code-block:: bash

    git clone --recursive  https://github.com/rushter/selectolax
    cd selectolax
    pip install -r requirements_dev.txt
    python setup.py install

How to compile selectolax while developing:

.. code-block:: bash

make clean
make dev

Basic examples

.. code:: python

In [1]: from selectolax.parser import HTMLParser
   ...:
   ...: html = """
   ...: <h1 id="title" data-updated="20201101">Hi there</h1>
   ...: <div class="post">Lorem Ipsum is simply dummy text of the printing and typesetting industry. </div>
   ...: <div class="post">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</div>
   ...: """
   ...: tree = HTMLParser(html)

In [2]: tree.css_first('h1#title').text()
Out[2]: 'Hi there'

In [3]: tree.css_first('h1#title').attributes
Out[3]: {'id': 'title', 'data-updated': '20201101'}

In [4]: [node.text() for node in tree.css('.post')]
Out[4]:
['Lorem Ipsum is simply dummy text of the printing and typesetting industry. ',
 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.']

.. code:: python

In [1]: html = "<div><p id=p1><p id=p2><p id=p3><a>link</a><p id=p4><p id=p5>text<p id=p6></div>"
   ...: selector = "div > :nth-child(2n+1):not(:has(a))"

In [2]: for node in HTMLParser(html).css(selector):
   ...:     print(node.attributes, node.text(), node.tag)
   ...:     print(node.parent.tag)
   ...:     print(node.html)
   ...:
{'id': 'p1'}  p
div
<p id="p1"></p>
{'id': 'p5'} text p
div
<p id="p5">text</p>

• Detailed overview <https://github.com/rushter/selectolax/blob/master/examples/walkthrough.ipynb>_

Simple Benchmark

• Average of 10 experiments to parse and retrieve URLs from 800 Google SERP pages.

+------------+------------+--------------+ | Package | Time | Memory (peak)| +============+============+==============+ | selectolax | 2.38 sec. | 768.11 MB | +------------+------------+--------------+ | lxml | 18.67 sec. | 769.21 MB | +------------+------------+--------------+

Links

• selectolax API reference <http://selectolax.readthedocs.io/en/latest/parser.html>_
• Detailed overview <https://github.com/rushter/selectolax/blob/master/examples/walkthrough.ipynb>_
• Modest introduction <https://lexborisov.github.io/Modest/>_
• Modest benchmark <http://lexborisov.github.io/benchmark-html-persers/>_
• Python benchmark <https://rushter.com/blog/python-fast-html-parser/>_
• Another Python benchmark <https://www.peterbe.com/plog/selectolax-or-pyquery>_

License

• Modest engine — LGPL2.1 <https://github.com/lexborisov/Modest/blob/master/LICENSE>_
• selectolax - MIT <https://github.com/rushter/selectolax/blob/master/LICENSE>_