mirror of
https://github.com/simonw/datasette.git
synced 2026-06-24 17:54:35 +02:00
435ff7fa88
- Context dataclasses now expose documented_fields(), returning ContextField(name, type_name, help) for each field - ExtraRegistry.internal_classes_for_scope() returns the Extra classes that are available to HTML templates but excluded from JSON - Tests enforce that every registered Extra has a description and every DatabaseContext/QueryContext field has help metadata Refs #1510, #2127 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
32 lines
1,001 B
Python
32 lines
1,001 B
Python
"""
|
|
Tests for the documented template context - the contract that custom
|
|
template authors can rely on for Datasette 1.0.
|
|
"""
|
|
|
|
from dataclasses import dataclass, field
|
|
|
|
import pytest
|
|
|
|
from datasette.views import Context
|
|
from datasette.views.database import DatabaseContext, QueryContext
|
|
|
|
|
|
def test_documented_fields():
|
|
@dataclass
|
|
class DemoContext(Context):
|
|
name: str = field(metadata={"help": "The name"})
|
|
count: int = field(metadata={"help": "How many there are"})
|
|
|
|
fields = DemoContext.documented_fields()
|
|
assert [(f.name, f.type_name, f.help) for f in fields] == [
|
|
("name", "str", "The name"),
|
|
("count", "int", "How many there are"),
|
|
]
|
|
|
|
|
|
@pytest.mark.parametrize("klass", (DatabaseContext, QueryContext))
|
|
def test_context_dataclass_fields_all_have_help(klass):
|
|
for context_field in klass.documented_fields():
|
|
assert context_field.help, "{}.{} is missing help metadata".format(
|
|
klass.__name__, context_field.name
|
|
)
|