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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
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
10 changes: 4 additions & 6 deletions CHANGELOG.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,10 @@ to close the error messages box.
- [#1503](https://github.com/plotly/dash/pull/1506) Fix [#1466](https://github.com/plotly/dash/issues/1466): loosen `dash[testing]` requirements for easier integration in external projects. This PR also bumps many `dash[dev]` requirements.

### Fixed
- [#1530](https://github.com/plotly/dash/pull/1530) Dedent error messages more carefully.
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with the `assets_url_path` argument when determining the url to an external asset.
- [#1493](https://github.com/plotly/dash/pull/1493) Fix [#1143](https://github.com/plotly/dash/issues/1143), a bug where having a file with one of several common names (test.py, code.py, org.py, etc) that imports a dash component package would make `import dash` fail with a cryptic error message asking whether you have a file named "dash.py"

## [1.18.1] - 2020-12-09
Expand DownExpand Up@@ -695,9 +699,3 @@ app = dash.Dash(...)

## 0.17.3 - 2017-06-22
✨ This is the initial open-source release of Dash.

### Fixed
- [#1527](https://github.com/plotly/dash/issues/1527)🐛 `get_asset_url` now pulls from an external source if `assets_external_path` is set.
- updated `_add_assets_resource` to build asset urls the same way as `get_asset_url`.
- updated doc string for `assets_external_path` Dash argument to be more clear that it will allways be joined with
the `assets_url_path` argument when determining the url to an external asset.
15 changes: 10 additions & 5 deletions dash/_utils.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,8 +65,12 @@ def get_relative_path(requests_pathname, path):
return requests_pathname
elif not path.startswith("/"):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading / are not supported.\n"
+ "You supplied: {}".format(path)
"""
Paths that aren't prefixed with a leading / are not supported.
You supplied: {}
""".format(
path
)
)
return "/".join([requests_pathname.rstrip("/"), path.lstrip("/")])

Expand All@@ -78,9 +82,10 @@ def strip_relative_path(requests_pathname, path):
requests_pathname != "/" and not path.startswith(requests_pathname.rstrip("/"))
) or (requests_pathname == "/" and not path.startswith("/")):
raise exceptions.UnsupportedRelativePath(
"Paths that aren't prefixed with a leading "
+ "requests_pathname_prefix are not supported.\n"
+ "You supplied: {} and requests_pathname_prefix was {}".format(
"""
Paths that aren't prefixed with requests_pathname_prefix are not supported.
You supplied: {} and requests_pathname_prefix was {}
""".format(
path, requests_pathname
)
)
Expand Down
161 changes: 83 additions & 78 deletions dash/_validate.py
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import collections
import re
from textwrap import dedent

from .development.base_component import Component
from . import exceptions
Expand All@@ -15,26 +16,26 @@ def validate_callback(output, inputs, state, extra_args, types):
if extra_args:
if not isinstance(extra_args[0], (Output, Input, State)):
raise exceptions.IncorrectTypeException(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
""".format(
repr(extra_args[0])
)
dedent(
"""
Callback arguments must be `Output`, `Input`, or `State` objects,
optionally wrapped in a list or tuple. We found (possibly after
unwrapping a list or tuple):
{}
"""
).format(repr(extra_args[0]))
)

raise exceptions.IncorrectTypeException(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
""".format(
repr((outputs + inputs + state)[-1]), repr(extra_args[0])
)
dedent(
"""
In a callback definition, you must provide all Outputs first,
then all Inputs, then all States. After this item:
{}
we found this item next:
{}
"""
).format(repr((outputs + inputs + state)[-1]), repr(extra_args[0]))
)

for args in [outputs, inputs, state]:
Expand All@@ -45,11 +46,11 @@ def validate_callback(output, inputs, state, extra_args, types):
def validate_callback_arg(arg):
if not isinstance(getattr(arg, "component_property", None), _strings):
raise exceptions.IncorrectTypeException(
"""
component_property must be a string, found {!r}
""".format(
arg.component_property
)
dedent(
"""
component_property must be a string, found {!r}
"""
).format(arg.component_property)
)

if hasattr(arg, "component_event"):
Expand All@@ -68,11 +69,11 @@ def validate_callback_arg(arg):

else:
raise exceptions.IncorrectTypeException(
"""
component_id must be a string or dict, found {!r}
""".format(
arg.component_id
)
dedent(
"""
component_id must be a string or dict, found {!r}
"""
).format(arg.component_id)
)


Expand All@@ -85,12 +86,12 @@ def validate_id_dict(arg):
# cause unwanted collisions
if not isinstance(k, _strings):
raise exceptions.IncorrectTypeException(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
""".format(
k, arg_id
)
dedent(
"""
Wildcard ID keys must be non-empty strings,
found {!r} in id {!r}
"""
).format(k, arg_id)
)


Expand All@@ -113,13 +114,13 @@ def validate_id_string(arg):
def validate_multi_return(outputs_list, output_value, callback_id):
if not isinstance(output_value, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
""".format(
callback_id, repr(output_value)
)
dedent(
"""
The callback {} is a multi-output.
Expected the output type to be a list or tuple but got:
{}.
"""
).format(callback_id, repr(output_value))
)

if len(output_value) != len(outputs_list):
Expand All@@ -137,26 +138,26 @@ def validate_multi_return(outputs_list, output_value, callback_id):
vi = output_value[i]
if not isinstance(vi, (list, tuple)):
raise exceptions.InvalidCallbackReturnValue(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
""".format(
callback_id, i, repr(vi), repr(outi)
)
dedent(
"""
The callback {} output {} is a wildcard multi-output.
Expected the output type to be a list or tuple but got:
{}.
output spec: {}
"""
).format(callback_id, i, repr(vi), repr(outi))
)

if len(vi) != len(outi):
raise exceptions.InvalidCallbackReturnValue(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
""".format(
callback_id, i, len(vi), len(outi), repr(outi), repr(vi)
)
dedent(
"""
Invalid number of output values for {} item {}.
Expected {}, got {}
output spec: {}
output value: {}
"""
).format(callback_id, i, len(vi), len(outi), repr(outi), repr(vi))
)


Expand All@@ -170,34 +171,38 @@ def _raise_invalid(bad_val, outer_val, path, index=None, toplevel=False):
)
outer_type = type(outer_val).__name__
if toplevel:
location = """
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
location = dedent(
"""
The value in question is either the only value returned,
or is in the top level of the returned list,
"""
)
else:
index_string = "[*]" if index is None else "[{:d}]".format(index)
location = """
The value in question is located at
{} {} {}
{},
""".format(
index_string, outer_type, outer_id, path
)
location = dedent(
"""
The value in question is located at
{} {} {}
{},
"""
).format(index_string, outer_type, outer_id, path)

raise exceptions.InvalidCallbackReturnValue(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.
dedent(
"""
The callback for `{output}`
returned a {object:s} having type `{type}`
which is not JSON serializable.

{location}
and has string representation
`{bad_val}`
{location}
and has string representation
`{bad_val}`

In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
""".format(
In general, Dash properties can only be
dash components, strings, dictionaries, numbers, None,
or lists of those.
"""
).format(
output=repr(output),
object="tree with one value" if not toplevel else "value",
type=bad_type,
Expand Down
17 changes: 12 additions & 5 deletions dash/resources.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
if "async" in s:
if "dynamic" in s:
raise exceptions.ResourceException(
"Can't have both 'dynamic' and 'async'. "
"{}".format(json.dumps(filtered_resource))
"""
Can't have both 'dynamic' and 'async'.
{}
""".format(
json.dumps(filtered_resource)
)
)

# Async assigns a value dynamically to 'dynamic'
Expand DownExpand Up@@ -70,9 +74,12 @@ def _filter_resources(self, all_resources, dev_bundles=False):
continue
else:
raise exceptions.ResourceException(
"{} does not have a "
"relative_package_path, absolute_path, or an "
"external_url.".format(json.dumps(filtered_resource))
"""
{} does not have a relative_package_path, absolute_path,
or an external_url.
""".format(
json.dumps(filtered_resource)
)
)

filtered_resources.append(filtered_resource)
Expand Down