Skip to main content

scah (scan HTML)

Project description

scah (scan HTML)

World's fastest CSS Selector.

CSS selectors meet streaming XML/HTML parsing. Filter StAX events and build targeted DOMs without loading the entire document.

Crates.io npm PyPI

What is scah?

scah is a high-performance parsing library that bridges the gap between SAX/StAX streaming efficiency and DOM convenience. Instead of loading an entire document into memory or manually tracking parser state, you declare what you want with CSS selectors; the library handles the streaming complexity and builds a targeted DOM containing only your selections.

  • Streaming core: Built on StAX; constant memory regardless of document size
  • Familiar API: CSS selectors (including combinators like >, , + (coming soon), ~ (coming soon))
  • Multi-language: Rust core with Python and TypeScript/JavaScript bindings
  • Composable queries: Chain selections and nest them with closures for structured querying; not only more efficient than flat filtering, but a fundamentally better pattern for extracting hierarchical data relationships

Quick Start

Rust

# Cargo.toml
[dependencies]
scah = "0.0.1"

Basic usage

use scah::{Query, Save, parse};

let html = r#"<ul><li><a href="/one">One</a></li><li><a href="/two">Two</a></li></ul>"#;

let queries = &[Query::all("a[href]", Save::all()).build()];
let store = parse(html, queries);

for a in store.get("a[href]").unwrap() {
    let href = a.attribute(&store, "href").unwrap();
    let text = a.text_content(&store).unwrap_or_default();
    println!("{text}: {href}");
}
// Output:
//   One: /one
//   Two: /two

Structured querying with .then()

Instead of flat filtering, nest queries with closures. Child queries only run within the context of their parent match:

use scah::{Query, Save, parse};

let query = Query::all("main > section", Save::all())
    .then(|section| [
        section.all("> a[href]", Save::all()),
        section.all("div a", Save::all()),
    ])
    .build();

let store = parse(html, &[query]);

// Access nested results through parent elements
for section in store.get("main > section").unwrap() {
    println!("Section: {}", section.inner_html.unwrap_or(""));

    if let Some(links) = section.get(&store, "> a[href]") {
        for link in links {
            println!("  Direct link: {}", link.attribute(&store, "href").unwrap());
        }
    }
}

Save options

Control what data is captured per selector:

Constructor inner_html text_content Use case
Save::all() Yes Yes Full extraction
Save::only_inner_html() Yes No Raw markup only
Save::only_text_content() No Yes Lightweight text scraping
Save::none() No No Structure-only (attributes still saved)

Supported CSS selector syntax

Syntax Example Status
Tag name a, div Working
ID #my-id Working
Class .my-class Working
Descendant main section a Working
Child main > section Working
Attribute presence a[href] Working
Attribute exact a[href="url"] Working
Attribute prefix a[href^="https"] Working
Attribute suffix a[href$=".com"] Working
Attribute substring a[href*="example"] Working
Adjacent sibling h1 + p Coming soon
General sibling h1 ~ p Coming soon

📖 Full API documentation: docs.rs/scah

Benchmarks

Criterion BenchMarks

Python

from scah import Query, Save, parse 

query = Query.all("main > section", Save.all())
    .then(lambda section: [
        section.all("> a[href]", Save.all()),
        section.all("div a", Save.all()),
    ])
    .build()

store = parse(html, [query])

Benchmark's

Real Html BenchMark (html.spec.whatwg.org) (select all a tags):

WhatWg Html Spec BenchMark

Synthetic Html BenchMark (select all a tags):

Synthetic Html BenchMark

Typescript / Javascript

import { Query, parse } from 'scah';

const query = Query.all('main > section', { innerHtml: true, textContent: true })
  .then((p) => [
    p.all('> a[href]', { innerHtml: true, textContent: true }),
    p.all('div a', { innerHtml: true, textContent: true }),
  ])
  .build();

const store = parse(html, [query]);

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scah-0.0.2.tar.gz (471.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scah-0.0.2-cp38-abi3-manylinux_2_34_x86_64.whl (259.9 kB view details)

Uploaded CPython 3.8+manylinux: glibc 2.34+ x86-64

File details

Details for the file scah-0.0.2.tar.gz.

File metadata

  • Download URL: scah-0.0.2.tar.gz
  • Upload date:
  • Size: 471.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.12.6

File hashes

Hashes for scah-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2067aa4ec0d978cc76c8b7fa5dddf11e64869deb6da84da82529f83acad24075
MD5 a0a076ed2e1bafc55ed67336481e4d05
BLAKE2b-256 e86d6d9b8de063ee2aa90f821d8dad2b3c4671efa373ce93fc2ac04f2d651fa9

See more details on using hashes here.

File details

Details for the file scah-0.0.2-cp38-abi3-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for scah-0.0.2-cp38-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 b63a197a3424d421f72b5754ecbaa117bcd2e6c3a90cd3793648750468904a7b
MD5 16bdd1021250ba927b623d97c8665af1
BLAKE2b-256 6ba90433ea525cdd2b539f5a588823669c6ebf726fe43fa0a24d36dbbc7c75d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page