Merge branch 'master' into grid_docs

Author: chriddyp

README.rst

@@ -107,9 +107,9 @@ License: MIT
 .. _Plotly: https://plot.ly
 .. _Quickstart: https://plot.ly/python
 .. _GitHub repo: https://github.com/plotly/python-api
-.. _Plotly and mpld3: http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s6_matplotlylib/s6_matplotlylib.ipynb
-.. _Plotly and Python: http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s0_getting-started/s0_getting-started.ipynb
-.. _set of notebooks: http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s00_homepage/s00_homepage.ipynb
+.. _Plotly and mpld3: https://plot.ly/python/matplotlib-to-plotly-tutorial/
+.. _Plotly and Python: https://plot.ly/python/overview/
+.. _set of notebooks: https://plot.ly/python/user-guide/
 .. _plotly profile: https://plot.ly/~mpld3/
 .. _@plotlygraphs: https://twitter.com/plotlygraphs
 .. _feedback@plot.ly: feedback@plot.ly

circle.yml

@@ -0,0 +1,33 @@
+machine:
+  environment:
+    PLOTLY_PACKAGE_ROOT: /home/ubuntu/python-api
+    PLOTLY_CONFIG_DIR: ${HOME}/.plotly
+    PLOTLY_PYTHON_VERSIONS: 2.6.8 2.7.8 3.3.3 3.4.1
+    PLOTLY_CORE_REQUIREMENTS_FILE: ${PLOTLY_PACKAGE_ROOT}/requirements.txt
+    PLOTLY_OPTIONAL_REQUIREMENTS_FILE: ${PLOTLY_PACKAGE_ROOT}/optional-requirements.txt
+    PLOTLY_OPTIONAL_REQUIREMENTS_FILE_2_6: ${PLOTLY_PACKAGE_ROOT}/optional-requirements-2-6.txt
+dependencies:
+  pre:
+    # run all the pre-written installers (this will take a *while*)
+    - bash circle/setup.sh
+    # install testing tools for circle's version of things
+    - PYENV_VERSION=2.7 && pip install nose coverage
+  override:
+    - PYENV_VERSION=2.7 && pip install -I .
+    - PYENV_VERSION=2.7 && cd ~ && python -c "import plotly"
+test:
+  override:
+
+    # run test suite in all our python versions
+    - bash circle/test.sh
+
+#    # test that it imports when you don't have file permissions
+#    - sudo chmod 400 ${PLOTLY_CONFIG_DIR} && python -c "import plotly"
+#
+#    # test that setting permissions will work for import (and tests)
+#    - sudo chmod 600 ${PLOTLY_CONFIG_DIR} && python -c "import plotly"
+
+    # test core things in the general 2.7 version that circle has
+    - PYENV_VERSION=2.7 && nosetests -xv plotly/tests --with-coverage --cover-package=plotly
+    - mkdir "${CIRCLE_ARTIFACTS}/2.7" || true
+    - coverage html -d "${CIRCLE_ARTIFACTS}/2.7" --title=2.7

circle/setup.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+echo "running setup routine with python versions:"
+for version in ${PLOTLY_PYTHON_VERSIONS[@]}; do
+    echo "    ${version}"
+done
+
+PROGNAME=$(basename $0)
+function error_exit
+{
+    echo -e "${PROGNAME}: ${1:-"Unknown Error"}\n" 1>&2
+    exit 1
+}
+
+# for each version we want, setup a functional virtual environment
+for version in ${PLOTLY_PYTHON_VERSIONS[@]}; do
+    echo Setting up Python ${version}
+
+    # exporting this variable (in this scope) chooses the python version
+    export PYENV_VERSION=${version}
+    echo "Using pyenv version $(pyenv version)"
+
+    # install core requirements all versions need
+    pip install -r ${PLOTLY_CORE_REQUIREMENTS_FILE} ||
+        error_exit "${LINENO}: can't install core reqs for Python ${version}"
+
+    # handle funkiness around python 2.6
+    if [ ${version:0:3} == '2.6' ]
+    then
+        pip install simplejson ordereddict ||
+            error_exit "${LINENO}: can't install extras for Python ${version}"
+        pip install -r ${PLOTLY_OPTIONAL_REQUIREMENTS_FILE_2_6} ||
+            error_exit "${LINENO}: can't install optional for Python ${version}"
+    else
+        pip install -r ${PLOTLY_OPTIONAL_REQUIREMENTS_FILE} ||
+            error_exit "${LINENO}: can't install optional for Python ${version}"
+    fi
+
+    # install some test tools
+    pip install nose coverage ||
+        error_exit "${LINENO}: can't install test tools for Python ${version}"
+done

