All notable changes to dash
will be documented in this file.
This project adheres to Semantic Versioning.
- #1343 Add
title
parameter to set the document title. This is the recommended alternative to setting app.title or overriding the index HTML. - #1315 Add
update_title
parameter to set or disable the "Updating...." document title during updates. Closes #856 and #732
- #1310 Fix a regression since 1.13.0 preventing more than one loading state from being shown at a time.
- #1305
- Fix regression that causes crash when
FLASK_ENV
is modified during app execution - Fix regression that caused tests using
_wait_for_callbacks
to fail
- Fix regression that causes crash when
- #1289 Supports
DASH_PROXY
env var to tellapp.run_server
to report the correct URL to view your app, when it's being proxied. Throws an error if the proxy is incompatible with the host and port you've given the server. - #1240 Adds
callback_context
to clientside callbacks (e.g.dash_clientside.callback_context.triggered
). Supportstriggered
,inputs
,inputs_list
,states
, andstates_list
, all of which closely resemble their serverside cousins.
- #1237 Closes #920: Converts hot reload fetch failures into a server status indicator showing whether the latest fetch succeeded or failed. Callback fetch failures still appear as errors but have a clearer message.
- #1254 Modifies the callback chain implementation and improves performance for apps with a lot of components
- #1255 Hard hot reload targets only the current window, not the top - so if your app is in an iframe you will only reload the app
- #1249 Fixes #919 so
dash.testing
is compatible with morepytest
plugins, particularlypytest-flake8
andpytest-black
. - #1248 Fixes #1245, so you can use prop persistence with components that have dict IDs, ie for pattern-matching callbacks.
- #1185 Sort asset directories, same as we sort files inside those directories. This way if you need your assets loaded in a certain order, you can add prefixes to subdirectory names and enforce that order.
- #1288 Closes #1285: Debug=True should work in the main module.
- #1228 Adds control over firing callbacks on page (or layout chunk) load. Individual callbacks can have their initial calls disabled in their definition
@app.callback(..., prevent_initial_call=True)
and similar forapp.clientside_callback
. The app-wide default can also be changed withapp=Dash(prevent_initial_callbacks=True)
, then individual callbacks may disable this behavior. - #1201 New attribute
app.validation_layout
allows you to create a multi-page app withoutsuppress_callback_exceptions=True
or layout function tricks. Set this to a component layout containing the superset of all IDs on all pages in your app. - #1078 Permit usage of arbitrary file extensions for assets within component libraries
- #1224 Fixes #1223, a very specific situation in which initial callbacks will not fire.
- #1220 Fixes #1216, a set of related issues about pattern-matching callbacks with
ALL
wildcards in theirOutput
which would fail if no components matched the pattern. - #1212 Fixes #1200 - prior to Dash 1.11, if none of the inputs to a callback were on the page, it was not an error. This was, and is now again, treated as though the callback raised PreventUpdate. The one exception to this is with pattern-matching callbacks, when every Input uses a multi-value wildcard (ALL or ALLSMALLER), and every Output is on the page. In that case the callback fires as usual.
- #1201 Fixes #1193 - prior to Dash 1.11, you could use
flask.has_request_context() == False
inside anapp.layout
function to provide a special layout containing all IDs for validation purposes in a multi-page app. Dash 1.11 broke this when we moved most of this validation into the renderer. This change makes it work again.
- #1103 Pattern-matching IDs and callbacks. Component IDs can be dictionaries, and callbacks can reference patterns of components, using three different wildcards:
ALL
,MATCH
, andALLSMALLER
, available fromdash.dependencies
. This lets you create components on demand, and have callbacks respond to any and all of them. To help with this,dash.callback_context
gets three new entries:outputs_list
,inputs_list
, andstates_list
, which contain all the ids, properties, and except for the outputs, the property values from all matched components. - #1103
dash.testing
option--pause
: after opening the dash app in a test, will invokepdb
for live debugging of both Javascript and Python. Use with a single test case likepytest -k cbwc001 --pause
.
- #1103 Multiple changes to the callback pipeline:
dash.callback_context.triggered
now does NOT reflect any initial values, and DOES reflect EVERY value which has been changed either by activity in the app or as a result of a previous callback. That means that the initial call of a callback with no prerequisite callbacks will list nothing as triggering. For backward compatibility, we continue to provide a length-1 list fortriggered
, but itsid
andproperty
are blank strings, andbool(triggered)
isFalse
.- A user interaction which returns the same property value as was previously present will not trigger the component to re-render, nor trigger callbacks using that property as an input.
- Callback validation is now mostly done in the browser, rather than in Python. A few things - mostly type validation, like ensuring IDs are strings or dicts and properties are strings - are still done in Python, but most others, like ensuring outputs are unique, inputs and outputs don't overlap, and (if desired) that IDs are present in the layout, are done in the browser. This means you can define callbacks BEFORE the layout and still validate IDs to the layout; and while developing an app, most errors in callback definitions will not halt the app.
- #1103 Fixed multiple bugs with chained callbacks either not triggering, inconsistently triggering, or triggering multiple times. This includes: #635, #832, #1053, #1071, and #1084. Also fixed #1105: async components that aren't rendered by the page (for example in a background Tab) would block the app from executing callbacks.
- #1134 Allow
dash.run_server()
host and port parameters to be set with environment variables HOST & PORT, respectively
- #1145 Update from React 16.8.6 to 16.13.0
- #1142 Persistence: Also persist 0, empty string etc
- #1133 Allow the
compress
config variable to be set with an environment variable with DASH_COMPRESS=FALSE
- #1080 Handle case where dash fails to load when used inside an iframe with a sandbox attribute that only has allow-scripts
- #1073 Two new functions to simplify usage handling URLs and pathnames:
app.get_relative_path
&app.trim_relative_path
. These functions are particularly useful for apps deployed on Dash Enterprise where the apps served under a URL prefix (the app name) which is unlike apps served on localhost:8050.app.get_relative_path
returns a path with the config settingrequests_pathname_prefix
prefixed. Useapp.get_relative_path
anywhere you would provide a relative pathname, likedcc.Link(href=app.relative_path('/page-2'))
or even as an alternative toapp.get_asset_url
with e.g.html.Img(src=app.get_relative_path('/assets/logo.png'))
.app.trim_relative_path
a path withrequests_pathname_prefix
and leading & trailing slashes stripped from it. Use this function in callbacks that deal withdcc.Location
pathname
routing. Example usage:
app.layout = html.Div([ dcc.Location(id='url'), html.Div(id='content') ]) @app.callback(Output('content', 'children'), [Input('url', 'pathname')]) def display_content(path): page_name = app.strip_relative_path(path) if not page_name: # None or '' return html.Div([ html.Img(src=app.get_relative_path('/assets/logo.png')), dcc.Link(href=app.get_relative_path('/page-1')), dcc.Link(href=app.get_relative_path('/page-2')), ]) elif page_name == 'page-1': return chapters.page_1 if page_name == "page-2": return chapters.page_2
- #1035 Simplify our build process.
- #1074 Error messages when providing an incorrect property to a component have been improved: they now specify the component type, library, version, and ID (if available).
- #1037 Fix no_update test to allow copies, such as those stored and retrieved from a cache.
- #967 Add support for defining clientside JavaScript callbacks via inline strings.
- #1020 Allow
visit_and_snapshot
API indash.testing.browser
to stay on the page so you can run other checks.
- #1026 Better error message when you forget to wrap multiple
children
in an array, and they get passed to other props.
- #1018 Fix the
dash.testing
stop API with process application runner in Python2. Usekill()
instead ofcommunicate()
to avoid hanging. - #1027 Fix bug with renderer callback lock never resolving with non-rendered async component using the asyncDecorator
- #1006 Fix IE11 / ES5 compatibility and validation issues
- #1006 Fix bug with renderer wrapper component TreeContainer to prevent useless re-renders
- #1001
- Fix and improve the
clear_input()
API indash.testing
, so it's more robust handling reactinput
. - make the
percy_snapshot()
API more robust, and the timeout ofwait_for_callbacks
(if set to True) will not fail the snapshot execution, but logged as potential error.
- Fix and improve the
- #999 Fix fingerprint for component suites with
metadata
in version. - #983 Fix the assets loading issues when dashR application runner is handling with an app defined by string chunk.
- #987 Fix cache string handling for component suites with nested folders in their packages.
- #986 Fix a bug with evaluation of
_force_eager_loading
when application is loaded with gunicorn
- #964 Adds support for preventing updates in clientside functions.
- Reject all updates with
throw window.dash_clientside.PreventUpdate;
- Reject a single output by returning
window.dash_clientside.no_update
- Reject all updates with
- #899 Add support for async dependencies and components
- #973 Adds support for resource caching and adds a fallback caching mechanism through etag
- #974 Fix and improve a percy snapshot behavior issue we found in dash-docs testing. It adds a flag
wait_for_callbacks
to ensure that, in the context of a dash app testing, the percy snapshot action will happen only after all callbacks get fired.
- #969 Fix warnings emitted by react devtools coming from our own devtools components.
- #948 Support setting working directory for R apps run using the
dashr
fixture, primarily useful for tests with assets.dashr.start_server
supports acwd
argument to set an explicit working directory, and has smarter defaults when it's omitted: ifapp
is a path to an R script, uses the directory of that path; ifapp
is a string, uses the directory the test file itself is in. - #944
- Relevant
dash.testing
methods can now be called with either an element or a CSS selector:select_dcc_dropdown
,multiple_click
,clear_input
,zoom_in_graph_by_ratio
,click_at_coord_fractions
. - Three new
dash.testing
methods:clear_local_storage
,clear_session_storage
, andclear_storage
(to clear both together)
- Relevant
- #937
dash.testing
adds two APIszoom_in_graph_by_ratio
andclick_at_coord_fractions
about advanced interactions using mouseActionChain
- #938 Add debugging traces to dash backend about serving component suites, to verify the installed packages whenever in doubt.
- #944 Fix a bug with persistence being toggled on/off on an existing component.
- Bump dash-core-components version from 1.2.0 to 1.2.1
-
#923 Add one configuration
--percy-assets
inpytest
to specify extra application assets path if needed. -
#918 Add
wait_for_element_by_id
andvisit_and_snapshot
APIs in browser, addraw_command
option (with higher priority than the default waitress one) and optionalstart_timeout
argument to handle large applications within the process runner. -
#903 Persistence: enable props edited by the user to persist across recreating the component or reloading the page. Components need to define three new props:
persistence
,persisted_props
, andpersistence_type
as described in the lead comment ofsrc/persistence.js
. App developers then enable this behavior by, in the simplest case, settingpersistence: true
on the component. First use case is table, see dash-table#566
- Bump dash-table version from 4.2.0 to 4.3.0
- Bump dash-core-components version from 1.1.2 to 1.2.0
- Bump dash-renderer version from 1.0.1 to 1.1.0
- #915 Fix
dash-generate-components
on Windows. - #829 Fix the
--remote
pytest argument which was not effective in the code, adding a new argument--remote-url
to support the selenium grid usage in the cloud. - #910 Reduce the dash-renderer packages size on PyPI about 55% by removing the source maps. To do more advanced debugging, the source maps needs to be generated from source code with
npm run build:local
and pip install in editable mode, i.e.pip install -e .
- #860 Add a new arg
dev_tools_prune_errors
toapp.run_server
andapp.enable_dev_tools
. DefaultTrue
, tracebacks only include user code and below. Set itFalse
for the previous behavior showing all the Dash and Flask parts of the stack.
- Bump dash-table version from 4.1.0 to 4.2.0
- Bump dash-core-components version from 1.1.1 to 1.1.2
- Bump dash-html-components version from 1.0.0 to 1.0.1
- Bump dash-renderer version from 1.0.0 to 1.0.1
- #874 Clean all the binary assets in dash-renderer, add tool to build all the required bundles from fresh source code to avoid confusion of the assets and improve the release process. Fixes #868 and #734
- Bump dash-core-components version from 1.1.0 to 1.1.1
- #827 Add support for dashR testing to the
dash.testing
pytest framework.
- Bump dash-table version from 4.0.1 to 4.0.2
-
💥 #808 Remove strong
dash.testing
dependencies per community feedback. Testing users should dopip install dash[testing]
afterwards. -
#805 Add headless mode for dash.testing, add
pytest_setup_options
hook for full configuration ofWebDriver Options
. -
Bump dash-table version from 4.0.0 to 4.0.1
-
💥 #761 Several breaking changes to the
dash.Dash
API:- Remove two obsolete constructor kwargs:
static_folder
andcomponents_cache_max_age
- Remove the misspelled
supress_callback_exceptions
fallback - Remove the unused
resources.config.infer_from_layout
- Revamp
app.config
: ALL constructor args are now stored inconfig
, with three exceptions:server
,index_string
, andplugins
. None of these are stored in any other instance attributes anymore. - Change
hot_reload_interval
from msec to seconds, for consistency withhot_reload_watch_interval
- When called from
enable_dev_tools
,debug=True
by default. It's stillFalse
by default fromrun_server
.
- Remove two obsolete constructor kwargs:
-
✨ #744 Introducing Dash Testing (
dash.testing
) - read the full tutorial at https://dash.plotly.com/testing. -
#753
Component
no longer inheritsMutableMapping
, sovalues
,keys
, and more are no longer methods. Fixes an issue reported in dcc#440 where components with certain prop names defined but not provided would cause a failure to render. During component generation we now disallow all props with leading underscores or matching a few remaining reserved words:UNDEFINED
,REQUIRED
,to_plotly_json
,available_properties
, andavailable_wildcard_properties
. -
#739 Allow the Flask app to be provided to Dash after object initialization. This allows users to define Dash layouts etc when using the app factory pattern, or any other pattern that inhibits access to the app object. This broadly complies with the flask extension API, allowing Dash to be considered as a Flask extension where it needs to be.
-
#774 Allow the Flask app to set the Dash app name if the name is not provided by users.
-
#722 Assets are served locally by default. Both JS scripts and CSS files are affected. This improves robustness and flexibility in numerous situations, but in certain cases initial loading could be slowed. To restore the previous CDN serving, set
app.scripts.config.serve_locally = False
(and similarly withapp.css
, but this is generally less important). -
#724, renderer#175 Undo/redo toolbar is removed by default, you can enable it with
app=Dash(show_undo_redo=true)
. The CSS hack._dash-undo-redo:{display:none;}
is no longer needed -
💥#709 Merge the
dash-renderer
project into the main dash repo to simplify feature dev workflow. We will keep the deprecated one for archive purpose.
- Bump dash-core-components version from 0.47.0 to 0.48.0
- Bump dash-renderer version from 0.23.0 to 0.24.0
- Bump dash-table version from 3.6.0 to 3.7.0
- renderer#170 Fix regression on handling PreventUpdate (204 NO CONTENT)
- #687, renderer#100 Dev Tools support. A new UI in the application that automatically display JavaScript & Python error messages, validates your component's properties, and displays a graph of your callback's dependencies. Only enabled in debug mode. Turn this on and off with two new config flags in
app.run_server
:dev_tools_props_check
- turn on/off property validation.dev_tools_ui
- turn on/off the UI.
- renderer#148 Fix regression for
children=0
case.
- #672, renderer#143 Support for "Clientside Callbacks" - an escape hatch to execute your callbacks in JavaScript instead of Python
- #676 Add
dev_tools_ui
config flag inapp.run_server
(serialized in<script id="_dash-config" type="application/json">
) to display or hide the forthcoming Dev Tools UI in Dash's front-end (dash-renderer). - #680 Partial updates: leave some multi-output updates unchanged while updating others
- renderer#145 Remove
dash_renderer._set_react_version
support for 15.4.2 and 16.2.0
- Bump dash-core-components version from 0.45.0 to 0.46.0
- renderer#145 Update from React 15.4.2 to React 16.8.6
- Bump dash-core-components version from 0.44.0 to 0.45.0
- Bump dash-html-components version from 0.14.0 to 0.15.0
- renderer#140, renderer#126 Optimize rendering, and always assign
setProps
to components even with no callbacks to use it.
- #436 Allow multiple outputs from a single callback.
- #367 Support custom JavaScript hooks to modify callback payloads and responses.
- #623 Modify the flask response with custom cookies or headers, using
dash.callback_context.response
. - renderer#93 Loading states API
- Bump dash-core-components version from 0.43.1 to 0.44.0
- Bump dash-html-components version from 0.13.5 to 0.14.0
- Bump dash-table version from 3.5.0 to 3.6.0
- #603 Add components libraries js/css distribution to hot reload watch.
- #608, renderer#124 Callback context:
- Know which inputs caused a callback to fire:
dash.callback_context.triggered
- Input/State values by name
dash.callback_context.states.get('btn.n_clicks')
- Know which inputs caused a callback to fire:
- Fix missing indentation for generated metadata.json #600
- Fix missing component prop docstring error #598
- #492 Move
__repr__
to base component instead of being generated. - #605 Raise exception when same input & output are used in a callback
- renderer#118 Removed redux logger for the dev.
- #565 Add core libraries as version locked dependencies
- Bump dash-table version from 3.3.0 to 3.4.0
- Bump dash-renderer version from 0.17.0 to 0.18.0
- Bump dash-core-components version from 0.43.0 to 0.43.1
- #563 Fix collections.abc deprecation warning for Python 3.8
- #550, renderer#114 Remove support for
Event
system. Use event properties instead, for example then_clicks
property instead of theclick
event, see #531.dash_renderer
MUST be upgraded to >=0.17.0 together with this, and it is recommended to updatedash_core_components
to >=0.43.0 anddash_html_components
to >=0.14.0.
- #547
assets_folder
argument now defaults to 'assets'- The assets folder is now always relative to the given root path of
name
argument, the default of__main__
will get thecwd
. - No longer coerce the name argument from the server if the server argument is provided.
- #547
- Asset blueprint takes routes prefix into it's static path.
- Asset url path no longer strip routes from requests.
- #548 Remove print statement from PreventUpdate error handler.
- #524 Removed ComponentRegistry dist cache.
- #522 Fix typo in some exception names
- renderer#110
- Keep the config store state on soft reload.
- AppProvider returns
Loading...
if no configs as before renderer#108.
- #518 Always skip
dynamic
resources from index resources collection.
- #483 Experimental
--r-prefix
option todash-generate-components
, optionally generates R version of components and corresponding R package.
- #490 Add
--ignore
option todash-generate-components
, defaults to^_
.
- renderer#108 Unused login api and Authentication component
- Add
key
to rendered components, fixing renderer#379
- #487 Add specific Dash exception types to replace generic exceptions (
InvalidIndexException
,DependencyException
,ResourceException
)
- #485 Fix typo in missing events/inputs error message
- #484 Mute dash related missing props docstring from extract-meta warnings
- #478, renderer#104 Support for .map file extension and dynamic (on demand) loading
- renderer#107 Redux devtools support
- #473 Fix
_imports_.py
indentation generation.
- #451 Combine
extract-meta
and Python component files generation in a cli
- Fix a bug renderer#66 in the ON_PROP_CHANGE callback where history was not correctly set when acting on more than one component. In particular, the 'undo' button should now work as expected.
- #362, renderer#73 Hot reloading from the browser.
- Silence routes logging with
dev_tools_silence_routes_logging
.
- #444 Add component namespaces registry, collect the resources needed by component library when they are imported instead of crawling the layout.
- #450 Use the same prop name black list for component generation in all supported Python versions. Closes #361.
- #443
Dash.registered_paths
changed to acollections.defaultdict(set)
, was appending the same package paths on every index.
- #431 Replace windows endline when generating components class docstrings.
- #430 Fix
Component.traverse()
andComponent.traverse_with_paths()
for components withchildren
of typetuple
, not justlist
.
- #418 Fix http-equiv typo
- Include missing polyfills to restore Internet Explorer support, restore whatwg-fetch renderer#87
- #377 Move
add_url
function definition out ofDash.__init__
- #407 Missing favicon package_data from setup.py
- #406 Default favicon for dash apps.
- Bust the cache of the assets favicon.
- #403 Remove the first and last blank lines from the HTML index string.
- #369, renderer#77 Allow serving dev bundles from the components suite, enable with
app.run_server(dev_tools_serve_dev_bundles=True)
- #350 Use HTML5 syntax for the meta tag
- #387 Add
Cache-Control
headers to files served byDash.serve_component_suites
, and time modified query string to collected components suites resources. - #394 Add
InvalidResourceError
error and a Flask error handler so unregistered paths inserve_component_suites
return a 404 instead of 500.
- #374 Fix
get_asset_url
with a differentassets_url_path
.
- Set
url_base_pathname
toNone
inDash.__init__
. Fix #364
Dash.get_asset_url
will give the prefixed url for the asset file.
- #351 Prefix assets files with
requests_pathname_prefix
.
- #343 Only create the assets blueprint once for apps that provide the same flask instance to multiple dash instances.
- #336 Fix bug in
_validate_layout
which would not let a user setapp.layout
to be a function that returns a layout (fixes #334).
- #318 Add
assets_ignore
init keyword, regex filter for the assets files.
- #335 Ensure CSS/JS external resources are loaded before the assets.
- #322 Take config values from init or environ variables (Prefixed with
DASH_
).
- Take
requests_pathname_prefix
config when creating scripts tags. requests/routes_pathname_prefix
must start and end with/
.requests_pathname_prefix
must end withroutes_pathname_prefix
. If you supplied bothrequests
androutes
pathname before this update, make surerequests_pathname_prefix
ends with the same value asroutes_pathname_prefix
.url_base_pathname
sets bothrequests/routes
pathname, cannot supply it with eitherrequests
orroutes
pathname prefixes.
- #320 Disallow duplicate component ids in the initial layout.
- Fix bug #321 where importing Dash components with no props would result in an error.
- Fix a bug in 0.23.1 where importing components with arguments that are Python keywords could cause an error. In particular, this fixes
dash-html-components
with Python 3.7.
- #319 Add a modified time query string to assets included in the index in order to bust the cache.
- #316 Add
ie-compat
meta tag to the index by default. - #305 Add
external_script
andexternal_css
keywords to dash__init__
. - Dash components are now generated at build-time and then imported rather than generated when a module is imported. This should reduce the time it takes to import Dash component libraries, and makes Dash compatible with IDEs.
- #273 Raise a more informative error if a non-JSON-serializable value is returned from a callback.
- #286 Asset files & index customization.
- #294 Raise an error if there is no layout present when the server is run.
- renderer#55 Add
_dash-error
class to the "Error loading layout" and "Error loading dependencies" messages.
- Attempting to render a
Boolean
value to the page no longer crashes the app. - renderer#57 If a callback references an
id
which does not exist in the DOM tree at the time it is executed, throw a more informative front-end exception. - renderer#54 Previously, if a component called
updateProps
with multiple properties, Dash would fire the callback multiple times (once for each property). Now the callback only fires once.
- #237 Support
aria-*
anddata-*
attributes in all dash html components. These new keywords can be added using a dictionary expansion, e.g.html.Div(id="my-div", **{"data-toggle": "toggled", "aria-toggled": "true"})
- renderer#45 Allow user to choose between React versions '15.4.2' and '16.2.0':
import dash_renderer
# Set the react version before setting up the Dash application
dash_renderer._set_react_version('16.2.0')
app = dash.Dash(...)
- renderer#50 Update MANIFEST.in to include
react
andreact-dom
bundles for development mode
- #207 Support React components using Flow types.
component_loader
now has the following behavior to create docstrings as determined in discussion in #187:- If a Dash component has
PropTypes
-generated typing, the docstring uses thePropTypes
, regardless of whether the component also has Flow types (current behavior). - Otherwise if a Dash component has Flow types but not
PropTypes
, the docstring now uses the objects generated byreact-docgen
from the Flow types.
- If a Dash component has
- renderer#42 Fix renderer#41 and renderer#44.
- In some cases, during initialization, callbacks may fired multiple times instead of just once. This only happens in certain scenarios where outputs have overlapping inputs and those inputs are leaves (they don't have any inputs of their own).
- If an output component is returned from a callback and its inputs were not returned from the same input (i.e. they were already visible), then the callback to update the output would not fire. This has now been fixed. A common scenario where this app structure exists is within a Tabbed app, where there are global controls that update each tab's contents and the tab's callback just displays new output containers.
- #190
exceptions.PreventUpdate
can be raised inside a callback to prevent the callback from updating the app. See https://community.plotly.com/t/improving-handling-of-aborted-callbacks/7536/2.
- Removes logging from redux middleware from production build based on process.env.NODE_ENV.
- Many pylint style fixes: #163, #164, #165, #166, #167, #168, #169, #172, #173, #181, #185, #186, #193
- #184 New integration test framework.
- #174 Submodules are now imported into the
dash
namespace for better IDE completion.
- 🔒 Remove CSRF protection measures. CSRF-style attacks are not relevant to Dash apps. Dash's API uses
POST
requests with content typeapplication/json
which are not susceptible to unwanted requests from 3rd party sites. See #141. - 🔒
app.server.secret_key
is no longer required since CSRF protection was removed. Settingapp.server.secret_key
was difficult to document and a very common source of confusion, so it's great that users won't get bitten by this anymore 🎉 - 🐞 renderer#22, renderer#28 Previously, old requests could override new requests if their response was longer than the new one. This caused subtle bugs when apps are deployed on multiple processes or threads with component callbacks that update at varying rates like urls. Originally reported in #133. This fix should also improve performance when many updates happen at once as outdated requests will get dropped instead of updating the UI. Performance issue with the first PR reported in renderer#27 and fixed in the second PR.
- renderer#21 Fix an issue where a callback would be fired excessively. Previously, the callback would be called as many times as it had inputs. Now, it is called less.
app.config
is now adict
instead of a class. You can set config variables withapp.config['suppress_callback_exceptions'] = True
now. The previous class-based syntax (e.g.app.config.suppress_callback_exceptions
) has been maintained for backwards compatibility.- 🐌 Experimental behaviour for a customizable "loading state". When a callback is in motion, Dash now appends a
<div class="_dash-loading-callback"/>
to the DOM. Users can style this element using custom CSS to display loading screen overlays. This feature is in alpha, we may remove it at any time.
- Fix a bug from 0.18.2 that removed the ability for dash to serve the app on any route besides
/
. - Fix a bug from 0.18.0 with the new config variables when used in a multi-app setting, causing config to be shared across apps. Originally reported in https://community.plotly.com/t/flask-endpoint-error/5691/7
- Rename config setting
supress_callback_exceptions
tosuppress_callback_exceptions
. The original spelling is kept for backward compatibility. - 🐞 (renderer) Fix a bug where Dash would fire updates for each parent of a grandchild node that shared the same grandparent. Originally reported in https://community.plotly.com/t/specifying-dependency-tree-traversal/5080/5
- 🐞 (renderer) Fix a bug where the document title that displays "Updating..." wouldn't change if the callback raised an Exception. Now it will be removed on any response, even a failure.
- #70 🔧 Add an
endpoint
to each of the URLs to allow for multiple routes.
- #128 🐛 If
app.layout
is a function, then it used to be called excessively. Now it is called just once on startup and just once on page load.
- 🔒 Remove the
/static/
folder and endpoint that is implicitly initialized by flask. This is too implicit for my comfort level: I worry that users will not be aware that their files in theirstatic
folder are accessible - ⚡️ Remove all API calls to the Plotly API (https://api.plotly.com/), the authentication endpoints and decorators, and the associated
filename
,sharing
andapp_url
arguments. This was never documented or officially supported. Authentication has been moved to thedash-auth
package. - #107 ✏️ Sort prop names in exception messages.
- 🔧 Add two new
config
variables:routes_pathname_prefix
andrequests_pathname_prefix
to provide more flexibility for API routing when Dash apps are run behind proxy servers.routes_pathname_prefix
is a prefix applied to the backend routes andrequests_pathname_prefix
prefixed in requests made by Dash's front-end.dash-renderer==0.8.0rc3
uses these endpoints. - #112 🔧 Add
id
toKeyError
exceptions in components.
- ✏️ Fix a typo in an exception.
- 🔧 Replaced all illegal characters in environment variables.
- 📝 Update README.md
- ✅ Fix CircleCI tests. Note that the
dash-renderer
contains the bulk of the integration tests. - 💄 Flake8 fixes and tests (fixes #99)
- ✨ Add this CHANGELOG.md.
✨ This is the initial open-source release of Dash.