Magic preprocessors for conversion to vanilla Python

doc/Tutorials/Options.ipynb

@@ -607,7 +607,7 @@
    },
    "outputs": [],
    "source": [
-    "from holoviews.ipython.parser import OptsSpec\n",
+    "from holoviews.util.parser import OptsSpec\n",
     "renderer.save(image + waves, 'example_V', \n",
     "              options=OptsSpec.parse(\"Image (cmap='gray')\"))"
    ]

examples/README.rst

@@ -0,0 +1,7 @@
+
+When working on a notebook in examples/ make sure to run ``python
+examples.py reference Example.ipynb`` to locate any references to that
+notebook in the documenation.
+
+If there are any such references, please check that the content of those
+pages is still correct.

examples/examples.py

@@ -0,0 +1,4 @@
+"""
+Stub for script that will do things like generate an index and check for
+references in the documentation.
+"""

holoviews/__init__.py

@@ -12,7 +12,7 @@
                             commit="$Format:%h$", reponame='holoviews')
 
 from .core import archive                                # noqa (API import)
-from .core.dimension import OrderedDict, Dimension       # noqa (API import)
+from .core.dimension import OrderedDict, Dimension, Dimensioned       # noqa (API import)
 from .core.boundingregion import BoundingBox             # noqa (API import)
 from .core.options import (Options, Store, Cycle,        # noqa (API import)
                            Palette, StoreOptions)

holoviews/core/dimension.py

@@ -1077,13 +1077,24 @@ def __unicode__(self):
         return unicode(PrettyPrinter.pprint(self))
 
 
-
     def __call__(self, options=None, **kwargs):
+        return self.opts(options, **kwargs)
+
+    def opts(self, options=None, **kwargs):
         """
         Apply the supplied options to a clone of the object which is
         then returned. Note that if no options are supplied at all,
         all ids are reset.
         """
+        from ..util.parser import OptsSpec
+        if isinstance(options, basestring):
+            try:
+                options = OptsSpec.parse(options)
+            except:
+                options = OptsSpec.parse(
+                    '{clsname} {options}'.format(clsname=self.__class__.__name__,
+                                                 options=options))
+
         groups = set(Store.options().groups.keys())
         if kwargs and set(kwargs) <= groups:
             if not all(isinstance(v, dict) for v in kwargs.values()):

holoviews/core/options.py

@@ -1505,7 +1505,7 @@ def set_options(cls, obj, options=None, **kwargs):
         syntax as the IPython cell magic to achieve the same customization
         as shown above:
 
-        from holoviews.ipython.parser import OptsSpec
+        from holoviews.util.parser import OptsSpec
         set_options(my_image, OptsSpec.parse("Image (cmap='jet')"))
 
         Then setting both plot and style options:

holoviews/ipython/__init__.py

@@ -3,19 +3,19 @@
 
 import param
 from IPython import version_info
-import numpy as np
 import holoviews
 from param import ipython as param_ext
 from IPython.display import HTML
 
 from ..core.tree import AttrTree
-from ..core.options import Store, Cycle, Palette
+from ..core.options import Store
 from ..element.comparison import ComparisonTestCase
 from ..interface.collector import Collector
+from ..util.settings import list_formats, list_backends
 from ..plotting.renderer import Renderer
-from .magics import load_magics, list_formats, list_backends
+from .magics import load_magics
 from .display_hooks import display  # noqa (API import)
-from .display_hooks import set_display_hooks, OutputMagic
+from .display_hooks import set_display_hooks
 from .widgets import RunProgress
 
 try:
@@ -28,14 +28,6 @@
 except ImportError:
     pass
 
-try:
-    import pyparsing
-    from .parser import Parser
-    Parser.namespace = {'np': np, 'Cycle': Cycle, 'Palette': Palette}
-except ImportError:
-    pyparsing = None
-
-
 Collector.interval_hook = RunProgress
 AttrTree._disabled_prefixes = ['_repr_','_ipython_canary_method_should_not_exist']
 
@@ -179,9 +171,10 @@ def __call__(self, *args, **params):
                                                                               fig='svg')
                         holoviews.archive.exporters = [svg_exporter] +\
                                                       holoviews.archive.exporters
-                OutputMagic.allowed['backend'] = list_backends()
-                OutputMagic.allowed['fig'] = list_formats('fig', backend)
-                OutputMagic.allowed['holomap'] = list_formats('holomap', backend)
+
+                Store.output_settings.allowed['backend'] = list_backends()
+                Store.output_settings.allowed['fig'] = list_formats('fig', backend)
+                Store.output_settings.allowed['holomap'] = list_formats('holomap', backend)
 
         if selected_backend is None:
             raise ImportError('None of the backends could be imported')
