MAINT: add doctests to travis CI; minor fixes so they pass

.travis.yml

@@ -10,10 +10,11 @@ python:
 before_install:
   - pip install pip --upgrade;
   - pip install -r requirements.txt;
+  - pip install jinja2 sphinx docutils
 
 install:
   - python setup.py install;
 
 script:
   - flake8 ./;
-  - python -m pytest --pyargs altair;
+  - python -m pytest --pyargs --doctest-modules altair;

altair/utils/core.py

@@ -202,28 +202,28 @@ def parse_shorthand(shorthand, data=None):
     >>> parse_shorthand('name')
     {'field': 'name'}
 
-    >>> parse_shorthand('average(col)')
+    >>> parse_shorthand('average(col)')  # doctest: +SKIP
     {'aggregate': 'average', 'field': 'col'}
 
-    >>> parse_shorthand('foo:O')
+    >>> parse_shorthand('foo:O')  # doctest: +SKIP
     {'field': 'foo', 'type': 'ordinal'}
 
-    >>> parse_shorthand('min(foo):Q')
+    >>> parse_shorthand('min(foo):Q')  # doctest: +SKIP
     {'aggregate': 'min', 'field': 'foo', 'type': 'quantitative'}
 
-    >>> parse_shorthand('foo', data)
+    >>> parse_shorthand('foo', data)  # doctest: +SKIP
     {'field': 'foo', 'type': 'nominal'}
 
-    >>> parse_shorthand('bar', data)
+    >>> parse_shorthand('bar', data)  # doctest: +SKIP
     {'field': 'bar', 'type': 'quantitative'}
 
-    >>> parse_shorthand('bar:O', data)
+    >>> parse_shorthand('bar:O', data)  # doctest: +SKIP
     {'field': 'bar', 'type': 'ordinal'}
 
-    >>> parse_shorthand('sum(bar)', data)
+    >>> parse_shorthand('sum(bar)', data)  # doctest: +SKIP
     {'aggregate': 'sum', 'field': 'bar', 'type': 'quantitative'}
 
-    >>> parse_shorthand('count()', data)
+    >>> parse_shorthand('count()', data)  # doctest: +SKIP
     {'aggregate': 'count', 'type': 'quantitative'}
     """
     attrs = _parse_shorthand(shorthand)
@@ -305,9 +305,9 @@ def update_nested(original, update, copy=False):
     --------
     >>> original = {'x': {'b': 2, 'c': 4}}
     >>> update = {'x': {'b': 5, 'd': 6}, 'y': 40}
-    >>> update_nested(original, update)
+    >>> update_nested(original, update)  # doctest: +SKIP
     {'x': {'b': 5, 'c': 4, 'd': 6}, 'y': 40}
-    >>> original
+    >>> original  # doctest: +SKIP
     {'x': {'b': 5, 'c': 4, 'd': 6}, 'y': 40}
     """
     if copy:

altair/utils/schemapi.py

@@ -169,7 +169,7 @@ def __setitem__(self, item, val):
     def __repr__(self):
         if self._kwds:
             args = ("{0}: {1!r}".format(key, val)
-                    for key, val in self._kwds.items()
+                    for key, val in sorted(self._kwds.items())
                     if val is not Undefined)
             args = '\n' + ',\n'.join(args)
             return "{0}({{{1}\n}})".format(self.__class__.__name__,

altair/vegalite/v2/api.py

@@ -487,7 +487,7 @@ def transform_aggregate(self, aggregate=Undefined, groupby=Undefined, **kwds):
         ...     mean_acc='mean(Acceleration)',
         ...     groupby=['Origin']
         ... )
-        >>> print(chart1.transform[0].to_json())
+        >>> print(chart1.transform[0].to_json())  # doctest: +NORMALIZE_WHITESPACE
         {
           "aggregate": [
             {
@@ -552,20 +552,20 @@ def transform_bin(self, as_=Undefined, field=Undefined, bin=True, **kwargs):
         >>> chart = alt.Chart().transform_bin("x_binned", "x")
         >>> chart.transform[0]
         BinTransform({
+          as: 'x_binned',
           bin: True,
-          field: 'x',
-          as: 'x_binned'
+          field: 'x'
         })
 
         >>> chart = alt.Chart().transform_bin("x_binned", "x",
         ...                                   bin=alt.Bin(maxbins=10))
         >>> chart.transform[0]
         BinTransform({
+          as: 'x_binned',
           bin: BinParams({
             maxbins: 10
           }),
-          field: 'x',
-          as: 'x_binned'
+          field: 'x'
         })
 
         See Also
@@ -607,8 +607,8 @@ def transform_calculate(self, as_=Undefined, calculate=Undefined, **kwargs):
         >>> chart = alt.Chart().transform_calculate(y = 2 * expr.sin(datum.x))
         >>> chart.transform[0]
         CalculateTransform({
-          calculate: (2 * sin(datum.x)),
-          as: 'y'
+          as: 'y',
+          calculate: (2 * sin(datum.x))
         })
 
         It's also possible to pass the ``CalculateTransform`` arguments directly:
@@ -617,8 +617,8 @@ def transform_calculate(self, as_=Undefined, calculate=Undefined, **kwargs):
         >>> chart = alt.Chart().transform_calculate(**kwds)
         >>> chart.transform[0]
         CalculateTransform({
-          calculate: '2 * sin(datum.x)',
-          as: 'y'
+          as: 'y',
+          calculate: '2 * sin(datum.x)'
         })
 
         As the first form is easier to write and understand, that is the

altair/vegalite/v2/examples/anscombe_plot.py

@@ -1,5 +1,5 @@
 """
-Anscombe’s Quartet
+Anscombe's Quartet
 ------------------
 
 This example shows how to use the column channel to make a trellis plot. Anscombe's Quartet is a famous dataset constructed by Francis Anscombe. Common summary statistics are identical for each subset of the data, despite the subsets having vastly different characteristics.

altair/vegalite/v2/examples/step_chart.py

@@ -3,10 +3,10 @@
 ----------
 This example shows Google's stock price over time.
 This uses the "step-after" interpolation scheme.
-The full list of interpolation options includes 'linear’,
-‘linear-closed’, ‘step’, ‘step-before’, ‘step-after’, ‘basis’,
-‘basis-open’, ‘basis-closed’, ‘cardinal’, ‘cardinal-open’,
-‘cardinal-closed’, ‘bundle’, and ‘monotone’.
+The full list of interpolation options includes 'linear',
+'linear-closed', 'step', 'step-before', 'step-after', 'basis',
+'basis-open', 'basis-closed', 'cardinal', 'cardinal-open',
+'cardinal-closed', 'bundle', and 'monotone'.
 """
 # category: basic charts
 

tools/schemapi/schemapi.py

@@ -165,7 +165,7 @@ def __setitem__(self, item, val):
     def __repr__(self):
         if self._kwds:
             args = ("{0}: {1!r}".format(key, val)
-                    for key, val in self._kwds.items()
+                    for key, val in sorted(self._kwds.items())
                     if val is not Undefined)
             args = '\n' + ',\n'.join(args)
             return "{0}({{{1}\n}})".format(self.__class__.__name__,