Datalore/Colab: add support for env var 'LETS_PLOT_HTML_ISOLATED_FRAME' (bool)

Author: alshan

python-package/lets_plot/_global_settings.py

@@ -2,16 +2,36 @@
 # Copyright (c) 2019. JetBrains s.r.o.
 # Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 #
+import os
 from typing import Dict, Any
 
 from ._version import __version__
 
+# Public environment variables
+ENV_HTML_ISOLATED_FRAME = 'LETS_PLOT_HTML_ISOLATED_FRAME'  # bool
+ENV_DEV_HTML_ISOLATED_FRAME = 'LETS_PLOT_DEV_HTML_ISOLATED_FRAME'  # bool
+ENV_OFFLINE = 'LETS_PLOT_OFFLINE'  # bool
+ENV_DEV_OFFLINE = 'LETS_PLOT_DEV_OFFLINE'  # bool
+
+HTML_ISOLATED_FRAME = 'html_isolated_frame'
+
+
+def _init_value(actual_name: str, def_val: Any) -> Any:
+    env_val = _get_env_val(actual_name)
+    return env_val if env_val else def_val
+
+
+def _get_env_val(actual_name: str) -> Any:
+    env_name = "LETS_PLOT_{}".format(actual_name.upper())
+    return os.environ.get(env_name)
+
+
 _settings = {
-    'offline': False,  # default: download from CDN
+    'offline': _init_value('offline', False),  # default: download from CDN
     'js_base_url': 'https://dl.bintray.com/jetbrains/lets-plot',
     'js_name': '',  # default: lets-plot-<version>.min.js
 
-    'dev_offline': True,  # default: embed js into the notebook
+    'dev_offline': _init_value('dev_offline', True),  # default: embed js into the notebook
     'dev_js_base_url': "http://0.0.0.0:8080",
     'dev_js_name': ''  # default: lets-plot-<version>.js
 }
@@ -23,44 +43,58 @@ def apply(cls, settings: Dict):
         _settings.update(settings)
 
 
-def _is_production() -> bool:
+def _to_actual_name(name: str) -> str:
+    if name.startswith("dev_"):
+        return name
+
+    return name if is_production() else 'dev_' + name
+
+
+def _get_global_val_intern(actual_name: str) -> Any:
+    # `settings` dict has precedence over environment variables.
+    env_val = _get_env_val(actual_name)
+    return _settings.get(actual_name, env_val)
+
+
+def is_production() -> bool:
     return 'dev' not in __version__
 
 
-def _has_global_value(name: str) -> bool:
-    actual_name = name if _is_production() else 'dev_' + name
-    val = _settings[actual_name]
+def has_global_value(name: str) -> bool:
+    val = _get_global_val_intern(_to_actual_name(name))
+
     if isinstance(val, bool):
         return True
     if isinstance(val, str) and not val.strip():
         return False
     return val
 
 
-def _to_actual_name(name: str) -> str:
-    if name.startswith("dev_"):
-        return name
-
-    return name if _is_production() else 'dev_' + name
+def get_global_val(name: str) -> Any:
+    if not has_global_value(name):
+        raise ValueError("Not defined '{}'".format(_to_actual_name(name)))
 
+    return _get_global_val_intern(_to_actual_name(name))
 
-def _get_global_val(name: str) -> Any:
-    actual_name = _to_actual_name(name)
-    if not _has_global_value(name):
-        raise ValueError("Not defined '{}'".format(actual_name))
 
-    return _settings[actual_name]
-
-
-def _get_global_str(name: str) -> str:
-    val = _get_global_val(name)
+def get_global_str(name: str) -> str:
+    val = get_global_val(name)
     if not isinstance(val, str):
         raise ValueError("Not string value: ['{}'] : {}".format(_to_actual_name(name), type(val)))
     return val
 
 
-def _get_global_bool(name: str) -> bool:
-    val = _get_global_val(name)
-    if not isinstance(val, bool):
-        raise ValueError("Not boolean value: ['{}'] : {}".format(_to_actual_name(name), type(val)))
-    return val
+def get_global_bool(name: str) -> bool:
+    val = get_global_val(name)
+    if isinstance(val, bool):
+        return val
+
+    if isinstance(val, str):
+        if val.lower() in ['true', '1', 't', 'y', 'yes']:
+            return True
+        elif val.lower() in ['false', '0', 'f', 'n', 'no']:
+            return False
+        else:
+            raise ValueError("Can't convert str to boolean : ['{}'] : {}".format(_to_actual_name(name), val))
+
+    raise ValueError("Not boolean value: ['{}'] : {}".format(_to_actual_name(name), type(val)))

