`. + **props: The props of the component. + + Returns: + The component. + + Raises: + TypeError: If an invalid child is passed. + """ + ... diff --git a/reflex/config.pyi b/reflex/config.pyi new file mode 100644 index 000000000..70390dca9 --- /dev/null +++ b/reflex/config.pyi @@ -0,0 +1,101 @@ +""" Generated with stubgen from mypy, then manually edited, do not regen.""" + +from reflex import constants as constants +from reflex.base import Base as Base +from reflex.utils import console as console +from typing import Any, Dict, List, Optional, overload + +class DBConfig(Base): + engine: str + username: Optional[str] + password: Optional[str] + host: Optional[str] + port: Optional[int] + database: str + + def __init__( + self, + database: str, + engine: str, + username: Optional[str] = None, + password: Optional[str] = None, + host: Optional[str] = None, + port: Optional[int] = None, + ): ... + @classmethod + def postgresql( + cls, + database: str, + username: str, + password: str | None = ..., + host: str | None = ..., + port: int | None = ..., + ) -> DBConfig: ... + @classmethod + def postgresql_psycopg2( + cls, + database: str, + username: str, + password: str | None = ..., + host: str | None = ..., + port: int | None = ..., + ) -> DBConfig: ... + @classmethod + def sqlite(cls, database: str) -> DBConfig: ... + def get_url(self) -> str: ... + +class Config(Base): + class Config: + validate_assignment: bool + app_name: str + loglevel: constants.LogLevel + frontend_port: int + frontend_path: str + backend_port: int + api_url: str + deploy_url: Optional[str] + backend_host: str + db_url: Optional[str] + redis_url: Optional[str] + telemetry_enabled: bool + bun_path: str + cors_allowed_origins: List[str] + tailwind: Optional[Dict[str, Any]] + timeout: int + next_compression: bool + event_namespace: Optional[str] + frontend_packages: List[str] + rxdeploy_url: Optional[str] + username: Optional[str] + + def __init__( + self, + *args, + app_name: str, + loglevel: Optional[constants.LogLevel] = None, + frontend_port: Optional[int] = None, + frontend_path: Optional[str] = None, + backend_port: Optional[int] = None, + api_url: Optional[str] = None, + deploy_url: Optional[str] = None, + backend_host: Optional[str] = None, + db_url: Optional[str] = None, + redis_url: Optional[str] = None, + telemetry_enabled: Optional[bool] = None, + bun_path: Optional[str] = None, + cors_allowed_origins: Optional[List[str]] = None, + tailwind: Optional[Dict[str, Any]] = None, + timeout: Optional[int] = None, + next_compression: Optional[bool] = None, + event_namespace: Optional[str] = None, + frontend_packages: Optional[List[str]] = None, + rxdeploy_url: Optional[str] = None, + username: Optional[str] = None, + **kwargs + ) -> None: ... + @staticmethod + def check_deprecated_values(**kwargs) -> None: ... + def update_from_env(self) -> None: ... + def get_event_namespace(self) -> str | None: ... + +def get_config(reload: bool = ...) -> Config: ... diff --git a/scripts/pyi_generator.py b/scripts/pyi_generator.py index 981718c61..f43554149 100644 --- a/scripts/pyi_generator.py +++ b/scripts/pyi_generator.py @@ -3,6 +3,7 @@ import importlib import inspect import os +import re import sys from inspect import getfullargspec from pathlib import Path @@ -99,10 +100,10 @@ class PyiGenerator: f"from typing import {','.join(typing_imports)}", *[f"from {base.__module__} import {base.__name__}" for base in bases], "from reflex.vars import Var, BaseVar, ComputedVar", - "from reflex.event import EventChain", + "from reflex.event import EventHandler, EventChain, EventSpec", ] - def _generate_pyi_class(self, _class): + def _generate_pyi_class(self, _class: type[Component]): create_spec = getfullargspec(_class.create) lines = [ "", @@ -121,12 +122,60 @@ class PyiGenerator: continue definition += f"{name}: {_get_type_hint(value)} = None, " - definition = definition.rstrip(", ") - definition += f", **props) -> '{_class.__name__}': ... # type: ignore" + for trigger in sorted(_class().get_triggers()): + definition += f"{trigger}: Optional[Union[EventHandler, EventSpec, List, function, BaseVar]] = None, " + definition = definition.rstrip(", ") + definition += f", **props) -> '{_class.__name__}': # type: ignore\n" + + definition += self._generate_docstrings(_class, _class.__annotations__.keys()) lines.append(definition) + lines.append(" ...") return lines + def _generate_docstrings(self, _class, _props): + props_comments = {} + comments = [] + for _i, line in enumerate(inspect.getsource(_class).splitlines()): + reached_functions = re.search("def ", line) + if reached_functions: + # We've reached the functions, so stop. + break + + # Get comments for prop + if line.strip().startswith("#"): + comments.append(line) + continue + + # Check if this line has a prop. + match = re.search("\\w+:", line) + if match is None: + # This line doesn't have a var, so continue. + continue + + # Get the prop. + prop = match.group(0).strip(":") + if prop in _props: + # This isn't a prop, so continue. + props_comments[prop] = "\n".join( + [comment.strip().strip("#") for comment in comments] + ) + comments.clear() + continue + new_docstring = [] + for i, line in enumerate(_class.create.__doc__.splitlines()): + if i == 0: + new_docstring.append(" " * 8 + '"""' + line) + else: + new_docstring.append(line) + if "*children" in line: + for nline in [ + f"{line.split('*')[0]}{n}:{c}" for n, c in props_comments.items() + ]: + new_docstring.append(nline) + new_docstring += ['"""'] + return "\n".join(new_docstring) + def _generate_pyi_variable(self, _name, _var): return _get_var_definition(self.current_module, _name) @@ -177,11 +226,8 @@ class PyiGenerator: (name, obj) for name, obj in vars(self.current_module).items() if not name.startswith("__") - # and ( - # not inspect.getmodule(obj) - # or inspect.getmodule(obj) == self.current_module - # ) - and not inspect.isclass(obj) and not inspect.isfunction(obj) + and not inspect.isclass(obj) + and not inspect.isfunction(obj) ] functions = [ diff --git a/tests/components/datadisplay/test_datatable.py b/tests/components/datadisplay/test_datatable.py index da525fcae..94446c6bb 100644 --- a/tests/components/datadisplay/test_datatable.py +++ b/tests/components/datadisplay/test_datatable.py @@ -30,10 +30,12 @@ def test_validate_data_table(data_table_state: rx.Var, expected): expected: expected var name. """ - props = {"data": data_table_state.data} if not types.is_dataframe(data_table_state.data.type_): - props["columns"] = data_table_state.columns - data_table_component = data_table(**props) + data_table_component = data_table( + data=data_table_state.data, columns=data_table_state.columns + ) + else: + data_table_component = data_table(data=data_table_state.data) data_table_dict = data_table_component.render() diff --git a/tests/test_app.py b/tests/test_app.py index 980c31849..51f45621e 100644 --- a/tests/test_app.py +++ b/tests/test_app.py @@ -832,7 +832,7 @@ async def test_dynamic_route_var_route_change_completed_on_load( sid=sid, headers={}, client_ip=client_ip, - ).__anext__() + ).__anext__() # type: ignore # route change triggers: [full state dict, call on_load events, call set_is_hydrated(True)] assert update == StateUpdate( @@ -867,7 +867,7 @@ async def test_dynamic_route_var_route_change_completed_on_load( sid=sid, headers={}, client_ip=client_ip, - ).__anext__() + ).__anext__() # type: ignore assert on_load_update == StateUpdate( delta={ state.get_name(): { @@ -887,7 +887,7 @@ async def test_dynamic_route_var_route_change_completed_on_load( sid=sid, headers={}, client_ip=client_ip, - ).__anext__() + ).__anext__() # type: ignore assert on_set_is_hydrated_update == StateUpdate( delta={ state.get_name(): { @@ -907,7 +907,7 @@ async def test_dynamic_route_var_route_change_completed_on_load( sid=sid, headers={}, client_ip=client_ip, - ).__anext__() + ).__anext__() # type: ignore assert update == StateUpdate( delta={ state.get_name(): { @@ -949,7 +949,7 @@ async def test_process_events(gen_state, mocker): token="token", name="gen_state.go", payload={"c": 5}, router_data=router_data ) - async for _update in process(app, event, "mock_sid", {}, "127.0.0.1"): + async for _update in process(app, event, "mock_sid", {}, "127.0.0.1"): # type: ignore pass assert app.state_manager.get_state("token").value == 5 @@ -985,7 +985,7 @@ def test_overlay_component( assert app.overlay_component is None elif isinstance(exp_page_child, Fragment): assert app.overlay_component is not None - generated_component = app._generate_component(app.overlay_component) + generated_component = app._generate_component(app.overlay_component) # type: ignore assert isinstance(generated_component, Fragment) assert isinstance( generated_component.children[0], @@ -994,7 +994,7 @@ def test_overlay_component( else: assert app.overlay_component is not None assert isinstance( - app._generate_component(app.overlay_component), + app._generate_component(app.overlay_component), # type: ignore exp_page_child, ) diff --git a/tests/test_config.py b/tests/test_config.py index 2bc92e8be..ee62bc1c3 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -1,4 +1,5 @@ import os +from typing import Any, Dict import pytest @@ -10,7 +11,7 @@ from reflex.constants import Endpoint def test_requires_app_name(): """Test that a config requires an app_name.""" with pytest.raises(ValueError): - rx.Config() + rx.Config() # type: ignore def test_set_app_name(base_config_values): @@ -31,7 +32,7 @@ def test_set_app_name(base_config_values): "env_path", ], ) -def test_deprecated_params(base_config_values, param): +def test_deprecated_params(base_config_values: Dict[str, Any], param): """Test that deprecated params are removed from the config. Args: @@ -39,7 +40,7 @@ def test_deprecated_params(base_config_values, param): param: The deprecated param. """ with pytest.raises(ValueError): - rx.Config(**base_config_values, **{param: "test"}) + rx.Config(**base_config_values, **{param: "test"}) # type: ignore @pytest.mark.parametrize(