-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathdatabase.py
More file actions
581 lines (488 loc) · 18.5 KB
/
Copy pathdatabase.py
File metadata and controls
581 lines (488 loc) · 18.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
"""Database models and operations for the display server.
This module handles SQLite database operations for storing and retrieving
visualization requests.
"""
import ast
import json
import os
import re
import sqlite3
import uuid
from contextlib import contextmanager
from datetime import datetime
from datetime import timezone
from pathlib import Path
from typing import Generator
from typing import Literal
from typing import Optional
from pydantic import BaseModel
from pydantic import Field
from pydantic import field_validator
from holoviz_mcp.config import get_config
from holoviz_mcp.config import logger
from holoviz_mcp.display_mcp.utils import find_extensions
from holoviz_mcp.display_mcp.utils import find_requirements
from holoviz_mcp.display_mcp.utils import validate_code
class Snippet(BaseModel):
"""Model for a code snippet stored in the database.
Represents a code snippet submitted to the Display System for visualization.
"""
id: str = Field(default_factory=lambda: str(uuid.uuid4()))
app: str = Field(..., description="Python code to execute")
name: str = Field(default="", description="User-provided name")
description: str = Field(default="", description="Short description of the app")
readme: str = Field(default="", description="Longer documentation describing the app")
method: Literal["jupyter", "panel", "pyodide"] = Field(..., description="Execution method")
created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
status: Literal["pending", "success", "error"] = Field(default="pending")
error_message: Optional[str] = Field(default=None, description="Error details if status='error'")
execution_time: Optional[float] = Field(default=None, description="Execution time in seconds")
requirements: list[str] = Field(default_factory=list, description="Inferred required packages")
extensions: list[str] = Field(default_factory=list, description="Inferred Panel extensions")
user: str = Field(default="guest", description="User who created the snippet")
tags: list[str] = Field(default_factory=list, description="List of tags")
slug: str = Field(default="", description="URL-friendly slug for persistent links")
@field_validator("slug")
@classmethod
def validate_slug(cls, v: str) -> str:
"""Validate that slug is either empty or a valid URL slug."""
if v == "":
return v
# Valid slug: lowercase letters, numbers, hyphens only
if not re.match(r"^[a-z0-9]+(?:-[a-z0-9]+)*$", v):
raise ValueError("Slug must be empty or contain only lowercase letters, numbers, and hyphens (no consecutive hyphens)")
return v
class SnippetDatabase:
"""SQLite database manager for code snippets.
Manages storage and retrieval of Snippet records (code snippets)
submitted to the Display System.
"""
def __init__(self, db_path: Path):
"""Initialize the database.
Parameters
----------
db_path : Path
Path to the SQLite database file
"""
self.db_path = db_path
self.db_path.parent.mkdir(parents=True, exist_ok=True)
self._initialize_db()
def _initialize_db(self) -> None:
"""Create database tables if they don't exist."""
with self._get_connection() as conn:
cursor = conn.cursor()
# Create main table
cursor.execute(
"""
CREATE TABLE IF NOT EXISTS snippets (
id TEXT PRIMARY KEY,
app TEXT NOT NULL,
name TEXT DEFAULT '',
description TEXT DEFAULT '',
readme TEXT DEFAULT '',
method TEXT NOT NULL,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
status TEXT DEFAULT 'pending',
error_message TEXT,
execution_time REAL,
requirements TEXT,
extensions TEXT,
user TEXT DEFAULT 'guest',
tags TEXT,
slug TEXT DEFAULT ''
)
"""
)
# Create indexes
cursor.execute("CREATE INDEX IF NOT EXISTS idx_created_at ON snippets(created_at DESC)")
cursor.execute("CREATE INDEX IF NOT EXISTS idx_status ON snippets(status)")
cursor.execute("CREATE INDEX IF NOT EXISTS idx_method ON snippets(method)")
cursor.execute("CREATE INDEX IF NOT EXISTS idx_slug ON snippets(slug)")
cursor.execute("CREATE INDEX IF NOT EXISTS idx_user ON snippets(user)")
# Create full-text search virtual table
cursor.execute(
"""
CREATE VIRTUAL TABLE IF NOT EXISTS snippets_fts
USING fts5(name, description, readme, app, content=snippets)
"""
)
conn.commit()
@contextmanager
def _get_connection(self) -> Generator[sqlite3.Connection, None, None]:
"""Get a database connection with context manager."""
conn = sqlite3.connect(str(self.db_path))
conn.row_factory = sqlite3.Row
try:
yield conn
finally:
conn.close()
def create_snippet(self, snippet: Snippet) -> Snippet:
"""Create a new snippet record.
Parameters
----------
snippet : Snippet
Snippet record to create
Returns
-------
Snippet
Created snippet record with ID
"""
with self._get_connection() as conn:
cursor = conn.cursor()
cursor.execute(
"""
INSERT INTO snippets
(id, app, name, description, readme, method, created_at, updated_at, status,
error_message, execution_time, requirements, extensions, user, tags, slug)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
""",
(
snippet.id,
snippet.app,
snippet.name,
snippet.description,
snippet.readme,
snippet.method,
snippet.created_at.isoformat(),
snippet.updated_at.isoformat(),
snippet.status,
snippet.error_message,
snippet.execution_time,
json.dumps(snippet.requirements),
json.dumps(snippet.extensions),
snippet.user,
json.dumps(snippet.tags),
snippet.slug,
),
)
# Update FTS index
cursor.execute(
"""
INSERT INTO snippets_fts(rowid, name, description, readme, app)
VALUES ((SELECT rowid FROM snippets WHERE id = ?), ?, ?, ?, ?)
""",
(snippet.id, snippet.name, snippet.description, snippet.readme, snippet.app),
)
conn.commit()
return snippet
def get_snippet(self, snippet_id: str) -> Optional[Snippet]:
"""Get a snippet record by ID.
Parameters
----------
snippet_id : str
Snippet ID
Returns
-------
Optional[Snippet]
Snippet record if found, None otherwise
"""
with self._get_connection() as conn:
cursor = conn.cursor()
cursor.execute("SELECT * FROM snippets WHERE id = ?", (snippet_id,))
row = cursor.fetchone()
if row:
return self._row_to_snippet(dict(row))
return None
def get_snippet_by_slug(self, slug: str) -> Optional[Snippet]:
"""Get the most recent snippet record by slug.
Parameters
----------
slug : str
Snippet slug
Returns
-------
Optional[Snippet]
Most recent snippet record with this slug if found, None otherwise
"""
with self._get_connection() as conn:
cursor = conn.cursor()
cursor.execute(
"SELECT * FROM snippets WHERE slug = ? ORDER BY created_at DESC LIMIT 1",
(slug,),
)
row = cursor.fetchone()
if row:
return self._row_to_snippet(dict(row))
return None
def update_snippet(
self,
snippet_id: str,
status: Optional[str] = None,
error_message: Optional[str] = None,
execution_time: Optional[float] = None,
requirements: Optional[list[str]] = None,
extensions: Optional[list[str]] = None,
) -> bool:
"""Update a snippet record.
Parameters
----------
snippet_id : str
Snippet ID
status : Optional[str]
New status
error_message : Optional[str]
Error message
execution_time : Optional[float]
Execution time
requirements : Optional[list[str]]
Required packages
extensions : Optional[list[str]]
Required extensions
Returns
-------
bool
True if updated, False if not found
"""
updates = []
params = []
if status is not None:
updates.append("status = ?")
params.append(status)
if error_message is not None:
updates.append("error_message = ?")
params.append(error_message)
if execution_time is not None:
updates.append("execution_time = ?")
params.append(str(execution_time))
if requirements is not None:
updates.append("requirements = ?")
params.append(json.dumps(requirements))
if extensions is not None:
updates.append("extensions = ?")
params.append(json.dumps(extensions))
if not updates:
return False
updates.append("updated_at = ?")
params.append(datetime.now(timezone.utc).isoformat())
params.append(snippet_id)
with self._get_connection() as conn:
cursor = conn.cursor()
cursor.execute(
f"UPDATE snippets SET {', '.join(updates)} WHERE id = ?",
params,
)
conn.commit()
return cursor.rowcount > 0
def list_snippets(
self,
limit: int = 100,
offset: int = 0,
start: Optional[datetime] = None,
end: Optional[datetime] = None,
status: Optional[str] = None,
method: Optional[str] = None,
) -> list[Snippet]:
"""List snippet records with filters.
Parameters
----------
limit : int
Maximum number of snippets to return
offset : int
Number of snippets to skip
start : Optional[datetime]
Filter snippets created after this time
end : Optional[datetime]
Filter snippets created before this time
status : Optional[str]
Filter by status
method : Optional[str]
Filter by method
Returns
-------
list[Snippet]
List of snippet records
"""
query = "SELECT * FROM snippets WHERE 1=1"
params = []
if start:
query += " AND created_at >= ?"
params.append(start.isoformat())
if end:
query += " AND created_at <= ?"
params.append(end.isoformat())
if status:
query += " AND status = ?"
params.append(status)
if method:
query += " AND method = ?"
params.append(method)
query += " ORDER BY created_at DESC LIMIT ? OFFSET ?"
params.extend([str(limit), str(offset)])
with self._get_connection() as conn:
cursor = conn.cursor()
cursor.execute(query, params)
rows = cursor.fetchall()
return [self._row_to_snippet(dict(row)) for row in rows]
def delete_snippet(self, snippet_id: str) -> bool:
"""Delete a snippet record.
Parameters
----------
snippet_id : str
Snippet ID
Returns
-------
bool
True if deleted, False if not found
"""
with self._get_connection() as conn:
cursor = conn.cursor()
# Delete from FTS index
cursor.execute(
"DELETE FROM snippets_fts WHERE rowid = (SELECT rowid FROM snippets WHERE id = ?)",
(snippet_id,),
)
# Delete from main table
cursor.execute("DELETE FROM snippets WHERE id = ?", (snippet_id,))
conn.commit()
return cursor.rowcount > 0
def search_snippets(self, query: str, limit: int = 100) -> list[Snippet]:
"""Search snippet records using full-text search.
Parameters
----------
query : str
Search query
limit : int
Maximum number of results
Returns
-------
list[Snippet]
Matching snippet records
"""
with self._get_connection() as conn:
cursor = conn.cursor()
cursor.execute(
"""
SELECT r.* FROM snippets r
JOIN snippets_fts fts ON r.rowid = fts.rowid
WHERE snippets_fts MATCH ?
ORDER BY r.created_at DESC
LIMIT ?
""",
(query, limit),
)
rows = cursor.fetchall()
return [self._row_to_snippet(dict(row)) for row in rows]
def create_visualization(
self,
app: str,
name: str = "",
description: str = "",
readme: str = "",
method: Literal["jupyter", "panel", "pyodide"] = "jupyter",
) -> Snippet:
"""Create a visualization request.
This is the core business logic for creating visualizations,
shared by both the HTTP API endpoint and the UI form.
Parameters
----------
app : str
Python code to execute
name : str, optional
Display name for the visualization
description : str, optional
Short description of the visualization
readme : str, optional
Longer documentation describing the app
method : str, optional
Execution method: "jupyter", "panel", or "pyodide"
Returns
-------
Snippet
The snippet created for the visualization request.
Raises
------
ValueError
If app is empty or contains unsupported operations
SyntaxError
If app has syntax errors
Exception
If database operation or other errors occur
"""
# Validate app is not empty
if not app:
raise ValueError("App code is required")
if ".show(" in app:
raise ValueError("`.show()` calls are not supported in this environment")
supported_methods = {"jupyter", "panel", "pyodide"}
if method not in supported_methods:
supported_text = ", ".join(sorted(supported_methods))
raise ValueError(f"Unsupported execution method '{method}'. Supported methods: {supported_text}")
# Validate syntax
ast.parse(app) # Raises SyntaxError if invalid
validation_result = validate_code(app)
# Infer requirements and extensions
requirements = find_requirements(app)
extensions = find_extensions(app) if method == "jupyter" else []
# Create snippet in database with "pending" status
snippet_obj = Snippet(
app=app,
name=name,
description=description,
readme=readme,
method=method,
requirements=requirements,
extensions=extensions,
status="success" if not validation_result else "error",
error_message=validation_result if validation_result else None,
)
snippet_saved = self.create_snippet(snippet_obj)
# Return result
return snippet_saved
@staticmethod
def _row_to_snippet(row: dict) -> Snippet:
"""Convert a database row to a Snippet."""
return Snippet(
id=row["id"],
app=row["app"],
name=row["name"] or "",
description=row["description"] or "",
readme=row.get("readme", ""),
method=row["method"],
created_at=datetime.fromisoformat(row["created_at"]),
updated_at=datetime.fromisoformat(row["updated_at"]),
status=row["status"],
error_message=row["error_message"],
execution_time=row["execution_time"],
requirements=json.loads(row["requirements"]) if row["requirements"] else [],
extensions=json.loads(row["extensions"]) if row["extensions"] else [],
user=row.get("user", "guest"),
tags=json.loads(row["tags"]) if row.get("tags") else [],
slug=row.get("slug", ""),
)
# Global database instance cache
_db_instance: Optional[SnippetDatabase] = None
def get_db(db_path: Optional[Path] = None) -> SnippetDatabase:
"""Get or create the SnippetDatabase instance.
This function implements lazy initialization with a global cache.
The database instance is created once and reused across the application.
Parameters
----------
db_path : Optional[Path]
Path to database file. If None, uses default from environment/config.
Only used on first call; subsequent calls ignore this parameter.
Returns
-------
SnippetDatabase
Shared database instance
"""
global _db_instance
if _db_instance is None:
if db_path is None:
# Try environment variable first
env_path = os.getenv("DISPLAY_DB_PATH", "")
if env_path:
db_path = Path(env_path)
else:
# Fall back to default location
db_path = get_config().display.db_path
logger.info(f"Initializing database at: {db_path}")
_db_instance = SnippetDatabase(db_path)
return _db_instance
def reset_db() -> None:
"""Reset the database instance.
This is primarily for testing purposes to ensure a clean state.
"""
global _db_instance
_db_instance = None