python-package/lets_plot/export/simple.py

@@ -6,7 +6,7 @@
 from typing import Union
 
 from .. import _kbridge as kbr
-from .._global_settings import _is_production
+from .._global_settings import is_production
 from .._version import __version__
 from ..plot.core import PlotSpec
 from ..plot.plot import GGBunch
@@ -57,7 +57,7 @@ def export_html(plot: Union[PlotSpec, GGBunch], filename: str, iframe: bool = Fa
     if not (isinstance(plot, PlotSpec) or isinstance(plot, GGBunch)):
         raise ValueError("PlotSpec or GGBunch expected but was: {}".format(type(plot)))
 
-    version = __version__ if _is_production() else "latest"
+    version = __version__ if is_production() else "latest"
     html_page = kbr._generate_static_html_page(plot.as_dict(), version, iframe)
     with io.open(filename, mode="w", encoding="utf-8") as f:
         f.write(html_page)

python-package/lets_plot/frontend_context/_configuration.py

@@ -6,7 +6,7 @@
 
 from ._frontend_ctx import FrontendContext
 from ._html_contexts import _create_html_frontend_context, _use_isolated_frame
-from .._global_settings import _get_global_bool
+from .._global_settings import get_global_bool
 from ..plot.core import PlotSpec
 from ..plot.plot import GGBunch
 
@@ -25,7 +25,7 @@ def _setup_html_context(isolated_frame: bool = None, offline: bool = None) -> No
     :param embed:
     :return:
     """
-    embed = offline if offline is not None else _get_global_bool('offline')
+    embed = offline if offline is not None else get_global_bool('offline')
     ctx = _create_html_frontend_context(isolated_frame, embed)
     ctx.configure(verbose=True)
     _frontend_contexts['html'] = ctx

python-package/lets_plot/frontend_context/_html_contexts.py

@@ -4,8 +4,9 @@
 import os
 
 from ._frontend_ctx import FrontendContext
-from ._static_html_page_ctx import StaticHtmlPageContext
 from ._jupyter_notebook_ctx import JupyterNotebookContext
+from ._static_html_page_ctx import StaticHtmlPageContext
+from .._global_settings import has_global_value, get_global_bool, HTML_ISOLATED_FRAME
 
 
 def _create_html_frontend_context(isolated_frame: bool = None, offline: bool = None) -> FrontendContext:
@@ -25,7 +26,9 @@ def _create_html_frontend_context(isolated_frame: bool = None, offline: bool = N
 
 
 def _use_isolated_frame() -> bool:
-    # ToDo: check env var first
+    # check environment
+    if has_global_value(HTML_ISOLATED_FRAME):
+        return get_global_bool(HTML_ISOLATED_FRAME)
 
     return _detect_isolated_frame()
 

python-package/lets_plot/frontend_context/_jupyter_notebook_ctx.py

@@ -13,7 +13,7 @@
 
 from ._frontend_ctx import FrontendContext
 from .. import _kbridge as kbr
-from .._global_settings import _get_global_str, _has_global_value, _is_production
+from .._global_settings import get_global_str, has_global_value, is_production
 from .._version import __version__
 
 
@@ -36,11 +36,11 @@ def as_str(self, plot_spec: Dict) -> str:
 
     @staticmethod
     def _configure_connected_script(verbose: bool) -> str:
-        base_url = _get_global_str("js_base_url")
-        if _has_global_value('js_name'):
-            name = _get_global_str('js_name')
+        base_url = get_global_str("js_base_url")
+        if has_global_value('js_name'):
+            name = get_global_str('js_name')
         else:
-            suffix = ".min.js" if _is_production() else ".js"
+            suffix = ".min.js" if is_production() else ".js"
             name = "lets-plot-{version}{suffix}".format(version=__version__, suffix=suffix)
 
         url = "{base_url}/{name}".format(base_url=base_url, name=name)

python-package/lets_plot/frontend_context/_static_html_page_ctx.py

@@ -6,7 +6,7 @@
 
 from ._frontend_ctx import FrontendContext
 from .. import _kbridge as kbr
-from .._global_settings import _is_production
+from .._global_settings import is_production
 from .._version import __version__
 
 
@@ -27,5 +27,5 @@ def configure(self, verbose: bool):
     def as_str(self, plot_spec: Dict) -> str:
         # embedding js is not supported (yet) in this context,
         # replace `dev` version with the `latest`.
-        version = __version__ if _is_production() else "latest"
+        version = __version__ if is_production() else "latest"
         return kbr._generate_static_html_page(plot_spec, version, iframe=False)