Added support for Python3.10 (CADC-11161) (#208)

* Added support for Python3.10 and removed support for Python2.7

Author: Adrian

.github/workflows/cibuild.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install tox
         run: python -m pip install --upgrade tox
       - name: egg-info vos
@@ -31,8 +31,7 @@ jobs:
       fail-fast: true
       matrix:
         #TODO 2.7 fails on GH Actions but cannot be reproduced locally. Disabled for now.
-        # python-version: [2.7,3.5,3.6,3.7,3.8,3.9]
-        python-version: [3.5,3.6,3.7,3.8,3.9]
+        python-version: ["3.5", "3.6", "3.7", "3.8", "3.9", "3.10"]
         package: [vos, vofs]
     steps:
     - name: Checkout code
@@ -58,10 +57,10 @@ jobs:
     needs: tests
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Setup Graphviz
         uses: ts-graphviz/setup-graphviz@v1
       - name: Install tox

README.rst

@@ -13,3 +13,78 @@ VOS - VOSpace tools
 .. image:: https://img.shields.io/github/contributors/opencadc/vostools.svg
     :target: https://github.com/opencadc/vostools/graphs/contributors
 
+
+Tools to work with VOSpace services (primarily the CADC ones)..
+
+
+Developers Guide
+================
+
+
+Requires pip.
+
+Installing Packages
+-------------------
+Note: might need to escape chars in your shell
+
+::
+
+    cd vos && pip install -e .[test]
+    cd vofs && pip install -e .[test]
+
+Testing packages
+----------------
+
+Testing vos
+~~~~~~~~~~~
+
+::
+
+    cd ./vos
+    pytest vos
+
+Testing vofs
+~~~~~~~~~~~~
+
+::
+
+    cd ./vofs
+    pytest vofs
+
+
+
+Checkstyle
+~~~~~~~~~~
+flake8 style checking is enforced on pull requests. Following commands should
+not report errors
+
+::
+
+     flake8 vos/vos vofs/vofs
+
+
+Testing with tox
+~~~~~~~~~~~~~~~~
+
+If tox, the generic virtual environment tool, is available it can be used to test with different versions of
+python is isolation. For example, to test on all supported versions of Python in cadcdata (assuming that
+they are available in the system):
+
+::
+
+    cd ./vos && tox
+
+To test a specific version:
+
+::
+
+    cd ./vos && tox -e py3.9
+
+
+To list all the available environments:
+
+::
+
+    cd ./vos && tox -a
+
+

vofs/README.rst

@@ -70,82 +70,13 @@ Tutorial
       of your unix users IDs and thus files appear to be owned by the
       user who issued the 'mountvofs' command.*
 
-Development
------------
-
-A virtual environment (**venv**) is recommended to set up external
-dependencies without installing them system-wide. Following `these
-instructions <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__,
-install **virtualenv**:
-
-::
-
-    $ pip install virtualenv
-
-Next, create, and activate a local **venv** (this example uses
-**bash**):
-
-::
-
-    $ virtualenv venv
-    $ source venv/bin/activate
-
-Setup the new development environment for testing by installing the
-appropriate packages:
-
-::
-
-    $ pip install -r dev_requirements.txt
-
-The test environment is built into the *setup.py* so that conducting
-unit-tests can be achieved like so:
-
-::
-
-    python setup.py test
-
-If you would like versbose output formated as a web page, for example,
-you can add options to the test call:
-
-::
-
-    python setup.py test --addopts '--cov-report html:cov_html --cov=vosfs'
-
-The same option attribute can be used to pass other arguments to py.test
-that is executing the test. To run specific only tests for example:
-
-::
-
-    python setup.py test --addopts 'vos/test/Test_vos.py::TestClient::test_transfer_error'
-
-Each time you resume work on the project and want to use the **venv**
-(e.g., from a new shell), simply re-activate it:
-
-::
-
-    $ source venv/bin/activate
-
-When done, just issue a
-
-::
-
-    $ deactivate
-
-command to deactivate the virtual environment.
 
 Integration Tests
 ~~~~~~~~~~~~~~~~~
 
 The integration tests are, at present, designed to run only with the
 CADC VOSpace. Tests assume that the vofs package has been installed.
 
-Activate the **venv** and install vofs
-
-::
-
-    $ source venv/bin/activate.csh
-    $ pip install vofs
-
 Run the tests:
 
 \`\`\` $ ./test/scripts/vospace-mountvospace-atest.tcsh

vofs/dev_requirements.txt

@@ -49,9 +49,20 @@ license = AGPLv3
 url = https://www.canfar.net/en/docs/storage 
 edit_on_github = False
 github_project = opencadc/vostools
-install_requires = vos>=3.1.2 BitVector>=3.4.4,<4.0 fusepy>=2.0.4
+install_requires =
+    vos>=3.3.7
+    BitVector>=3.4.4,<4.0
+    fusepy>=2.0.4
 # version should be PEP440 compatible (http://www.python.org/dev/peps/pep-0440)
-version = 3.1a
+version = 3.1
+
+[options.extras_require]
+test =
+    pytest>=4.6
+    pytest-cov>=2.5.1
+    flake8>=3.4.1
+    future>=0.16.0
+    mock>=2.0.0
 
 [entry_points]
 #astropy-package-template-example = packagename.example_mod:main

vofs/setup.cfg

@@ -129,18 +129,14 @@ def run_tests(self):
       use_2to3=False,
       setup_requires=['pytest-runner'],
       entry_points=entry_points,
-      python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, <4',
+      python_requires='!=3.0.*, !=3.1.*, !=3.2.*, !=3.4, <4',
       packages=find_packages(),
       package_data={PACKAGENAME: ['data/*', 'tests/data/*', '*/data/*', '*/tests/data/*']},
       classifiers=[
         'Natural Language :: English',
         'License :: OSI Approved :: GNU Affero General Public License v3',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6'
       ],
       cmdclass = {
           'coverage': PyTest, 'intTest': PyIntTest, 'allTest': PyAllTest

vofs/setup.py

@@ -5,18 +5,21 @@ name = vofs
 
 [tox]
 envlist =
-    py{27,34,35,36,37,38,39}
+    py{34,35,36,37,38,39,310}
 requires =
     pip >= 19.3.1
 
 [testenv]
 description = run tests
 changedir = {toxinidir}
 passenv = HOME
-deps = -rdev_requirements.txt
+deps =
+    -e ../vos
 commands =
     pip freeze
     pytest {[package]name} 
+extras =
+    test
 
 [testenv:egg_info]
 description = ensure egg_info works without dependencies
@@ -27,7 +30,7 @@ commands =
 description = determine the code coverage
 deps:
     coverage>=4.5.4
-    -rdev_requirements.txt
+    -e ../vos
 commands =
     pytest {[package]name} --cov {[package]name} --cov-report xml --cov-config={toxinidir}/setup.cfg
 

vofs/tox.ini

@@ -9,7 +9,7 @@
 import ctypes
 from fuse import FuseOSError, fuse_operations
 from errno import EIO, EPERM, ENOENT
-import unittest2 as unittest
+import unittest
 from mock import Mock, MagicMock, patch, ANY
 import vos
 from cadcutils import exceptions

vofs/vofs/tests/test_vofs.py

@@ -33,9 +33,7 @@ System Requirments
 
 -  A CANFAR VOSpace account (required for WRITE access, READ access can
    be anonymous)
--  fuse OR OSX-FUSE (see additional documentation, only required for
-   filesystem based access, not for command line or programmatic)
--  python2.6 or later
+-  python3.7 or later
 
 Installation
 ------------
@@ -83,82 +81,14 @@ Tutorial
           client = vos.Client()
           client.listdir('vos:jkavelaars')
 
-Development
------------
-
-A virtual environment (**venv**) is recommended to set up external
-dependencies without installing them system-wide. Following `these
-instructions <http://docs.python-guide.org/en/latest/dev/virtualenvs/>`__,
-install **virtualenv**:
-
-::
-
-    $ pip install virtualenv
-
-Next, create, and activate a local **venv** (this example uses
-**bash**):
-
-::
-
-    $ virtualenv venv
-    $ source venv/bin/activate
-
-
-Setup the new development environment for testing by installing the appropriate packages:
-
-::
-
-    $ pip install -r dev_requirements.txt
-
-The test environment is built into the *setup.py* so that conducting unit-tests can be achieved like so:
-
-::
-
-    $ python setup.py test
-
-If you would like versbose output formated as a web page, for example,
-you can add options to the test call:
-
-::
-
-    $ python setup.py test --addopts '--cov-report html:cov_html --cov=vos'
-
-The same option attribute can be used to pass other arguments to py.test
-that is executing the test. To run specific only tests for example:
-
-::
-
-    $ python setup.py test --addopts 'vos/test/Test_vos.py::TestClient::test_transfer_error'
-
-Each time you resume work on the project and want to use the **venv**
-(e.g., from a new shell), simply re-activate it:
-
-::
-
-    $ source venv/bin/activate
-
-When done, just issue a
-
-::
-
-    $ deactivate
-
-command to deactivate the virtual environment.
 
 Integration Tests
 ~~~~~~~~~~~~~~~~~
 
 The integration tests are, at present, designed to run only with the
-CADC VOSpace. Tests assume that vos and/or vofs packages have been
+CADC VOSpace and test accounts credentials. Tests assume that vos and/or vofs packages have been
 installed.
 
-Activate the **venv** and install vos
-
-::
-
-    $ source venv/bin/activate.csh
-    $ pip install vos
-
 Run the tests:
 
     $ ./test/scripts/vospace-all.tcsh