@@ -190,7 +183,7 @@ def __call__(self, *args, **params):
         try:
             ip = params.pop('ip', None) or get_ipython() # noqa (get_ipython)
         except:
-            # Set current backend (usually has to wait until OutputMagic loaded)
+            # Set current backend (usually has to wait until OutputSettings loaded)
             Store.current_backend = selected_backend
             return
 
@@ -207,7 +200,7 @@ def __call__(self, *args, **params):
         if notebook_extension._loaded == False:
             param_ext.load_ipython_extension(ip, verbose=False)
             load_magics(ip)
-            OutputMagic.initialize([backend for backend, _ in imports])
+            Store.output_settings.initialize([backend for backend, _ in imports])
             set_display_hooks(ip)
             notebook_extension._loaded = True
         Store.current_backend = selected_backend

holoviews/ipython/archive.py

@@ -8,6 +8,7 @@
 
 from IPython import version_info
 from IPython.display import Javascript, display
+from .preprocessors import Substitute
 
 # Import appropriate nbconvert machinery
 if version_info[0] >= 4:
@@ -285,54 +286,4 @@ def _get_notebook_node(self):                   # pragma: no cover
         return node
 
 
-
-class Substitute(Preprocessor):
-    """
-    An nbconvert preprocessor that substitutes one set of HTML data
-    output for another, adding annotation to the output as required.
-
-    The constructor accepts the notebook format version and a
-    substitutions dictionary:
-
-    {source_html:(target_html, annotation)}
-
-    Where the annotation may be None (i.e. no annotation).
-    """
-    annotation = '<center><b>%s</b></center>'
-
-    def __init__(self, version, substitutions, **kw):
-        self.nbversion = version
-        self.substitutions = substitutions
-        super(Preprocessor, self).__init__(**kw)
-
-    def __call__(self, nb, resources): # Temporary hack around 'enabled' flag
-        return self.preprocess(nb,resources)
-
-
-    def replace(self, src):
-        "Given some source html substitute and annotated as applicable"
-        for html in self.substitutions.keys():
-            if src == html:
-                annotation = self.annotation % self.substitutions[src][1]
-                return annotation + self.substitutions[src][0]
-        return src
-
-
-    def preprocess_cell(self, cell, resources, index):
-        v4 = (self.nbversion[0] == 4)
-        if cell['cell_type'] == 'code':
-            for outputs in cell['outputs']:
-                output_key = ('execute_result' if v4 else 'pyout')
-                if outputs['output_type'] == output_key:
-                    # V1-3
-                    if not v4 and 'html' in outputs:
-                        outputs['html'] = self.replace(outputs['html'])
-                    # V4
-                    for data in outputs.get('data',[]):
-                        if v4 and data == 'text/html':
-                            substitution = self.replace(outputs['data']['text/html'])
-                            outputs['data']['text/html'] = substitution
-        return cell, resources
-
-
 notebook_archive = NotebookArchive()

holoviews/ipython/display_hooks.py

@@ -16,7 +16,8 @@
                     CompositeOverlay, DynamicMap)
 from ..core.traversal import unique_dimkeys
 from ..core.io import FileArchive
-from .magics import OutputMagic, OptsMagic
+from ..util.settings import OutputSettings
+from .magics import OptsMagic, OutputMagic
 
 # To assist with debugging of display hooks
 FULL_TRACEBACK = None
@@ -30,7 +31,7 @@
 def max_frame_warning(max_frames):
     sys.stderr.write("Skipping regular visual display to avoid "
                      "lengthy animation render times\n"
-                     "[Total item frames exceeds max_frames on OutputMagic (%d)]"
+                     "[Total item frames exceeds max_frames on OutputSettings (%d)]"
                      % max_frames)
 
 def process_object(obj):
@@ -126,14 +127,14 @@ def wrapped(element):
 
         try:
             html = fn(element,
-                      max_frames=OutputMagic.options['max_frames'])
+                      max_frames=OutputSettings.options['max_frames'])
 
             # Only want to add to the archive for one display hook...
             disabled_suffixes = ['png_display', 'svg_display']
             if not any(fn.__name__.endswith(suffix) for suffix in disabled_suffixes):
                 if type(holoviews.archive) is not FileArchive:
                     holoviews.archive.add(element, html=html)
-            filename = OutputMagic.options['filename']
+            filename = OutputSettings.options['filename']
             if filename:
                 Store.renderers[Store.current_backend].save(element, filename)