[CIVP-10391] Add Python 2.7 compatibility (#73)

* COMPAT: Install mock

* TST: Test on 2.7

* COMPAT: Install futures

* COMPAT: Absolute imports

* COMPAT: six.raise_from

* COMPAT: lru_cache

* COMPAT: inspect.signature

* COMPAT: import from package

* COMPAT: super

* COMPAT: print function

* COMPAT: Default kwarg after argument packing

* COMPAT: Remove keyword-only argument syntax

* COMPAT: ensure str

* COMPAT: Remove type hints

* COMPAT: FileNotFoundError

* COMPAT: Ensure new-style class

* COMPAT: assertCountEquals

* COMPAT: StringIO and BytesIO

* COMPAT: tempfile.TemporaryDirectory

* COMPAT: set repr

* COMPAT: BytesIO vs StringIO

* COMPAT: tempfile.TemporaryDirectory

* COMPAT: Mock __builtin__.open

* DOC: Document 2.7 compatibility

* STY: Two lines before function

* STY: Ignore linting

* TST: Only build docs on Python 3

* REF: Always cleanup. Use shutil.

* REF: Pop kwarg

* DOC: Document json_output kwarg

* REF: Move FileNotFoundError to compat

* COMPAT: Remove keyword argument

* DEV: Protect dev dependency

* MAINT: Update setuptools classifiers

* DOC: Update python support

* TST: Explicitly test all versions

* TST: Give extra info on skips and fails

* DEV: Don't build docs on python 3.6

* ENH: Don't assume fname has no path

Author: jseabold

.travis.yml

@@ -1,6 +1,9 @@
 language: python
 python:
+    - "2.7"
     - "3.4"
+    - "3.5"
+    - "3.6"
 install:
     - pip install --upgrade pip setuptools
     - pip install -r requirements.txt
@@ -11,5 +14,5 @@ env:
     - CIVIS_API_KEY=FOOBAR
 before_script: flake8 civis
 script:
-    - py.test --cov civis
-    - sphinx-build -b html -n docs/source/ docs/build/
+    - py.test -rxs --cov civis
+    - if [[ $TRAVIS_PYTHON_VERSION == 3.5* ]] ; then sphinx-build -b html -n docs/source/ docs/build/ ; fi

CHANGELOG.md

@@ -10,6 +10,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Added functions ``civis.io.file_id_from_run_output``, ``civis.io.file_to_dataframe``, and ``civis.io.file_to_json``.
 - Added ``civis.ml`` namespace with ``ModelPipeline`` interface to Civis Platform modeling capabilities.
 - Added ``examples`` directory with sample ``ModelPipeline`` code from ``civis.ml``.
+- Python 2.7 compatibility
 
 ### Fixed
 - Corrected the defaults listed in the docstring for ``civis.io.civis_to_multifile_csv``.

civis/__init__.py

@@ -1,5 +1,7 @@
-from ._version import __version__
-from .civis import APIClient, find, find_one
-from . import io
+from __future__ import absolute_import
+
+from civis._version import __version__
+from civis.civis import APIClient, find, find_one
+from civis import io
 
 __all__ = ["__version__", "APIClient", "find", "find_one", "io"]

civis/base.py

@@ -1,7 +1,10 @@
+from __future__ import absolute_import
+from builtins import super
 import os
 from posixpath import join
 import threading
 from concurrent import futures
+import six
 import warnings
 
 from requests.packages.urllib3.util import Retry
@@ -95,7 +98,7 @@ def is_retry(self, method, status_code, has_retry_after=False):
                                     has_retry_after=has_retry_after)
 
 
-class Endpoint:
+class Endpoint(object):
 
     _lock = threading.Lock()
 
