api: py37 support and rename async to async_ (#604)

Breaking change as is renames all async parameters to async_
in order to assure python 3.7 compatibility.

Fixes: #603

Signed-off-by: Sorin Sbarnea <[email protected]>

Author: ssbarnea

.travis.yml

@@ -5,7 +5,6 @@ cache:
   - directories:
       - "node_modules"
       - $HOME/.cache
-sudo: false
 os:
   - linux
 stages:
@@ -14,11 +13,20 @@ stages:
   - test
   - deploy
 before_install:
-  - which tox >/dev/null || if [ -z ${VIRTUAL_ENV+x} ]; then pip install --user tox ; else pip install tox; fi
+  # begin: workaround to enable support for py37:
+  # - curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
+  # - sudo apt-get install -y nodejs
+  # - curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+  # - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+  # - sudo apt-get update && sudo apt-get install yarn
+  # - if [[ $TRAVIS_PYTHON_VERSION == '3.7-dev' ]]; then sudo add-apt-repository ppa:deadsnakes/ppa -y; fi
+  # - if [[ $TRAVIS_PYTHON_VERSION == '3.7-dev' ]]; then sudo apt-get update; fi
+  - nvm install $TRAVIS_NODE_VERSION
+  # end
+  - which tox >/dev/null || if [ -z ${VIRTUAL_ENV+x} ]; then pip install --user tox tox-pyenv ; else pip install tox tox-pyenv; fi
 notifications:
   email:
     - [email protected]
-    - [email protected]
 jobs:
   include:
     - stage: lint
@@ -59,6 +67,16 @@ jobs:
       env: TOXENV=py36 PYTHON='3.6' PYENV_VERSION='system'
       after_success:
         - bash <(curl -s https://codecov.io/bash) -e TOX_ENV
+    - stage: test
+      script: pip install -q tox-travis && python -m tox
+      python: "3.7"
+      env: TOXENV=py37 PYTHON='3.7'
+      after_success:
+        - bash <(curl -s https://codecov.io/bash) -e TOX_ENV
+      # begin: workaround to enable support for py37:
+      sudo: required
+      dist: xenial
+      # end
     - stage: deploy
       script:
         - export PACKAGE_NAME=$(python setup.py --name)
@@ -92,3 +110,4 @@ env:
     - secure: fuXwQL+KHQ96XkAFl2uQc8eK8dAjrgkup46tck/UGjVpdv1PT/yHmBKrvpFjDa50ueGbtBwTdKAwhyAmYuiZCk2IYHzdvBylCZBBji2FSpaTM59CVwgkVT6tx3HHO83X0mEX6ih9TJvZD5XhX+YUjopnseRXRq3ey3JZJXWN4RM=
     - secure: "pGQGM5YmHvOgaKihOyzb3k6bdqLQnZQ2OXO9QrfXlXwtop3zvZQi80Q+01l230x2psDWlwvqWTknAjAt1w463fYXPwpoSvKVCsLSSbjrf2l56nrDqnoir+n0CBy288+eIdaGEfzcxDiuULeKjlg08zrqjcjLjW0bDbBrlTXsb5U="
     - PIP_DISABLE_PIP_VERSION_CHECK=1
+    - TRAVIS_NODE_VERSION="v8.11.3"

cspell.json

@@ -152,6 +152,7 @@
         "workon",
         "xargs",
         "xdist",
+        "xenial",
         "xfail",
         "xscs",
         "xsrf",

jira/client.py

@@ -291,7 +291,7 @@ class JIRA(object):
         as anonymous it will fail to instantiate.
     :param get_server_info: If true it will fetch server version info first to determine if some API calls
         are available.
-    :param async: To enable async requests for those actions where we implemented it, like issue update() or delete().
+    :param async_: To enable asynchronous requests for those actions where we implemented it, like issue update() or delete().
     :param timeout: Set a read/connect timeout for the underlying calls to JIRA (default: None)
         Obviously this means that you cannot rely on the return code when this is enabled.
     """
@@ -325,7 +325,7 @@ class JIRA(object):
     AGILE_BASE_URL = GreenHopperResource.AGILE_BASE_URL
 
     def __init__(self, server=None, options=None, basic_auth=None, oauth=None, jwt=None, kerberos=False, kerberos_options=None,
-                 validate=False, get_server_info=True, async=False, logging=True, max_retries=3, proxies=None,
+                 validate=False, get_server_info=True, async_=False, logging=True, max_retries=3, proxies=None,
                  timeout=None, auth=None):
         """Construct a JIRA client instance.
 
@@ -373,7 +373,7 @@ def __init__(self, server=None, options=None, basic_auth=None, oauth=None, jwt=N
             as anonymous it will fail to instantiate.
         :param get_server_info: If true it will fetch server version info first to determine if some API calls
             are available.
-        :param async: To enable async requests for those actions where we implemented it, like issue update() or delete().
+        :param async_: To enable async requests for those actions where we implemented it, like issue update() or delete().
         :param timeout: Set a read/connect timeout for the underlying calls to JIRA (default: None)
         Obviously this means that you cannot rely on the return code when this is enabled.
         :param auth: Set a cookie auth token if this is required.
@@ -393,8 +393,8 @@ def __init__(self, server=None, options=None, basic_auth=None, oauth=None, jwt=N
 
         if server:
             options['server'] = server
-        if async:
-            options['async'] = async
+        if async_:
+            options['async'] = async_
 
         self.logging = logging
 
@@ -657,12 +657,12 @@ def find(self, resource_format, ids=None):
         return resource
 
     def async_do(self, size=10):
-        """Execute all async jobs and wait for them to finish. By default it will run on 10 threads.
+        """Execute all asynchronous jobs and wait for them to finish. By default it will run on 10 threads.
 
         :param size: number of threads to run on.
         """
         if hasattr(self._session, '_async_jobs'):
-            logging.info("Executing async %s jobs found in queue by using %s threads..." % (
+            logging.info("Executing asynchronous %s jobs found in queue by using %s threads..." % (
                 len(self._session._async_jobs), size))
             threaded_requests.map(self._session._async_jobs, size=size)
 
@@ -3377,8 +3377,8 @@ def move_to_backlog(self, issue_keys):
 
 class GreenHopper(JIRA):
 
-    def __init__(self, options=None, basic_auth=None, oauth=None, async=None):
+    def __init__(self, options=None, basic_auth=None, oauth=None, async_=None):
         warnings.warn(
             "GreenHopper() class is deprecated, just use JIRA() instead.", DeprecationWarning)
         JIRA.__init__(
-            self, options=options, basic_auth=basic_auth, oauth=oauth, async=async)
+            self, options=options, basic_auth=basic_auth, oauth=oauth, async_=async_)

jira/resources.py

@@ -204,17 +204,17 @@ def _get_url(self, path):
         options.update({'path': path})
         return self._base_url.format(**options)
 
-    def update(self, fields=None, async=None, jira=None, notify=True, **kwargs):
+    def update(self, fields=None, async_=None, jira=None, notify=True, **kwargs):
         """Update this resource on the server.
 
         Keyword arguments are marshalled into a dict before being sent. If this
         resource doesn't support ``PUT``, a :py:exc:`.JIRAError` will be raised; subclasses that specialize this method
         will only raise errors in case of user error.
 
-        :param async: if true the request will be added to the queue so it can be executed later using async_run()
+        :param async_: if true the request will be added to the queue so it can be executed later using async_run()
         """
-        if async is None:
-            async = self._options['async']
+        if async_ is None:
+            async_ = self._options['async']
 
         data = {}
         if fields is not None:
@@ -282,7 +282,7 @@ def update(self, fields=None, async=None, jira=None, notify=True, **kwargs):
                 #    logging.warning("autofix: setting assignee to '%s' and retrying the update." % self._options['autofix'])
                 #    data['fields']['assignee'] = {'name': self._options['autofix']}
             # EXPERIMENTAL --->
-            if async:
+            if async_:
                 if not hasattr(self._session, '_async_jobs'):
                     self._session._async_jobs = set()
                 self._session._async_jobs.add(threaded_requests.put(
@@ -431,7 +431,7 @@ def __init__(self, options, session, raw=None):
         if raw:
             self._parse_raw(raw)
 
-    def update(self, fields=None, update=None, async=None, jira=None, notify=True, **fieldargs):
+    def update(self, fields=None, update=None, async_=None, jira=None, notify=True, **fieldargs):
         """Update this issue on the server.
 
         Each keyword argument (other than the predefined ones) is treated as a field name and the argument's value
@@ -481,7 +481,7 @@ def update(self, fields=None, update=None, async=None, jira=None, notify=True, *
             else:
                 fields_dict[field] = value
 
-        super(Issue, self).update(async=async, jira=jira, notify=notify, fields=data)
+        super(Issue, self).update(async_=async_, jira=jira, notify=notify, fields=data)
 
     def add_field_value(self, field, value):
         """Add a value to a field that supports multiple values, without resetting the existing values.
@@ -526,7 +526,7 @@ def __init__(self, options, session, raw=None):
         if raw:
             self._parse_raw(raw)
 
-    def update(self, fields=None, async=None, jira=None, body='', visibility=None):
+    def update(self, fields=None, async_=None, jira=None, body='', visibility=None):
         data = {}
         if body:
             data['body'] = body

package.json

@@ -1,6 +1,7 @@
 {
   "name": "python-jira",
   "version": "0.0.1",
+  "license": "SEE LICENSE IN LICENSE",
   "scripts": {
     "spell": "npm -s run spell-files && npm -s run spell-commit",
     "spell-commit": "git log -1 --pretty=%B > .git/commit.msg && cspell .git/commit.msg",
@@ -11,6 +12,7 @@
     "url": "https://github.com/pycontribs/jira.git"
   },
   "dependencies": {
-    "cspell": "^2.1.12"
+    "cspell": "^2.1.12",
+    "npm": "^6.1.0"
   }
 }

requirements-dev.txt

@@ -13,6 +13,9 @@ pytest-cov
 pytest-instafail
 pytest-xdist>=1.14
 pytest>=2.9.1
+PyYAML>=3.12,<4; python_version<'3.7'
+# this file is needed by readthedocs.org so don't move them in another place
+PyYAML>=4.2b2; python_version>='3.7'
 requires.io
 tenacity
 tox-pyenv

setup.cfg

@@ -43,7 +43,8 @@ packages =
 #[options.extras_require]
 [extras]
 cli =
-    ipython>=4.0.0
+    ipython>=4.0.0,<6.0.0; python_version<'3.3'
+    ipython>=4.0.0; python_version>='3.3'
 opt =
     filemagic>=1.6
     PyJWT

tests/tests.py

@@ -1967,7 +1967,7 @@ class AsyncTests(unittest.TestCase):
 
     def setUp(self):
         self.jira = JIRA('https://jira.atlassian.com', logging=False,
-                         async=True, validate=False, get_server_info=False)
+                         async_=True, validate=False, get_server_info=False)
 
     def test_fetch_pages(self):
         """Tests that the JIRA._fetch_pages method works as expected. """

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 minversion = 2.3.1
-envlist = lint,py27,py34,py35,py36,docs
+envlist = lint,py27,py37,py36,py35,py34,docs
 skip_missing_interpreters = true
 
 [testenv:docs]
@@ -20,11 +20,9 @@ deps =
 extras =
     cli
     opt
-# sitepackages is needed in order to make --user work
-# see https://github.com/pypa/pip/issues/4141#issuecomment-272907550
-sitepackages=True
-
+sitepackages=False
 commands=
+    bash -c 'find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf'
     python -m pip check
     python -m pytest {posargs}
 passenv =
@@ -35,10 +33,14 @@ passenv =
     TRAVIS_*
     XDG_CACHE_HOME
 envars =
-    PIP_DISABLE_PIP_VERSON_CHECK=1
+    PIP_DISABLE_PIP_VERSION_CHECK=1
     PIP_USER=no
 whitelist_externals =
     bash
+    find
+    grep
+    rm
+    xargs
 
 [testenv:lint]
 commands=