Initial Python 2 support

plotly/io/_orca.py

@@ -1,12 +1,12 @@
 import warnings
 from copy import copy
-from json import JSONDecodeError
 from pprint import pformat
 import requests
 import subprocess
 import socket
 import json
 import os
+import sys
 import threading
 import retrying
 import atexit
@@ -90,14 +90,81 @@ def _find_open_port():
     int
         An open port
     """
-    with socket.socket() as s:
-        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-        s.bind(('', 0))
-        _, port = s.getsockname()
+    s = socket.socket()
+    s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+    s.bind(('', 0))
+    _, port = s.getsockname()
+    s.close()
 
     return port
 
 
+def which_py2(cmd, mode=os.F_OK | os.X_OK, path=None):
+    """
+    Backport (unmodified) of shutil.which command from Python 3.6
+    Remove this when Python 2 support is dropped
+
+    Given a command, mode, and a PATH string, return the path which
+    conforms to the given mode on the PATH, or None if there is no such
+    file.
+
+    `mode` defaults to os.F_OK | os.X_OK. `path` defaults to the result
+    of os.environ.get("PATH"), or can be overridden with a custom search
+    path.
+    """
+    # Check that a given file can be accessed with the correct mode.
+    # Additionally check that `file` is not a directory, as on Windows
+    # directories pass the os.access check.
+    def _access_check(fn, mode):
+        return (os.path.exists(fn) and os.access(fn, mode)
+                and not os.path.isdir(fn))
+
+    # If we're given a path with a directory part, look it up directly rather
+    # than referring to PATH directories. This includes checking relative to the
+    # current directory, e.g. ./script
+    if os.path.dirname(cmd):
+        if _access_check(cmd, mode):
+            return cmd
+        return None
+
+    if path is None:
+        path = os.environ.get("PATH", os.defpath)
+    if not path:
+        return None
+    path = path.split(os.pathsep)
+
+    if sys.platform == "win32":
+        # The current directory takes precedence on Windows.
+        if not os.curdir in path:
+            path.insert(0, os.curdir)
+
+        # PATHEXT is necessary to check on Windows.
+        pathext = os.environ.get("PATHEXT", "").split(os.pathsep)
+        # See if the given file matches any of the expected path extensions.
+        # This will allow us to short circuit when given "python.exe".
+        # If it does match, only test that one, otherwise we have to try
+        # others.
+        if any(cmd.lower().endswith(ext.lower()) for ext in pathext):
+            files = [cmd]
+        else:
+            files = [cmd + ext for ext in pathext]
+    else:
+        # On other platforms you don't have things like PATHEXT to tell you
+        # what file suffixes are executable, so just pass on cmd as-is.
+        files = [cmd]
+
+    seen = set()
+    for dir in path:
+        normdir = os.path.normcase(dir)
+        if not normdir in seen:
+            seen.add(normdir)
+            for thefile in files:
+                name = os.path.join(dir, thefile)
+                if _access_check(name, mode):
+                    return name
+    return None
+
+
 def which(cmd):
     """
     Return the absolute path of the input executable string, based on the
@@ -117,9 +184,12 @@ def which(cmd):
         the executable was not found.
 
     """
-    import shutil
-    # TODO: this doesn't exist on Python 2.7 :-(
-    return shutil.which(cmd)
+    if sys.version_info > (3, 0):
+        # Python 3 code in this block
+        import shutil
+        return shutil.which(cmd)
+    else:
+        return which_py2(cmd)
 
 
 # Orca configuration class
@@ -183,7 +253,7 @@ def update(self, d={}, **kwargs):
         """
         # Combine d and kwargs
         if not isinstance(d, dict):
-            raise ValueError("""\
+            raise ValueError("""
 The first argument to update must be a dict, \
 but received value of type {typ}l
     Received value: {val}""".format(typ=type(d), val=d))
@@ -218,7 +288,7 @@ def port(self):
     @port.setter
     def port(self, val):
         if val is not None and not isinstance(val, int):
-            raise ValueError("""\
+            raise ValueError("""
 The port value must be an integer, but received value of type {typ}.
     Received value: {val}""".format(typ=type(val), val=val))
 
@@ -261,7 +331,7 @@ def executable(self, val):
         # Validate val
         # ------------
         if not isinstance(val, str):
-            raise ValueError("""\
+            raise ValueError("""
 The executable property must be a string, but received value of type {typ}.
     Received value: {val}""".format(typ=type(val), val=val))
         self._props['executable'] = val
@@ -423,7 +493,7 @@ def reload(self, warn=True):
             # ### Parse as JSON ###
             try:
                 orca_props = json.loads(orca_str)
-            except JSONDecodeError:
+            except ValueError:
                 if warn:
                     warnings.warn("""\
 Orca configuration file at {path} is not valid JSON""".format(
@@ -625,7 +695,7 @@ def validate_orca_executable():
     # Search for executable name or path in config.executable
     executable = which(config.executable)
     if executable is None:
-        raise ValueError("""\
+        raise ValueError("""
 The orca executable is required in order to export figures as static images,
 but it could not be found on the system path.
 
@@ -634,7 +704,7 @@ def validate_orca_executable():
 
     # Run executable with --help and see if it's our orca
     # ---------------------------------------------------
-    invalid_executable_msg = """\
+    invalid_executable_msg = """
 The orca executable is required in order to export figures as static images,
 but the executable that was found at '{executable}' does not seem to be a
 valid plotly orca executable. 
@@ -659,15 +729,15 @@ def validate_orca_executable():
     try:
         orca_version = subprocess.check_output([executable, '--version'])
     except subprocess.CalledProcessError:
-        raise ValueError("""\
+        raise ValueError("""
 An error occurred while trying to get the version of the orca executable.
 Here is the command that plotly.py ran to request the version:
 
     $ {executable} --version
 """)
 
     if not orca_version:
-        raise ValueError("""\
+        raise ValueError("""
 No version was reported by the orca executable.      
 
 Here is the command that plotly.py ran to request the version:

plotly/tests/test_optional/test_io/test_orca.py

@@ -22,12 +22,29 @@ def ping_pongs(server_url):
 class ValidateOrcaTest(TestCase):
     def setUp(self):
         pio.orca.reset_orca_status()
+        pio.orca.config.restore_defaults()
 
     def test_validate_orca(self):
         self.assertEqual(pio.orca.status.state, 'unvalidated')
         pio.orca.validate_orca_executable()
         self.assertEqual(pio.orca.status.state, 'validated')
 
+    def test_orca_not_found(self):
+        pio.orca.config.executable = 'bogus'
+        with self.assertRaises(ValueError) as err:
+            pio.orca.validate_orca_executable()
+
+        self.assertEqual(pio.orca.status.state, 'unvalidated')
+        self.assertIn('could not be found', err.exception.args[0])
+
+    def test_invalid_executable_found(self):
+        pio.orca.config.executable = 'cd'
+        with self.assertRaises(ValueError) as err:
+            pio.orca.validate_orca_executable()
+
+        self.assertEqual(pio.orca.status.state, 'unvalidated')
+        self.assertIn('executable that was found at', err.exception.args[0])
+
     def test_orca_executable_path(self):
         self.assertIsNone(pio.orca.status.executable)
         if os.name == 'nt':  # Windows