mirror of
https://github.com/simonw/datasette.git
synced 2026-06-09 10:36:58 +02:00
Refactor ColumnType: register classes, return instances with config
- register_column_types() now returns classes instead of instances
- ColumnType.__init__ takes optional config=, baking it into the instance
- get_column_type() returns a ColumnType instance (or None) instead of a
(name, config) tuple
- get_column_types() returns {col: ColumnType instance} instead of tuples
- Remove get_column_type_class() - no longer needed
- render_cell/validate/transform_value methods no longer take config arg;
use self.config instead
- render_cell hook takes column_type (ColumnType or None) instead of
column_type + column_type_config
https://claude.ai/code/session_01SvPEPqHgURTWESRp28pTC3
This commit is contained in:
parent
8af98c24c2
commit
dd9b83301c
11 changed files with 227 additions and 243 deletions
|
|
@ -922,13 +922,16 @@ await .get_column_type(database, resource, column)
|
|||
``column`` - string
|
||||
The name of the column.
|
||||
|
||||
Returns a ``(column_type_name, config)`` tuple for the specified column. ``column_type_name`` is a string like ``"email"`` or ``"url"``, and ``config`` is a dict or ``None``. If no column type is assigned, returns ``(None, None)``.
|
||||
Returns a :ref:`ColumnType <column_types>` instance with ``.config`` populated for the specified column, or ``None`` if no column type is assigned.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
ct_name, config = await datasette.get_column_type(
|
||||
ct = await datasette.get_column_type(
|
||||
"mydb", "mytable", "email_col"
|
||||
)
|
||||
if ct:
|
||||
print(ct.name) # "email"
|
||||
print(ct.config) # None or {...}
|
||||
|
||||
.. _datasette_get_column_types:
|
||||
|
||||
|
|
@ -940,12 +943,13 @@ await .get_column_types(database, resource)
|
|||
``resource`` - string
|
||||
The name of the table or view.
|
||||
|
||||
Returns a dictionary mapping column names to ``(column_type_name, config)`` tuples for all columns that have assigned types on the given resource.
|
||||
Returns a dictionary mapping column names to :ref:`ColumnType <column_types>` instances (with ``.config`` populated) for all columns that have assigned types on the given resource.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
ct_map = await datasette.get_column_types("mydb", "mytable")
|
||||
# {"email_col": ("email", None), "site": ("url", None)}
|
||||
for col_name, ct in ct_map.items():
|
||||
print(col_name, ct.name, ct.config)
|
||||
|
||||
.. _datasette_set_column_type:
|
||||
|
||||
|
|
@ -995,22 +999,6 @@ Removes the column type assignment for the specified column.
|
|||
"mydb", "mytable", "location"
|
||||
)
|
||||
|
||||
.. _datasette_get_column_type_class:
|
||||
|
||||
.get_column_type_class(column_type_name)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``column_type_name`` - string
|
||||
The name of the column type, e.g. ``"email"``.
|
||||
|
||||
Returns the registered ``ColumnType`` instance for the given name, or ``None`` if no plugin has registered a column type with that name. This is a synchronous method.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
ct = datasette.get_column_type_class("email")
|
||||
if ct:
|
||||
print(ct.description) # "Email address"
|
||||
|
||||
.. _datasette_add_database:
|
||||
|
||||
.add_database(db, name=None, route=None)
|
||||
|
|
@ -2049,6 +2037,14 @@ The internal database schema is as follows:
|
|||
value text,
|
||||
unique(database_name, resource_name, column_name, key)
|
||||
);
|
||||
CREATE TABLE column_types (
|
||||
database_name TEXT NOT NULL,
|
||||
resource_name TEXT NOT NULL,
|
||||
column_name TEXT NOT NULL,
|
||||
column_type TEXT NOT NULL,
|
||||
config TEXT,
|
||||
PRIMARY KEY (database_name, resource_name, column_name)
|
||||
);
|
||||
|
||||
.. [[[end]]]
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue