Skip to content

fix some typing issues #2841

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.

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 6 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).

- [#2987](https://github.com/plotly/dash/pull/2987) Fix multioutput requiring same number of no_update. Fixes [#2986](https://github.com/plotly/dash/issues/2986)
- [2988](https://github.com/plotly/dash/pull/2988) Fix error handler and grouped outputs. Fixes [#2983](https://github.com/plotly/dash/issues/2983)
- [#2841](https://github.com/plotly/dash/pull/2841) Fix typing on Dash init.

## Deprecated

Expand Down
5 changes: 3 additions & 2 deletions dash/_jupyter.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import threading
import time

from typing import Optional
from typing_extensions import Literal

from werkzeug.serving import make_server
Expand Down Expand Up @@ -228,7 +229,7 @@ def _receive_message(msg):
def run_app(
self,
app,
mode: JupyterDisplayMode = None,
mode: Optional[JupyterDisplayMode] = None,
width="100%",
height=650,
host="127.0.0.1",
Expand Down Expand Up @@ -266,7 +267,7 @@ def run_app(
f" Received value of type {type(mode)}: {repr(mode)}"
)
else:
mode = mode.lower()
mode = mode.lower() # type: ignore
if mode not in valid_display_values:
raise ValueError(
f"Invalid display argument {mode}\n"
Expand Down
90 changes: 50 additions & 40 deletions dash/dash.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import base64
import traceback
from urllib.parse import urlparse
from typing import Any, Callable, Dict, Optional, Union
from typing import Any, Callable, Dict, Optional, Union, List

import flask

Expand Down Expand Up @@ -175,11 +175,13 @@ def _do_skip(error):

# werkzeug<2.1.0
if hasattr(tbtools, "get_current_traceback"):
return tbtools.get_current_traceback(skip=_get_skip(error)).render_full()
return tbtools.get_current_traceback( # type: ignore
skip=_get_skip(error)
).render_full()

if hasattr(tbtools, "DebugTraceback"):
# pylint: disable=no-member
return tbtools.DebugTraceback(
return tbtools.DebugTraceback( # type: ignore
error, skip=_get_skip(error)
).render_debugger_html(True, secret, True)

Expand Down Expand Up @@ -378,41 +380,47 @@ class Dash:
_plotlyjs_url: str
STARTUP_ROUTES: list = []

Copy link
Contributor

Choose a reason for hiding this comment

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

we can add server: flask.Flask here.

server: flask.Flask

def __init__( # pylint: disable=too-many-statements
self,
name=None,
server=True,
assets_folder="assets",
pages_folder="pages",
use_pages=None,
assets_url_path="assets",
assets_ignore="",
assets_external_path=None,
eager_loading=False,
include_assets_files=True,
include_pages_meta=True,
url_base_pathname=None,
requests_pathname_prefix=None,
routes_pathname_prefix=None,
serve_locally=True,
compress=None,
meta_tags=None,
index_string=_default_index,
external_scripts=None,
external_stylesheets=None,
suppress_callback_exceptions=None,
prevent_initial_callbacks=False,
show_undo_redo=False,
extra_hot_reload_paths=None,
plugins=None,
title="Dash",
update_title="Updating...",
long_callback_manager=None,
background_callback_manager=None,
add_log_handler=True,
hooks: Union[RendererHooks, None] = None,
name: Optional[str] = None,
server: Union[bool, flask.Flask] = True,
assets_folder: str = "assets",
pages_folder: str = "pages",
use_pages: Optional[bool] = None,
assets_url_path: str = "assets",
assets_ignore: str = "",
assets_external_path: Optional[str] = None,
eager_loading: bool = False,
include_assets_files: bool = True,
include_pages_meta: bool = True,
url_base_pathname: Optional[str] = None,
requests_pathname_prefix: Optional[str] = None,
routes_pathname_prefix: Optional[str] = None,
serve_locally: bool = True,
compress: Optional[bool] = None,
meta_tags: Optional[List[Dict[str, Any]]] = None,
index_string: str = _default_index,
external_scripts: Optional[List[Union[str, Dict[str, Any]]]] = None,
external_stylesheets: Optional[List[Union[str, Dict[str, Any]]]] = None,
Comment on lines +403 to +406
Copy link
Contributor

Choose a reason for hiding this comment

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

Those Any in the Dict would be str

suppress_callback_exceptions: Optional[bool] = None,
prevent_initial_callbacks: bool = False,
show_undo_redo: bool = False,
extra_hot_reload_paths: Optional[List[str]] = None,
plugins: Optional[list] = None,
title: str = "Dash",
update_title: str = "Updating...",
long_callback_manager: Optional[
Any
] = None, # Type should be specified if possible
background_callback_manager: Optional[
Any
] = None, # Type should be specified if possible
Comment on lines +414 to +419
Copy link
Contributor

Choose a reason for hiding this comment

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

Both of those should be of type dash.long_callback.managers.BaseLongCallbackManager

add_log_handler: bool = True,
hooks: Optional[RendererHooks] = None,
routing_callback_inputs: Optional[Dict[str, Union[Input, State]]] = None,
description=None,
description: Optional[str] = None,
on_error: Optional[Callable[[Exception], Any]] = None,
**obsolete,
):
Expand All @@ -428,7 +436,7 @@ def __init__( # pylint: disable=too-many-statements
name = getattr(server, "name", caller_name)
elif isinstance(server, bool):
name = name if name else caller_name
self.server = flask.Flask(name) if server else None
self.server = flask.Flask(name) if server else None # type: ignore
else:
raise ValueError("server must be a Flask app or a boolean")

Expand All @@ -440,7 +448,7 @@ def __init__( # pylint: disable=too-many-statements
name=name,
assets_folder=os.path.join(
flask.helpers.get_root_path(name), assets_folder
),
), # type: ignore
assets_url_path=assets_url_path,
assets_ignore=assets_ignore,
assets_external_path=get_combined_config(
Expand Down Expand Up @@ -546,7 +554,9 @@ def __init__( # pylint: disable=too-many-statements
if not self.logger.handlers and add_log_handler:
self.logger.addHandler(logging.StreamHandler(stream=sys.stdout))

if isinstance(plugins, patch_collections_abc("Iterable")):
if plugins is not None and isinstance(
plugins, patch_collections_abc("Iterable")
):
for plugin in plugins:
plugin.plug(self)

Expand Down Expand Up @@ -1961,7 +1971,7 @@ def run(
port="8050",
proxy=None,
debug=None,
jupyter_mode: JupyterDisplayMode = None,
jupyter_mode: Optional[JupyterDisplayMode] = None,
jupyter_width="100%",
jupyter_height=650,
jupyter_server_url=None,
Expand Down Expand Up @@ -2096,7 +2106,7 @@ def run(
port = int(port)
assert port in range(1, 65536)
except Exception as e:
e.args = [f"Expecting an integer from 1 to 65535, found port={repr(port)}"]
e.args = (f"Expecting an integer from 1 to 65535, found port={repr(port)}",)
raise

# so we only see the "Running on" message once with hot reloading
Expand Down
Loading