Skip to content

bug(typing): Fix typing issues in latest click package #604

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
merged 5 commits into from
Jul 10, 2023
Merged

bug(typing): Fix typing issues in latest click package #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
52001b5
Update `click` to >= v8.1.4
schloerke Jul 7, 2023
7728410
Set `name` in `click.group(name="main")`
schloerke Jul 7, 2023
6b3275b
Use a TypedDict for `reload_args` to use explicit keys
schloerke Jul 7, 2023
cba4ebc
Fix typing import location
schloerke Jul 7, 2023
db0b088
Use familar `__all__` syntax instead of `_: 'A | B' # type: ignore`
schloerke Jul 7, 2023
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 setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ install_requires =
websockets>=10.0
python-multipart
htmltools>=0.2.1
click>=8.0.3
click>=8.1.4
markdown-it-py>=1.1.0
# This is needed for markdown-it-py. Without it, when loading shiny/ui/_markdown.py,
# Python emits the following: "UserWarning: The 'tasklists' feature of GitHub
Expand Down
13 changes: 10 additions & 3 deletions shiny/_main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@
import shiny

from . import _autoreload, _hostenv, _static, _utils
from ._typing_extensions import NotRequired, TypedDict


@click.group() # pyright: ignore[reportUnknownMemberType]
@click.group("main")
def main() -> None:
pass

Expand Down Expand Up @@ -233,7 +234,7 @@ def run_app(
else:
setup_hot_reload(log_config, autoreload_port, port, launch_browser)

reload_args: dict[str, bool | str | list[str]] = {}
reload_args: ReloadArgs = {}
if reload:
reload_dirs = []
if app_dir is not None:
Expand All @@ -253,7 +254,7 @@ def run_app(
maybe_setup_rsw_proxying(log_config)

uvicorn.run( # pyright: ignore[reportUnknownMemberType]
app, # pyright: ignore[reportGeneralTypeIssues]
app,
host=host,
port=port,
ws_max_size=ws_max_size,
Expand Down Expand Up @@ -446,3 +447,9 @@ def static_assets(command: str) -> None:
_static.print_shinylive_local_info()
else:
raise click.UsageError(f"Unknown command: {command}")


class ReloadArgs(TypedDict):
reload: NotRequired[bool]
reload_includes: NotRequired[list[str]]
reload_dirs: NotRequired[list[str]]
16 changes: 9 additions & 7 deletions shiny/_typing_extensions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
# flake8: noqa: F401
# pyright: reportUnusedImport=false

__all__ = (
"Concatenate",
"ParamSpec",
"TypeGuard",
"NotRequired",
"TypedDict",
"assert_type",
)


import sys

Expand All @@ -17,10 +26,3 @@
from typing import NotRequired, TypedDict, assert_type
else:
from typing_extensions import NotRequired, TypedDict, assert_type


# The only purpose of the following line is so that pyright will put all of the
# conditional imports into the .pyi file when generating type stubs. Without this line,
# pyright will not include the above imports in the generated .pyi file, and it will
# result in a lot of red squiggles in user code.
_: 'Concatenate[str, ParamSpec("P")] | ParamSpec | TypeGuard | NotRequired | TypedDict | assert_type' # type:ignore