Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

strongly type backend experimental flag (#6100)

Shahmir Varqha6d5239372d97
diff --git a/frontend/src/core/config/feature-flag.tsx b/frontend/src/core/config/feature-flag.tsx
index 0897eab55a..c2c08a3274 100644
--- a/frontend/src/core/config/feature-flag.tsx
+++ b/frontend/src/core/config/feature-flag.tsx
@@ -1,6 +1,5 @@
/* Copyright 2024 Marimo. All rights reserved. */
-import type { UserConfig } from "vite";
import { repl } from "@/utils/repl";
import { getRequestClient } from "../network/requests";
import { getResolvedMarimoConfig } from "./config";
@@ -37,10 +36,7 @@ export function getFeatureFlag<T extends keyof ExperimentalFeatures>(
);
}
-function setFeatureFlag(
- feature: keyof UserConfig["experimental"],
- value: boolean,
-) {
+function setFeatureFlag(feature: keyof ExperimentalFeatures, value: boolean) {
const userConfig = getResolvedMarimoConfig();
userConfig.experimental = userConfig.experimental ?? {};
userConfig.experimental[feature] = value;
diff --git a/marimo/_cli/development/commands.py b/marimo/_cli/development/commands.py
index abc0908e43..7979fd5377 100644
--- a/marimo/_cli/development/commands.py
+++ b/marimo/_cli/development/commands.py
@@ -68,6 +68,7 @@ def _generate_server_api_schema() -> dict[str, Any]:
config.BedrockConfig,
config.AiConfig,
config.MarimoConfig,
+ config.StoreConfig,
# Errors
errors.SetupRootError,
errors.MultipleDefinitionError,
diff --git a/marimo/_cli/envinfo.py b/marimo/_cli/envinfo.py
index 8848d804d4..93a582e23e 100644
--- a/marimo/_cli/envinfo.py
+++ b/marimo/_cli/envinfo.py
@@ -31,13 +31,15 @@ def is_win11() -> bool:
return False
-def get_experimental_flags() -> dict[str, bool]:
+def get_experimental_flags() -> dict[str, Union[str, bool, dict[str, Any]]]:
try:
config = get_default_config_manager(current_path=None).get_config()
- if "experimental" in config:
- return config["experimental"]
- else:
- return {}
+ experimental_config = config.get("experimental", {})
+ return {
+ k: v
+ for k, v in experimental_config.items()
+ if isinstance(v, (str, bool, dict))
+ }
except Exception:
LOGGER.error("Failed to get experimental flags")
return {}
diff --git a/marimo/_config/config.py b/marimo/_config/config.py
index 4a4ea1be30..e0101db6c3 100644
--- a/marimo/_config/config.py
+++ b/marimo/_config/config.py
@@ -100,6 +100,7 @@ WidthType = Literal["normal", "compact", "medium", "full", "columns"]
Theme = Literal["light", "dark", "system"]
ExportType = Literal["html", "markdown", "ipynb"]
SqlOutputType = Literal["polars", "lazy-polars", "pandas", "native", "auto"]
+StoreKey = Literal["file", "redis", "rest", "tiered"]
@mddoc
@@ -478,6 +479,38 @@ class SharingConfig(TypedDict):
wasm: NotRequired[bool]
+@dataclass
+class StoreConfig(TypedDict, total=False):
+ """Configuration for cache stores."""
+
+ type: StoreKey
+ args: dict[str, Any]
+
+
+CacheConfig = Union[list[StoreConfig], StoreConfig]
+
+
+@dataclass
+class ExperimentalConfig(TypedDict, total=False):
+ """
+ Configuration for experimental features.
+
+ Features exposed on the frontend must match the frontend config.
+ """
+
+ markdown: bool # Used in playground (community cloud)
+ inline_ai_tooltip: bool
+ wasm_layouts: bool # Used in playground (community cloud)
+ rtc_v2: bool
+ performant_table_charts: bool
+ mcp_docs: bool
+ sql_linter: bool
+
+ # Internal features
+ cache: CacheConfig
+ execution_type: ExecutionType
+
+
@mddoc
@dataclass
class MarimoConfig(TypedDict):
@@ -494,7 +527,7 @@ class MarimoConfig(TypedDict):
ai: NotRequired[AiConfig]
language_servers: NotRequired[LanguageServersConfig]
diagnostics: NotRequired[DiagnosticsConfig]
- experimental: NotRequired[dict[str, Any]]
+ experimental: NotRequired[ExperimentalConfig]
snippets: NotRequired[SnippetsConfig]
datasources: NotRequired[DatasourcesConfig]
sharing: NotRequired[SharingConfig]
@@ -567,7 +600,7 @@ class PartialMarimoConfig(TypedDict, total=False):
ai: NotRequired[AiConfig]
language_servers: NotRequired[LanguageServersConfig]
diagnostics: NotRequired[DiagnosticsConfig]
- experimental: NotRequired[dict[str, Any]]
+ experimental: NotRequired[ExperimentalConfig]
snippets: SnippetsConfig
datasources: NotRequired[DatasourcesConfig]
sharing: NotRequired[SharingConfig]
diff --git a/marimo/_config/manager.py b/marimo/_config/manager.py
index 85bb4a01b0..3adb308eee 100644
--- a/marimo/_config/manager.py
+++ b/marimo/_config/manager.py
@@ -5,12 +5,13 @@ import os
from abc import abstractmethod
from functools import cached_property
from pathlib import Path
-from typing import Any, Optional, Union, cast
+from typing import Optional, Union, cast
from marimo import _loggers
from marimo._config.config import (
DEFAULT_CONFIG,
CompletionConfig,
+ ExperimentalConfig,
ExportType,
LanguageServersConfig,
MarimoConfig,
@@ -107,7 +108,7 @@ class MarimoConfigReader:
return {}
@property
- def experimental(self) -> dict[str, Any]:
+ def experimental(self) -> ExperimentalConfig:
if "experimental" in self._config:
return self._config["experimental"]
return {}
diff --git a/marimo/_runtime/threads.py b/marimo/_runtime/threads.py
index 3069e17996..f47a8e9d89 100644
--- a/marimo/_runtime/threads.py
+++ b/marimo/_runtime/threads.py
@@ -18,7 +18,7 @@ from marimo._runtime.context.types import (
)
# Set of thread ids for running mo.Threads
-THREADS = set()
+THREADS: set[int] = set()
class Thread(threading.Thread):
diff --git a/marimo/_save/stores/__init__.py b/marimo/_save/stores/__init__.py
index 23055798d6..c37e5dafcd 100644
--- a/marimo/_save/stores/__init__.py
+++ b/marimo/_save/stores/__init__.py
@@ -1,8 +1,9 @@
# Copyright 2025 Marimo. All rights reserved.
import copy
-from typing import Any, Literal, Optional, TypedDict, Union, cast
+from typing import Optional, cast
from marimo import _loggers
+from marimo._config.config import CacheConfig, StoreKey
from marimo._entrypoints.registry import EntryPointRegistry
from marimo._save.stores.file import FileStore
from marimo._save.stores.redis import RedisStore
@@ -12,13 +13,6 @@ from marimo._save.stores.tiered import TieredStore
LOGGER = _loggers.marimo_logger()
-StoreKey = Literal["file", "redis", "rest", "tiered"]
-
-
-class StoreConfig(TypedDict, total=False):
- type: StoreKey
- args: dict[str, Any]
-
CACHE_STORES: dict[StoreKey, StoreType] = {
"file": FileStore,
@@ -37,18 +31,18 @@ _STORE_REGISTRY = EntryPointRegistry[StoreType](
def get_store(current_path: Optional[str] = None) -> Store:
from marimo._config.manager import get_default_config_manager
- cache_config: Union[list[StoreConfig], StoreConfig] = (
+ cache_config: Optional[CacheConfig] = (
get_default_config_manager(current_path=current_path)
.get_config()
.get("experimental", {})
- .get("cache", {})
+ .get("cache", None)
)
return _get_store_from_config(cache_config)
def _get_store_from_config(
- config: Union[list[StoreConfig], StoreConfig, None],
+ config: Optional[CacheConfig],
registry: EntryPointRegistry[StoreType] = _STORE_REGISTRY,
) -> Store:
if config is None:
diff --git a/packages/openapi/api.yaml b/packages/openapi/api.yaml
index f6283bdd7d..16e2b512ba 100644
--- a/packages/openapi/api.yaml
+++ b/packages/openapi/api.yaml
@@ -1623,7 +1623,43 @@ components:
- default_table_max_columns
type: object
experimental:
- additionalProperties: {}
+ properties:
+ cache:
+ oneOf:
+ - items:
+ properties:
+ args:
+ additionalProperties: {}
+ type: object
+ type:
+ enum:
+ - file
+ - redis
+ - rest
+ - tiered
+ type: string
+ type: object
+ type: array
+ - $ref: '#/components/schemas/StoreConfig'
+ execution_type:
+ enum:
+ - relaxed
+ - strict
+ type: string
+ inline_ai_tooltip:
+ type: boolean
+ markdown:
+ type: boolean
+ mcp_docs:
+ type: boolean
+ performant_table_charts:
+ type: boolean
+ rtc_v2:
+ type: boolean
+ sql_linter:
+ type: boolean
+ wasm_layouts:
+ type: boolean
type: object
formatting:
properties:
@@ -2617,6 +2653,19 @@ components:
StopRequest:
properties: {}
type: object
+ StoreConfig:
+ properties:
+ args:
+ additionalProperties: {}
+ type: object
+ type:
+ enum:
+ - file
+ - redis
+ - rest
+ - tiered
+ type: string
+ type: object
SuccessResponse:
properties:
success:
diff --git a/packages/openapi/src/api.ts b/packages/openapi/src/api.ts
index 09f6a1a7bd..24867ffe14 100644
--- a/packages/openapi/src/api.ts
+++ b/packages/openapi/src/api.ts
@@ -3222,7 +3222,24 @@ export interface components {
theme: "light" | "dark" | "system";
};
experimental?: {
- [key: string]: unknown;
+ cache?:
+ | {
+ args?: {
+ [key: string]: unknown;
+ };
+ /** @enum {string} */
+ type?: "file" | "redis" | "rest" | "tiered";
+ }[]
+ | components["schemas"]["StoreConfig"];
+ /** @enum {string} */
+ execution_type?: "relaxed" | "strict";
+ inline_ai_tooltip?: boolean;
+ markdown?: boolean;
+ mcp_docs?: boolean;
+ performant_table_charts?: boolean;
+ rtc_v2?: boolean;
+ sql_linter?: boolean;
+ wasm_layouts?: boolean;
};
formatting: {
line_length: number;
@@ -3637,6 +3654,13 @@ export interface components {
text: string;
};
StopRequest: Record<string, never>;
+ StoreConfig: {
+ args?: {
+ [key: string]: unknown;
+ };
+ /** @enum {string} */
+ type?: "file" | "redis" | "rest" | "tiered";
+ };
SuccessResponse: {
success: boolean;
};
diff --git a/tests/_server/api/endpoints/test_ws.py b/tests/_server/api/endpoints/test_ws.py
index 9b3af3b627..8d52794105 100644
--- a/tests/_server/api/endpoints/test_ws.py
+++ b/tests/_server/api/endpoints/test_ws.py
@@ -9,6 +9,7 @@ from typing import TYPE_CHECKING, Any, Optional
import pytest
from starlette.websockets import WebSocketDisconnect
+from marimo._config.config import ExperimentalConfig
from marimo._config.manager import UserConfigManager
from marimo._messaging.ops import KernelCapabilities, KernelReady
from marimo._server.api.endpoints.ws import (
@@ -358,7 +359,8 @@ def flush_messages(
def rtc_enabled(config: UserConfigManager):
prev_config = config.get_config()
try:
- config.save_config({"experimental": {"rtc_v2": True}})
+ experimental_config = ExperimentalConfig(rtc_v2=True)
+ config.save_config({"experimental": experimental_config})
yield
finally:
config.save_config(prev_config)