@@ -119,7 +122,8 @@ def _make_request(self, method, path=None, params=None, data=None,
 
         if response.status_code == 401:
             auth_error = response.headers["www-authenticate"]
-            raise CivisAPIKeyError(auth_error) from CivisAPIError(response)
+            six.raise_from(CivisAPIKeyError(auth_error),
+                           CivisAPIError(response))
 
         if not response.ok:
             raise CivisAPIError(response)

civis/civis.py

@@ -1,4 +1,4 @@
-import functools
+from __future__ import absolute_import
 import logging
 import os
 
@@ -7,6 +7,7 @@
 
 import civis
 from civis.base import AggressiveRetry
+from civis.compat import lru_cache
 from civis.resources import generate_classes_maybe_cached
 
 
@@ -58,7 +59,7 @@ def find_one(object_list, filter_func=None, **kwargs):
 
 class MetaMixin():
 
-    @functools.lru_cache()
+    @lru_cache(maxsize=128)
     def get_database_id(self, database):
         """Return the database ID for a given database name.
 
@@ -86,7 +87,7 @@ def get_database_id(self, database):
 
         return db["id"]
 
-    @functools.lru_cache()
+    @lru_cache(maxsize=128)
     def get_database_credential_id(self, username, database_name):
         """Return the credential ID for a given username in a given database.
 
@@ -136,7 +137,7 @@ def get_database_credential_id(self, username, database_name):
 
         return my_creds["id"]
 
-    @functools.lru_cache()
+    @lru_cache(maxsize=128)
     def get_aws_credential_id(self, cred_name, owner=None):
         """Find an AWS credential ID.
 
@@ -202,7 +203,7 @@ def get_aws_credential_id(self, cred_name, owner=None):
 
         return my_creds["id"]
 
-    @functools.lru_cache()
+    @lru_cache(maxsize=128)
     def get_table_id(self, table, database):
         """Return the table ID for a given database and table name.
 
@@ -239,15 +240,15 @@ def get_table_id(self, table, database):
         return tables[0].id
 
     @property
-    @functools.lru_cache()
+    @lru_cache(maxsize=128)
     def default_credential(self):
         """The current user's default credential."""
         # NOTE: this should be optional to endpoints...so this could go away
         creds = self.credentials.list(default=True)
         return creds[0]['id'] if len(creds) > 0 else None
 
     @property
-    @functools.lru_cache()
+    @lru_cache(maxsize=128)
     def username(self):
         """The current user's username."""
         return self.users.list_me().username

civis/cli/__main__.py

@@ -7,6 +7,7 @@
 which has an Apache 2.0 License:
 https://github.com/zalando/openapi-cli-client/blob/master/LICENSE
 """
+from __future__ import print_function
 
 
 import calendar
@@ -25,6 +26,7 @@
 import yaml
 from civis.cli._cli_commands import \
     civis_ascii_art, files_download_cmd, files_upload_cmd
+from civis.compat import FileNotFoundError
 
 
 _REPLACEABLE_COMMAND_CHARS = re.compile(r'[^A-Za-z0-9]+')
@@ -130,11 +132,15 @@ def param_case_map(param_names):
     return result
 
 
-def invoke(method, path, op, *args, json_output=False, **kwargs):
-
+def invoke(method, path, op, *args, **kwargs):
+    """
+    If json_output is in `kwargs` then the output is json. Otherwise, it is
+    yaml.
+    """
     # Remove None b/c click passes everything in as None if it's not set.
     kwargs = {k: v for k, v in kwargs.items()
               if v is not None}
+    json_output = kwargs.pop('json_output', False)
 
     # Construct the body of the request.
     body = {}

civis/compat.py

@@ -0,0 +1,17 @@
+# flake8: noqa
+
+import six
+
+if six.PY3:
+    from unittest import mock
+    from functools import lru_cache
+    from inspect import signature
+    FileNotFoundError = FileNotFoundError
+else:
+    try:
+        import mock
+    except ImportError:  # dev dependency
+        pass
+    from functools32 import lru_cache
+    from funcsigs import signature
+    FileNotFoundError = IOError

civis/futures.py

@@ -1,3 +1,7 @@
+from __future__ import absolute_import
+
+from builtins import super
+
 from civis import APIClient
 from civis.base import DONE
 from civis.polling import PollableResult

civis/io/__init__.py

@@ -1,3 +1,5 @@
-from ._databases import query_civis, transfer_table  # NOQA
-from ._files import *  # NOQA
-from ._tables import *  # NOQA
+from __future__ import absolute_import
+
+from civis.io._databases import query_civis, transfer_table  # NOQA
+from civis.io._files import *  # NOQA
+from civis.io._tables import *  # NOQA

civis/io/_databases.py

@@ -1,3 +1,5 @@
+from __future__ import absolute_import
+
 from civis import APIClient
 from civis._utils import maybe_get_random_name
 from civis.futures import CivisFuture

civis/io/_files.py

@@ -4,12 +4,14 @@
 import logging
 import os
 import re
+import six
 
 import requests
 from requests import HTTPError
 
 from civis import APIClient, find_one
 from civis.base import CivisAPIError, EmptyResultError
+from civis.compat import FileNotFoundError
 from civis.utils._deprecation import deprecate_param
 try:
     from requests_toolbelt.multipart.encoder import MultipartEncoder
@@ -227,8 +229,8 @@ def file_id_from_run_output(name, job_id, run_id, regex=False, client=None):
         outputs = client.scripts.list_containers_runs_outputs(job_id, run_id)
     except CivisAPIError as err:
         if err.status_code == 404:
-            raise IOError('Could not find job/run ID {}/{}'
-                          .format(job_id, run_id)) from err
+            six.raise_from(IOError('Could not find job/run ID {}/{}'
+                           .format(job_id, run_id)), err)
         else:
             raise
 

civis/io/_tables.py

@@ -1,6 +1,7 @@
 import json
 import csv
 import io
+import six
 import warnings
 
 from civis import APIClient
@@ -513,8 +514,11 @@ def dataframe_to_civis(df, database, table, api_key=None, client=None,
     if archive:
         warnings.warn("`archive` is deprecated and will be removed in v2.0.0. "
                       "Use `hidden` instead.", FutureWarning)
-    buf = io.BytesIO()
-    txt = io.TextIOWrapper(buf, encoding='utf-8')
+    buf = six.BytesIO()
+    if six.PY3:
+        txt = io.TextIOWrapper(buf, encoding='utf-8')
+    else:
+        txt = buf
     df.to_csv(txt, encoding='utf-8', index=False, **kwargs)
     txt.flush()
     buf.seek(0)