circle/test.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+echo "running test routine with python versions:"
+for version in ${PLOTLY_PYTHON_VERSIONS[@]}; do
+    echo "    ${version}"
+done
+
+PROGNAME=$(basename $0)
+function error_exit
+{
+    echo -e "${PROGNAME}: ${1:-"Unknown Error"}\n" 1>&2
+    exit 1
+}
+
+# for each version we want, setup a functional virtual environment
+for version in ${PLOTLY_PYTHON_VERSIONS[@]}; do
+    echo Testing Python ${version}
+
+    # exporting this variable (in this scope) chooses the python version
+    export PYENV_VERSION=${version}
+    echo "Using pyenv version $(pyenv version)"
+
+    echo "install plotly (ignoring possibly cached versions)"
+    pip install -I ${PLOTLY_PACKAGE_ROOT} ||
+        error_exit "${LINENO}: can't install plotly package from project root"
+
+    echo "import plotly to create .plotly dir if DNE"
+    python -c 'import plotly' ||
+        error_exit "${LINENO}: can't import plotly package"
+
+#    echo "${HOME}"
+#    echo "${PLOTLY_CONFIG_DIR}"
+#
+#    # test that it imports when you don't have write permissions
+#    sudo chmod -R 444 ${PLOTLY_CONFIG_DIR} && python -c "import plotly" ||
+#        error_exit "${LINENO}: permissions test 444 on .plotly dir failed"
+#
+#    # test that setting write permissions will work for import (and tests)
+#    sudo chmod -R 666 ${PLOTLY_CONFIG_DIR} && python -c "import plotly" ||
+#        error_exit "${LINENO}: permissions test 666 on .plotly dir failed"
+
+    echo "running tests for Python ${version} as user '$(whoami)'"
+    nosetests -xv plotly/tests --with-coverage --cover-package=plotly ||
+        error_exit "${LINENO}: test suite failed for Python ${version}"
+    mkdir "${CIRCLE_ARTIFACTS}/${PYENV_VERSION}" || true
+    coverage html -d "${CIRCLE_ARTIFACTS}/${PYENV_VERSION}" \
+        --title=${PYENV_VERSION}
+
+done

optional-requirements-2-6.txt

@@ -0,0 +1,18 @@
+### Optional Dependencies for Additional Plotly Functionality   ###
+###                                                             ###
+### To install, run:                                            ###
+###      $ pip install -r optional-requirements.txt             ###
+###                                                             ###
+###################################################################
+
+## numpy (technically, this is covered by matplotlib's deps) ##
+numpy
+
+## matplotlylib dependencies ##
+matplotlib==1.3.1
+
+## testing dependencies ##
+nose==1.3.3
+
+## pandas deps for some matplotlib functionality ##
+pandas

optional-requirements.txt

@@ -5,11 +5,17 @@
 ###                                                             ###
 ###################################################################
 
+## numpy (technically, this is covered by matplotlib's deps) ##
+numpy
+
 ## matplotlylib dependencies ##
 matplotlib==1.3.1
 
 ## testing dependencies ##
 nose==1.3.3
 
 ## ipython dependencies ##
-ipython[all]
+ipython[all]
+
+## pandas deps for some matplotlib functionality ##
+pandas

plotly/exceptions.py

