Activate the dev tools, called by `run`. If your application is served by wsgi and you want to activate the dev tools, you can call this method out of `__main__`. All parameters can be set by environment variables as listed. Values provided here take precedence over
( # pylint: disable=too-many-branches
self,
debug: Optional[bool] = None,
dev_tools_ui: Optional[bool] = None,
dev_tools_props_check: Optional[bool] = None,
dev_tools_serve_dev_bundles: Optional[bool] = None,
dev_tools_hot_reload: Optional[bool] = None,
dev_tools_hot_reload_interval: Optional[int] = None,
dev_tools_hot_reload_watch_interval: Optional[int] = None,
dev_tools_hot_reload_max_retry: Optional[int] = None,
dev_tools_silence_routes_logging: Optional[bool] = None,
dev_tools_disable_version_check: Optional[bool] = None,
dev_tools_prune_errors: Optional[bool] = None,
dev_tools_validate_callbacks: Optional[bool] = None,
first_run: bool = True,
)
| 1993 | return dev_tools |
| 1994 | |
| 1995 | def enable_dev_tools( # pylint: disable=too-many-branches |
| 1996 | self, |
| 1997 | debug: Optional[bool] = None, |
| 1998 | dev_tools_ui: Optional[bool] = None, |
| 1999 | dev_tools_props_check: Optional[bool] = None, |
| 2000 | dev_tools_serve_dev_bundles: Optional[bool] = None, |
| 2001 | dev_tools_hot_reload: Optional[bool] = None, |
| 2002 | dev_tools_hot_reload_interval: Optional[int] = None, |
| 2003 | dev_tools_hot_reload_watch_interval: Optional[int] = None, |
| 2004 | dev_tools_hot_reload_max_retry: Optional[int] = None, |
| 2005 | dev_tools_silence_routes_logging: Optional[bool] = None, |
| 2006 | dev_tools_disable_version_check: Optional[bool] = None, |
| 2007 | dev_tools_prune_errors: Optional[bool] = None, |
| 2008 | dev_tools_validate_callbacks: Optional[bool] = None, |
| 2009 | first_run: bool = True, |
| 2010 | ) -> bool: |
| 2011 | """Activate the dev tools, called by `run`. If your application |
| 2012 | is served by wsgi and you want to activate the dev tools, you can call |
| 2013 | this method out of `__main__`. |
| 2014 | |
| 2015 | All parameters can be set by environment variables as listed. |
| 2016 | Values provided here take precedence over environment variables. |
| 2017 | |
| 2018 | Available dev_tools environment variables: |
| 2019 | |
| 2020 | - DASH_DEBUG |
| 2021 | - DASH_UI |
| 2022 | - DASH_PROPS_CHECK |
| 2023 | - DASH_SERVE_DEV_BUNDLES |
| 2024 | - DASH_HOT_RELOAD |
| 2025 | - DASH_HOT_RELOAD_INTERVAL |
| 2026 | - DASH_HOT_RELOAD_WATCH_INTERVAL |
| 2027 | - DASH_HOT_RELOAD_MAX_RETRY |
| 2028 | - DASH_SILENCE_ROUTES_LOGGING |
| 2029 | - DASH_DISABLE_VERSION_CHECK |
| 2030 | - DASH_PRUNE_ERRORS |
| 2031 | - DASH_VALIDATE_CALLBACKS |
| 2032 | |
| 2033 | :param debug: Enable/disable all the dev tools unless overridden by the |
| 2034 | arguments or environment variables. Default is ``True`` when |
| 2035 | ``enable_dev_tools`` is called directly, and ``False`` when called |
| 2036 | via ``run``. env: ``DASH_DEBUG`` |
| 2037 | :type debug: bool |
| 2038 | |
| 2039 | :param dev_tools_ui: Show the dev tools UI. env: ``DASH_UI`` |
| 2040 | :type dev_tools_ui: bool |
| 2041 | |
| 2042 | :param dev_tools_props_check: Validate the types and values of Dash |
| 2043 | component props. env: ``DASH_PROPS_CHECK`` |
| 2044 | :type dev_tools_props_check: bool |
| 2045 | |
| 2046 | :param dev_tools_serve_dev_bundles: Serve the dev bundles. Production |
| 2047 | bundles do not necessarily include all the dev tools code. |
| 2048 | env: ``DASH_SERVE_DEV_BUNDLES`` |
| 2049 | :type dev_tools_serve_dev_bundles: bool |
| 2050 | |
| 2051 | :param dev_tools_hot_reload: Activate hot reloading when app, assets, |
| 2052 | and component files change. env: ``DASH_HOT_RELOAD`` |