mirror of
https://github.com/simonw/datasette.git
synced 2025-12-10 16:51:24 +01:00
Datasette previously only supported one type of faceting: exact column value counting. With this change, faceting logic is extracted out into one or more separate classes which can implement other patterns of faceting - this is discussed in #427, but potential upcoming facet types include facet-by-date, facet-by-JSON-array, facet-by-many-2-many and more. A new plugin hook, register_facet_classes, can be used by plugins to add in additional facet classes. Each class must implement two methods: suggest(), which scans columns in the table to decide if they might be worth suggesting for faceting, and facet_results(), which executes the facet operation and returns results ready to be displayed in the UI.
This commit is contained in:
Simon Willison
GitHub
parent
efc93b8ab5
commit
ea66c45df9
10 changed files with 600 additions and 132 deletions
|
|
@ -1129,6 +1129,9 @@ def test_page_size_matching_max_returned_rows(app_client_returned_rows_matches_p
|
|||
{
|
||||
"state": {
|
||||
"name": "state",
|
||||
"hideable": True,
|
||||
"type": "column",
|
||||
"toggle_url": "/fixtures/facetable.json?_facet=city_id",
|
||||
"results": [
|
||||
{
|
||||
"value": "CA",
|
||||
|
|
@ -1156,6 +1159,9 @@ def test_page_size_matching_max_returned_rows(app_client_returned_rows_matches_p
|
|||
},
|
||||
"city_id": {
|
||||
"name": "city_id",
|
||||
"hideable": True,
|
||||
"type": "column",
|
||||
"toggle_url": "/fixtures/facetable.json?_facet=state",
|
||||
"results": [
|
||||
{
|
||||
"value": 1,
|
||||
|
|
@ -1194,6 +1200,9 @@ def test_page_size_matching_max_returned_rows(app_client_returned_rows_matches_p
|
|||
{
|
||||
"state": {
|
||||
"name": "state",
|
||||
"hideable": True,
|
||||
"type": "column",
|
||||
"toggle_url": "/fixtures/facetable.json?_facet=city_id&state=MI",
|
||||
"results": [
|
||||
{
|
||||
"value": "MI",
|
||||
|
|
@ -1207,6 +1216,9 @@ def test_page_size_matching_max_returned_rows(app_client_returned_rows_matches_p
|
|||
},
|
||||
"city_id": {
|
||||
"name": "city_id",
|
||||
"hideable": True,
|
||||
"type": "column",
|
||||
"toggle_url": "/fixtures/facetable.json?_facet=state&state=MI",
|
||||
"results": [
|
||||
{
|
||||
"value": 3,
|
||||
|
|
@ -1224,6 +1236,9 @@ def test_page_size_matching_max_returned_rows(app_client_returned_rows_matches_p
|
|||
{
|
||||
"planet_int": {
|
||||
"name": "planet_int",
|
||||
"hideable": True,
|
||||
"type": "column",
|
||||
"toggle_url": "/fixtures/facetable.json",
|
||||
"results": [
|
||||
{
|
||||
"value": 1,
|
||||
|
|
@ -1249,6 +1264,9 @@ def test_page_size_matching_max_returned_rows(app_client_returned_rows_matches_p
|
|||
{
|
||||
"planet_int": {
|
||||
"name": "planet_int",
|
||||
"hideable": True,
|
||||
"type": "column",
|
||||
"toggle_url": "/fixtures/facetable.json?planet_int=1",
|
||||
"results": [
|
||||
{
|
||||
"value": 1,
|
||||
|
|
@ -1276,9 +1294,20 @@ def test_facets(app_client, path, expected_facet_results):
|
|||
|
||||
|
||||
def test_suggested_facets(app_client):
|
||||
assert len(app_client.get(
|
||||
suggestions = [{
|
||||
"name": suggestion["name"],
|
||||
"querystring": suggestion["toggle_url"].split("?")[-1]
|
||||
} for suggestion in app_client.get(
|
||||
"/fixtures/facetable.json"
|
||||
).json["suggested_facets"]) > 0
|
||||
).json["suggested_facets"]]
|
||||
assert [
|
||||
{"name": "planet_int", "querystring": "_facet=planet_int"},
|
||||
{"name": "on_earth", "querystring": "_facet=on_earth"},
|
||||
{"name": "state", "querystring": "_facet=state"},
|
||||
{"name": "city_id", "querystring": "_facet=city_id"},
|
||||
{"name": "neighborhood", "querystring": "_facet=neighborhood"},
|
||||
{"name": "tags", "querystring": "_facet=tags"}
|
||||
] == suggestions
|
||||
|
||||
|
||||
def test_allow_facet_off():
|
||||
|
|
|
|||
174
tests/test_facets.py
Normal file
174
tests/test_facets.py
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
from datasette.facets import ColumnFacet
|
||||
from .fixtures import app_client # noqa
|
||||
from .utils import MockRequest
|
||||
from collections import namedtuple
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_column_facet_suggest(app_client):
|
||||
facet = ColumnFacet(
|
||||
app_client.ds,
|
||||
MockRequest("http://localhost/"),
|
||||
database="fixtures",
|
||||
sql="select * from facetable",
|
||||
table="facetable",
|
||||
)
|
||||
suggestions = await facet.suggest()
|
||||
assert [
|
||||
{"name": "planet_int", "toggle_url": "http://localhost/?_facet=planet_int"},
|
||||
{"name": "on_earth", "toggle_url": "http://localhost/?_facet=on_earth"},
|
||||
{"name": "state", "toggle_url": "http://localhost/?_facet=state"},
|
||||
{"name": "city_id", "toggle_url": "http://localhost/?_facet=city_id"},
|
||||
{"name": "neighborhood", "toggle_url": "http://localhost/?_facet=neighborhood"},
|
||||
{"name": "tags", "toggle_url": "http://localhost/?_facet=tags"},
|
||||
] == suggestions
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_column_facet_suggest_skip_if_already_selected(app_client):
|
||||
facet = ColumnFacet(
|
||||
app_client.ds,
|
||||
MockRequest("http://localhost/?_facet=planet_int&_facet=on_earth"),
|
||||
database="fixtures",
|
||||
sql="select * from facetable",
|
||||
table="facetable",
|
||||
)
|
||||
suggestions = await facet.suggest()
|
||||
assert [
|
||||
{
|
||||
"name": "state",
|
||||
"toggle_url": "http://localhost/?_facet=planet_int&_facet=on_earth&_facet=state",
|
||||
},
|
||||
{
|
||||
"name": "city_id",
|
||||
"toggle_url": "http://localhost/?_facet=planet_int&_facet=on_earth&_facet=city_id",
|
||||
},
|
||||
{
|
||||
"name": "neighborhood",
|
||||
"toggle_url": "http://localhost/?_facet=planet_int&_facet=on_earth&_facet=neighborhood",
|
||||
},
|
||||
{
|
||||
"name": "tags",
|
||||
"toggle_url": "http://localhost/?_facet=planet_int&_facet=on_earth&_facet=tags",
|
||||
},
|
||||
] == suggestions
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_column_facet_suggest_skip_if_enabled_by_metadata(app_client):
|
||||
facet = ColumnFacet(
|
||||
app_client.ds,
|
||||
MockRequest("http://localhost/"),
|
||||
database="fixtures",
|
||||
sql="select * from facetable",
|
||||
table="facetable",
|
||||
metadata={"facets": ["city_id"]},
|
||||
)
|
||||
suggestions = [s["name"] for s in await facet.suggest()]
|
||||
assert ["planet_int", "on_earth", "state", "neighborhood", "tags"] == suggestions
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_column_facet_results(app_client):
|
||||
facet = ColumnFacet(
|
||||
app_client.ds,
|
||||
MockRequest("http://localhost/?_facet=city_id"),
|
||||
database="fixtures",
|
||||
sql="select * from facetable",
|
||||
table="facetable",
|
||||
)
|
||||
buckets, timed_out = await facet.facet_results()
|
||||
assert [] == timed_out
|
||||
assert {
|
||||
"city_id": {
|
||||
"name": "city_id",
|
||||
"type": "column",
|
||||
"hideable": True,
|
||||
"toggle_url": "/",
|
||||
"results": [
|
||||
{
|
||||
"value": 1,
|
||||
"label": "San Francisco",
|
||||
"count": 6,
|
||||
"toggle_url": "http://localhost/?_facet=city_id&city_id=1",
|
||||
"selected": False,
|
||||
},
|
||||
{
|
||||
"value": 2,
|
||||
"label": "Los Angeles",
|
||||
"count": 4,
|
||||
"toggle_url": "http://localhost/?_facet=city_id&city_id=2",
|
||||
"selected": False,
|
||||
},
|
||||
{
|
||||
"value": 3,
|
||||
"label": "Detroit",
|
||||
"count": 4,
|
||||
"toggle_url": "http://localhost/?_facet=city_id&city_id=3",
|
||||
"selected": False,
|
||||
},
|
||||
{
|
||||
"value": 4,
|
||||
"label": "Memnonia",
|
||||
"count": 1,
|
||||
"toggle_url": "http://localhost/?_facet=city_id&city_id=4",
|
||||
"selected": False,
|
||||
},
|
||||
],
|
||||
"truncated": False,
|
||||
}
|
||||
} == buckets
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_column_facet_from_metadata_cannot_be_hidden(app_client):
|
||||
facet = ColumnFacet(
|
||||
app_client.ds,
|
||||
MockRequest("http://localhost/"),
|
||||
database="fixtures",
|
||||
sql="select * from facetable",
|
||||
table="facetable",
|
||||
metadata={"facets": ["city_id"]},
|
||||
)
|
||||
buckets, timed_out = await facet.facet_results()
|
||||
assert [] == timed_out
|
||||
assert {
|
||||
"city_id": {
|
||||
"name": "city_id",
|
||||
"type": "column",
|
||||
"hideable": False,
|
||||
"toggle_url": "/",
|
||||
"results": [
|
||||
{
|
||||
"value": 1,
|
||||
"label": "San Francisco",
|
||||
"count": 6,
|
||||
"toggle_url": "http://localhost/?city_id=1",
|
||||
"selected": False,
|
||||
},
|
||||
{
|
||||
"value": 2,
|
||||
"label": "Los Angeles",
|
||||
"count": 4,
|
||||
"toggle_url": "http://localhost/?city_id=2",
|
||||
"selected": False,
|
||||
},
|
||||
{
|
||||
"value": 3,
|
||||
"label": "Detroit",
|
||||
"count": 4,
|
||||
"toggle_url": "http://localhost/?city_id=3",
|
||||
"selected": False,
|
||||
},
|
||||
{
|
||||
"value": 4,
|
||||
"label": "Memnonia",
|
||||
"count": 1,
|
||||
"toggle_url": "http://localhost/?city_id=4",
|
||||
"selected": False,
|
||||
},
|
||||
],
|
||||
"truncated": False,
|
||||
}
|
||||
} == buckets
|
||||
8
tests/utils.py
Normal file
8
tests/utils.py
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
class MockRequest:
|
||||
def __init__(self, url):
|
||||
self.url = url
|
||||
self.path = "/" + url.split("://")[1].split("/", 1)[1]
|
||||
self.query_string = ""
|
||||
if "?" in url:
|
||||
self.query_string = url.split("?", 1)[1]
|
||||
self.path = self.path.split("?")[0]
|
||||
Loading…
Add table
Add a link
Reference in a new issue