mirror of
https://github.com/simonw/datasette.git
synced 2026-09-17 14:04:07 +02:00
e889403d3b* ruff>=0.16.0 See https://astral.sh/blog/ruff-v0.16.0 * uv run ruff check . --fix --unsafe-fixes * Ruff fixes by Claude Code Opus 5
87 lines
2.8 KiB
Python
87 lines
2.8 KiB
Python
import dataclasses
|
|
import types
|
|
import typing
|
|
from dataclasses import dataclass
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class ContextField:
|
|
name: str
|
|
type_name: str
|
|
help: str
|
|
from_extra: bool = False
|
|
|
|
|
|
def _type_name(type_):
|
|
if type_ is type(None):
|
|
return "None"
|
|
origin = typing.get_origin(type_)
|
|
args = typing.get_args(type_)
|
|
if origin in (typing.Union, types.UnionType):
|
|
return " | ".join(_type_name(arg) for arg in args)
|
|
if origin is not None:
|
|
name = getattr(origin, "__name__", str(origin).removeprefix("typing."))
|
|
return "{}[{}]".format(name, ", ".join(_type_name(arg) for arg in args))
|
|
return getattr(type_, "__name__", str(type_).removeprefix("typing."))
|
|
|
|
|
|
def from_extra():
|
|
"""
|
|
Declare a Context dataclass field whose value comes from a registered
|
|
Extra of the same name - its documentation is the Extra description,
|
|
so the doc string lives next to the resolve() code rather than being
|
|
duplicated on the dataclass.
|
|
"""
|
|
return dataclasses.field(metadata={"from_extra": True})
|
|
|
|
|
|
class Context:
|
|
"Base class for all documented contexts"
|
|
|
|
# Set on subclasses whose from_extra() fields should be resolved
|
|
# against the extras registry for this scope
|
|
extras_scope = None
|
|
|
|
@classmethod
|
|
def documented_fields(cls):
|
|
"List of ContextField describing the documented fields of this context"
|
|
documented = []
|
|
for f in dataclasses.fields(cls):
|
|
if f.name.startswith("_"):
|
|
continue
|
|
is_from_extra = bool(f.metadata.get("from_extra"))
|
|
if is_from_extra:
|
|
help_text = cls._extra_description(f.name)
|
|
else:
|
|
help_text = f.metadata.get("help", "")
|
|
documented.append(
|
|
ContextField(
|
|
name=f.name,
|
|
type_name=_type_name(f.type),
|
|
help=help_text,
|
|
from_extra=is_from_extra,
|
|
)
|
|
)
|
|
return documented
|
|
|
|
@classmethod
|
|
def _extra_description(cls, name):
|
|
# Imported lazily - table_extras is not needed just to define
|
|
# Context subclasses
|
|
from datasette.views.table_extras import table_extra_registry
|
|
|
|
try:
|
|
extra_class = table_extra_registry.classes_by_name[name]
|
|
except KeyError:
|
|
raise KeyError(
|
|
f"{cls.__name__}.{name} is declared with from_extra() but there is no "
|
|
"registered extra of that name"
|
|
)
|
|
if cls.extras_scope is not None and not extra_class.available_for(
|
|
cls.extras_scope
|
|
):
|
|
raise ValueError(
|
|
f"{cls.__name__}.{name} is declared with from_extra() but the {name} extra is "
|
|
f"not available for scope {cls.extras_scope}"
|
|
)
|
|
return extra_class.description or ""
|