@@ -16,6 +16,7 @@
 
 """
 import json
+import six
 
 ## Base Plotly Error ##
 
@@ -36,7 +37,9 @@ def __init__(self, requests_exception):
         if 'json' in content_type:
             content = requests_exception.response.content
             if content != '':
-                res_payload = json.loads(requests_exception.response.content)
+                res_payload = json.loads(
+                    requests_exception.response.content.decode('utf8')
+                )
                 if 'detail' in res_payload:
                     self.message = res_payload['detail']
                 else:
@@ -66,7 +69,7 @@ def __str__(self):
 NON_UNIQUE_COLUMN_MESSAGE = (
     "Yikes, plotly grids currently "
     "can't have duplicate column names. Rename "
-    "the column \"{}\" and try again."
+    "the column \"{0}\" and try again."
 )
 ## Would Cause Server Errors ##
 

plotly/graph_objs/graph_objs.py

@@ -215,7 +215,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
@@ -323,14 +323,14 @@ def __setitem__(self, key, value):
         return super(PlotlyDict, self).__setitem__(key, value)
 
     def _assign_id_to_src(self, src_name, src_value):
-        if isinstance(src_value, basestring):
+        if isinstance(src_value, six.string_types):
             src_id = src_value
         else:
             try:
                 src_id = src_value.id
             except:
-                err = ("{} does not have an `id` property. "
-                       "{} needs to be assigned to either an "
+                err = ("{0} does not have an `id` property. "
+                       "{1} needs to be assigned to either an "
                        "object with an `id` (like a "
                        "plotly.grid_objs.Column) or a string. "
                        "The `id` is a unique identifier "
@@ -430,7 +430,7 @@ def strip_style(self):
                         elif not hasattr(self[key], '__iter__'):
                             del self[key]
                 except KeyError:  # TODO: Update the JSON
-                    # print "'type' not in {0} for {1}".format(obj_key, key)
+                    # print("'type' not in {0} for {1}".format(obj_key, key))
                     pass
 
     def get_data(self):
@@ -605,7 +605,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
@@ -759,7 +759,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with
@@ -962,7 +962,7 @@ def to_string(self, level=0, indent=4, eol='\n',
 
         Example:
 
-            print obj.to_string()
+            print(obj.to_string())
 
         Keyword arguments:
         level (default = 0) -- set number of indentations to start with

plotly/grid_objs/grid_objs.py

@@ -76,9 +76,9 @@ def __str__(self):
         return string.format(name=self.name, data=data_string, id=self.id)
 
     def __repr__(self):
-        return 'Column("{}", {})'.format(self.data, self.name)
+        return 'Column("{0}", {1})'.format(self.data, self.name)
 
-    def to_json(self):
+    def to_plotly_json(self):
         return {'name': self.name, 'data': self.data}
 
 

plotly/matplotlylib/mpltools.py

@@ -386,7 +386,7 @@ def prep_ticks(ax, index, ax_type, props):
                     for i in range(1, len(dticks) - 1)]):
                 dtick = tickvalues[1] - tickvalues[0]
             else:
-                warnings.warn("'linear' {}-axis tick spacing not even, "
+                warnings.warn("'linear' {0}-axis tick spacing not even, "
                               "ignoring mpl tick formatting.".format(ax_type))
                 raise TypeError
         except (IndexError, TypeError):
@@ -413,7 +413,7 @@ def prep_ticks(ax, index, ax_type, props):
                                  math.log10(props['ylim'][1])]
         else:
             axis_dict = dict(range=None, type='linear')
-            warnings.warn("Converted non-base10 {}-axis log scale to 'linear'"
+            warnings.warn("Converted non-base10 {0}-axis log scale to 'linear'"
                           "".format(ax_type))
     else:
         return dict()
@@ -422,13 +422,17 @@ def prep_ticks(ax, index, ax_type, props):
     if ax_type == 'x' and 'DateFormatter' in formatter:
         axis_dict['type'] = 'date'
         try:
-            axis_dict['tick0'] = mpl_dates_to_datestrings(axis_dict['tick0'])
+            axis_dict['tick0'] = mpl_dates_to_datestrings(
+                axis_dict['tick0'], formatter
+            )
         except KeyError:
             pass
         finally:
             axis_dict.pop('dtick', None)
             axis_dict.pop('autotick', None)
-            axis_dict['range'] = mpl_dates_to_datestrings(props['xlim'])
+            axis_dict['range'] = mpl_dates_to_datestrings(
+                props['xlim'], formatter
+            )
 
     if formatter == 'LogFormatterMathtext':
         axis_dict['exponentformat'] = 'e'
@@ -457,22 +461,39 @@ def prep_xy_axis(ax, props, x_bounds, y_bounds):
     return xaxis, yaxis
 
 
-def mpl_dates_to_datestrings(mpl_dates, format_string="%Y-%m-%d %H:%M:%S"):
-    """Convert matplotlib dates to formatted datestrings for plotly.
+def mpl_dates_to_datestrings(dates, mpl_formatter):
+    """Convert matplotlib dates to iso-formatted-like time strings.
+
+    Plotly's accepted format: "YYYY-MM-DD HH:MM:SS" (e.g., 2001-01-01 00:00:00)
 
     Info on mpl dates: http://matplotlib.org/api/dates_api.html
 
     """
-    try:
-        date_times = matplotlib.dates.num2date(mpl_dates, tz=pytz.utc)
-        time_strings = [date_time.strftime(format_string)
-                        for date_time in date_times]
-        if len(time_strings) > 1:
-            return time_strings
-        else:
-            return time_strings[0]
-    except TypeError:
-        return mpl_dates
+    _dates = dates
+
+    # this is a pandas datetime formatter, times show up in floating point days
+    # since the epoch (1970-01-01T00:00:00+00:00)
+    if mpl_formatter == "TimeSeries_DateFormatter":
+        try:
+            dates = matplotlib.dates.epoch2num(
+                [date*24*60*60 for date in dates]
+            )
+            dates = matplotlib.dates.num2date(dates, tz=pytz.utc)
+        except:
+            return _dates
+
+    # the rest of mpl dates are in floating point days since
+    # (0001-01-01T00:00:00+00:00) + 1. I.e., (0001-01-01T00:00:00+00:00) == 1.0
+    # according to mpl --> try num2date(1)
+    else:
+        try:
+            dates = matplotlib.dates.num2date(dates, tz=pytz.utc)
+        except:
+            return _dates
+
+    time_stings = [' '.join(date.isoformat().split('+')[0].split('T'))
+                   for date in dates]
+    return time_stings
 
 
 DASH_MAP = {