Skip to content

More pyi_generator tweaks #6319

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

Merged
masenf merged 6 commits into from
Apr 10, 2026
Merged

More pyi_generator tweaks #6319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
101fdb9
Add a Var[Callable] test case
masenf Apr 10, 2026
319e4eb
pyi_generator: import from collections.abc instead of typing
masenf Apr 10, 2026
0b34566
Unify _get_visible_type_name between type_to_ast and _get_type_hint
masenf Apr 10, 2026
fcd7d96
_get_visible_type_name also checks in EXCLUDED_IMPORTS
masenf Apr 10, 2026
f830f37
pyi_generator: Recognize post-prop docstring
masenf Apr 10, 2026
d69e528
apply greptile feedback
masenf Apr 10, 2026
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
89 changes: 75 additions & 14 deletions packages/reflex-base/src/reflex_base/utils/pyi_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,7 @@ def _safe_issubclass(cls: Any, cls_check: Any | tuple[Any, ...]) -> bool:

DEFAULT_TYPING_IMPORTS = {
"Any",
"Callable",
"Dict",
# "List",
"Sequence",
"Mapping",
"Literal",
"Optional",
"Union",
Expand All @@ -109,6 +105,7 @@ def _safe_issubclass(cls: Any, cls_check: Any | tuple[Any, ...]) -> bool:

# TODO: fix import ordering and unused imports with ruff later
DEFAULT_IMPORTS = {
"collections.abc": ["Callable", "Mapping", "Sequence"],
"typing": sorted(DEFAULT_TYPING_IMPORTS),
"reflex_components_core.core.breakpoints": ["Breakpoints"],
"reflex_base.event": [
Expand All @@ -124,6 +121,7 @@ def _safe_issubclass(cls: Any, cls_check: Any | tuple[Any, ...]) -> bool:
}
# These pre-0.9 imports might be present in the file and should be removed since the pyi generator will handle them separately.
EXCLUDED_IMPORTS = {
"typing": ["Callable", "Mapping", "Sequence"], # moved to collections.abc
"reflex.components.core.breakpoints": ["Breakpoints"],
"reflex.event": [
"EventChain",
Expand Down Expand Up @@ -316,28 +314,76 @@ def _get_class_prop_comments(clz: type[Component]) -> Mapping[str, tuple[str, ..
"""
props_comments: dict[str, tuple[str, ...]] = {}
comments = []
last_prop = ""
in_docstring = False
docstring_lines: list[str] = []
for line in _get_source(clz).splitlines():
stripped = line.strip()
Comment on lines 320 to +321
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Apr 10, 2026

Choose a reason for hiding this comment

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

P2 reached_functions check fires inside an open docstring

The def search runs on every line before the in_docstring guard is consulted. A prop docstring that mentions def in its prose (e.g., "Defines the callback spec.") will prematurely break the loop, silently dropping all subsequent prop comments. The in_docstring block should be evaluated first so that docstring content is never mistaken for a function boundary.

Suggested change
for line in _get_source(clz).splitlines():
reached_functions = re.search(r"def ", line)
if reached_functions:
# We've reached the functions, so stop.
break
stripped = line.strip()
for line in _get_source(clz).splitlines():
stripped = line.strip()
# Handle triple-quoted docstrings after prop definitions.
if in_docstring:
if '"""' in stripped or "'''" in stripped:
# End of multi-line docstring.
end_text = stripped.partition('"""')[0] or stripped.partition("'''")[0]
if end_text:
docstring_lines.append(end_text.strip())
if last_prop and docstring_lines:
props_comments[last_prop] = tuple(docstring_lines)
in_docstring = False
docstring_lines = []
last_prop = ""
else:
docstring_lines.append(stripped)
continue
reached_functions = re.search(r"def ", line)
if reached_functions:
# We've reached the functions, so stop.
break


# Handle triple-quoted docstrings after prop definitions.
# This must be checked before the `def ` boundary so that
# docstring prose containing "def " doesn't break the loop.
if in_docstring:
if '"""' in stripped or "'''" in stripped:
# End of multi-line docstring.
if '"""' in stripped:
end_text = stripped.partition('"""')[0].strip()
else:
end_text = stripped.partition("'''")[0].strip()
if end_text:
docstring_lines.append(end_text)
if last_prop and docstring_lines:
props_comments[last_prop] = tuple(docstring_lines)
in_docstring = False
Comment on lines +327 to +337
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot Apr 10, 2026

Choose a reason for hiding this comment

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

P1 Triple-quote on its own line incorrectly appends quotes to docstring content

When a multi-line docstring ends with the closing triple-quote alone on a line (e.g. """), stripped.partition('"""')[0] returns "" (empty, falsy), so the or falls through to stripped.partition("'''")[0], which returns '"""' (the whole string, since ''' is absent). That truthy value gets appended to docstring_lines, poisoning the stored comment with literal triple-quote characters.

# stripped = '"""' (closing quote on its own line)
stripped.partition('"""')[0]   # → '' (falsy)
stripped.partition("'''")[0]   # → '"""' (truthy) ← appended to docstring_lines by mistake

Fix by selecting the partition based on which quote type is actually present:

Suggested change
if '"""' in stripped or "'''" in stripped:
# End of multi-line docstring.
end_text = stripped.partition('"""')[0] or stripped.partition("'''")[0]
if end_text:
docstring_lines.append(end_text.strip())
if last_prop and docstring_lines:
props_comments[last_prop] = tuple(docstring_lines)
in_docstring = False
if in_docstring:
if '"""' in stripped or "'''" in stripped:
# End of multi-line docstring.
if '"""' in stripped:
end_text = stripped.partition('"""')[0].strip()
else:
end_text = stripped.partition("'''")[0].strip()
if end_text:
docstring_lines.append(end_text)
if last_prop and docstring_lines:
props_comments[last_prop] = tuple(docstring_lines)
in_docstring = False
docstring_lines = []
last_prop = ""

docstring_lines = []
last_prop = ""
else:
docstring_lines.append(stripped)
continue

reached_functions = re.search(r"def ", line)
if reached_functions:
# We've reached the functions, so stop.
break

# Check for start of a docstring right after a prop.
if last_prop and (stripped.startswith(('"""', "'''"))):
quote = '"""' if stripped.startswith('"""') else "'''"
content_after_open = stripped[3:]
if quote in content_after_open:
# Single-line docstring: """text"""
doc_text = content_after_open.partition(quote)[0].strip()
if doc_text:
props_comments[last_prop] = (doc_text,)
last_prop = ""
else:
# Multi-line docstring starts here.
in_docstring = True
docstring_lines = []
first_line = content_after_open.strip()
if first_line:
docstring_lines.append(first_line)
continue

if line == "":
# We hit a blank line, so clear comments to avoid commented out prop appearing in next prop docs.
comments.clear()
last_prop = ""
continue

# Get comments for prop
if line.strip().startswith("#"):
if stripped.startswith("#"):
# Remove noqa from the comments.
line = line.partition(" # noqa")[0]
comments.append(line)
last_prop = ""
continue

# Check if this line has a prop.
match = re.search(r"\w+:", line)
if match is None:
# This line doesn't have a var, so continue.
last_prop = ""
continue

# Get the prop.
Expand All @@ -347,6 +393,7 @@ def _get_class_prop_comments(clz: type[Component]) -> Mapping[str, tuple[str, ..
comment.strip().lstrip("#").strip() for comment in comments
)
comments.clear()
last_prop = prop

return MappingProxyType(props_comments)

Expand Down Expand Up @@ -629,11 +676,13 @@ def _get_visible_type_name(
if type_hint_globals is None:
return None

type_module = getattr(typ, "__module__", None)
type_name = getattr(typ, "__name__", None)
if (
type_name is not None
and type_name in type_hint_globals
and type_hint_globals[type_name] is typ

if type_name is not None and (
type_hint_globals.get(type_name) is typ
or type_name in DEFAULT_IMPORTS.get(str(type_module), set())
or type_name in EXCLUDED_IMPORTS.get(str(type_module), set())
):
return type_name

Expand Down Expand Up @@ -688,11 +737,6 @@ def type_to_ast(
return ast.Name(id=typ.__name__)
if visible_name := _get_visible_type_name(typ, type_hint_globals):
return ast.Name(id=visible_name)
if (
typ.__module__ in DEFAULT_IMPORTS
and typ.__name__ in DEFAULT_IMPORTS[typ.__module__]
):
return ast.Name(id=typ.__name__)
return ast.Name(id=typ.__module__ + "." + typ.__name__)
return ast.Name(id=typ.__name__)
if hasattr(typ, "_name"):
Expand Down Expand Up @@ -1291,6 +1335,23 @@ def visit_Assign(self, node: ast.Assign) -> ast.Assign | None:

return node

def visit_Expr(self, node: ast.Expr) -> ast.Expr | None:
"""Remove bare string expressions (attribute docstrings) in component classes.

Args:
node: The Expr node to visit.

Returns:
The modified Expr node (or None).
"""
if (
self._current_class_is_component()
and isinstance(node.value, ast.Constant)
and isinstance(node.value.value, str)
):
return None
return node

def visit_AnnAssign(self, node: ast.AnnAssign) -> ast.AnnAssign | None:
"""Visit an AnnAssign node (Annotated assignment).

Expand Down
Loading
Loading