Skip to content

fix: reject string CodeBlock theme to surface invalid values at create time #6419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
FarhanAliRaza wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: reject string CodeBlock theme to surface invalid values at create time #6419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/reflex-components-code/src/reflex_components_code/code.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ class CodeBlock(Component, MarkdownComponentMap):

alias = "SyntaxHighlighter"

theme: Var[Theme | str] = field(
theme: Var[Theme] = field(
default=Theme.one_light, doc='The theme to use ("light" or "dark").'
)
Comment on lines +390 to 392
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Misleading docstring conflicts with new type restriction

The doc string 'The theme to use ("light" or "dark").' implies that plain string values like "light" or "dark" are acceptable, which directly contradicts the narrowed type Var[Theme] that now rejects strings at create time. A user following the docstring will hit a TypeError. Consider updating it to reflect the correct usage, e.g. 'The theme to use (e.g. Theme.one_light or Theme.one_dark).'

Suggested change
theme: Var[Theme] = field(
default=Theme.one_light, doc='The theme to use ("light" or "dark").'
)
theme: Var[Theme] = field(
default=Theme.one_light, doc="The theme to use (e.g. Theme.one_light or Theme.one_dark)."
)

Copy link
Copy Markdown
Member

@adhami3310 adhami3310 Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

valid concern by greptile here


Expand Down
2 changes: 1 addition & 1 deletion pyi_hashes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"packages/reflex-components-code/src/reflex_components_code/code.pyi": "a879ccd253e901964a7ab7ea7154f904",
"packages/reflex-components-code/src/reflex_components_code/code.pyi": "d3b9e3fe258afa06a1125aa81dc94983",
"packages/reflex-components-code/src/reflex_components_code/shiki_code_block.pyi": "d3e0c33fdc34f5c154ac387d550c0d29",
"packages/reflex-components-core/src/reflex_components_core/__init__.pyi": "82b29d23f2490161d42fd21021bd39c3",
"packages/reflex-components-core/src/reflex_components_core/base/__init__.pyi": "7009187aaaf191814d031e5462c48318",
Expand Down
5 changes: 5 additions & 0 deletions tests/units/components/datadisplay/test_code.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,8 @@ def test_code_light_dark_theme(theme, expected):
code_block = CodeBlock.create(theme=theme)

assert code_block.theme._js_expr == expected # pyright: ignore [reportAttributeAccessIssue]


def test_code_block_rejects_string_theme():
with pytest.raises(TypeError, match=r"CodeBlock\.theme"):
CodeBlock.create("print('Hello')", theme="one_dark") # pyright: ignore[reportArgumentType]
Loading