Python API
This reference is generated from Adapt docstrings and signatures.
Application setup
Configuration class for the Adapt application.
Attributes:
| Name | Type | Description |
|---|---|---|
root |
Path
|
The root directory path for the application. |
readonly |
bool
|
Whether the application is in read-only mode. |
version |
str
|
The version of the application. |
tls_cert |
Path | None
|
Path to the TLS certificate file. |
tls_key |
Path | None
|
Path to the TLS key file. |
secure_cookies |
bool
|
Whether to set secure flags on cookies. |
plugin_registry |
dict[str, str]
|
Mapping of file extensions to plugin class paths. |
logging |
dict[str, Any]
|
Logging configuration dictionary for dictConfig. |
Source code in adapt/config.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | |
__post_init__()
Post-initialization to resolve paths and set database path.
Source code in adapt/config.py
89 90 91 92 93 | |
get_plugin_factory(extension)
Get the plugin factory for a given file extension.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
extension
|
str
|
The file extension (e.g., '.csv'). |
required |
Returns:
| Type | Description |
|---|---|
Callable[..., Any]
|
The plugin class factory. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If no plugin is registered for the extension. |
Source code in adapt/config.py
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
load_from_file()
Load configuration from DOCROOT/.adapt/conf.json, creating it with defaults if missing.
Source code in adapt/config.py
129 130 131 132 133 134 135 136 137 138 139 140 | |
Create and configure the FastAPI application.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
AdaptConfig
|
The application configuration. |
required |
Returns:
| Type | Description |
|---|---|
FastAPI
|
The configured FastAPI app instance. |
Source code in adapt/app.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 | |
Resource discovery and plugin contracts
Discover dataset resources in the root directory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
root
|
Path
|
The root directory to search. |
required |
config
|
AdaptConfig
|
The Adapt configuration. |
required |
Returns:
| Type | Description |
|---|---|
list[DatasetResource]
|
A list of discovered DatasetResource objects. |
Source code in adapt/discovery.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 | |
Descriptor for a discovered resource.
Source code in adapt/plugins/base.py
33 34 35 36 37 38 39 40 41 | |
Bases: ABC
Abstract base class for all plugins.
Source code in adapt/plugins/base.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | |
apply_options(descriptor)
Apply per-resource options to a descriptor after discovery has located them.
Options come from the companion .adapt/<name>[.<sub_namespace>].options.json
file and are already parsed into descriptor.metadata["options"]. This runs
after load() because load() receives only a path and cannot know where the
companion directory is; it runs before generate_companion_files() so that any
derived schema reflects the options.
The default does nothing. Plugins override this to honour the options they support.
Source code in adapt/plugins/base.py
81 82 83 84 85 86 87 88 89 90 91 92 93 | |
default_ui(descriptor)
Generate a default HTML UI for the resource.
Source code in adapt/plugins/base.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | |
detect(path)
abstractmethod
Detect if this plugin can handle the given path.
Source code in adapt/plugins/base.py
56 57 58 59 | |
filter_for_user(resource, user, rows)
Filter rows based on user context (Row-Level Security).
Default implementation returns all rows. Override this in plugins to implement RLS.
Source code in adapt/plugins/base.py
115 116 117 118 119 120 121 | |
generate_companion_files(descriptor)
Generate companion files for the resource.
Default implementation does nothing. Override in plugins that need companion files.
Source code in adapt/plugins/base.py
154 155 156 157 158 159 160 | |
get_route_configs(descriptor)
Return list of (prefix, router) tuples for mounting routes.
Source code in adapt/plugins/base.py
95 96 97 98 | |
index(resource)
Yield documents for the full-text search index.
The default returns nothing, so a resource is simply not searchable unless its plugin opts in.
Note that the index is user-agnostic: filter_for_user is deliberately
NOT applied here, because one index is shared by every user. Row-level
security is enforced when a hit is followed to its API or UI route, and
resource-level permissions are enforced when results are returned. If a
plugin's rows are sensitive per-user beyond that, do not index them.
Source code in adapt/plugins/base.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 | |
load(path)
abstractmethod
Load resource descriptor(s) for the given path.
Source code in adapt/plugins/base.py
61 62 63 64 | |
read(resource, request)
abstractmethod
Read data/content for the resource.
Source code in adapt/plugins/base.py
71 72 73 74 | |
schema(resource)
abstractmethod
Return the schema for the resource.
Source code in adapt/plugins/base.py
66 67 68 69 | |
write(resource, data, request, context)
abstractmethod
Write data/content for the resource.
Source code in adapt/plugins/base.py
76 77 78 79 | |
MCP integration
Construct the FastMCP server and register its tools.
streamable_http_path is set to / because the outer app already mounts
this server's ASGI app at /mcp (app.mount("/mcp", mcp_app)); leaving
the SDK's own default of /mcp here would double up to /mcp/mcp.
Source code in adapt/mcp.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |