switch to the Black code formatter (#269)

* add basic contributing guidelines
* prefer new style format strings
* sort the inputs

Author: mr-c

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+ignore = E203, E266, E501, W503, E211
+max-line-length = 88
+select = B,C,E,F,W,T4,B9
+per-file-ignores =
+  schema_salad/metaschema.py:B950
+  schema_salad/tests/*.py:B011

.isort.cfg

@@ -0,0 +1,6 @@
+[settings]
+multi_line_output=3
+include_trailing_comma=True
+force_grid_wrap=0
+use_parentheses=True
+line_length=88

.pylintrc

@@ -140,7 +140,9 @@ disable=print-statement,
         deprecated-sys-function,
         exception-escape,
         comprehension-escape,
-        useless-object-inheritance
+        useless-object-inheritance,
+	bad-continuation,
+        bad-whitespace
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

.travis.yml

@@ -30,6 +30,9 @@ jobs:
     - stage: release-test
       python: "2.7"
       script: RELEASE_SKIP=head PYVER= ${TRAVIS_BUILD_DIR}/release-test.sh
+    - stage: release-test
+      python: "3.5"
+      script: RELEASE_SKIP=head PYVER=3.5 ${TRAVIS_BUILD_DIR}/release-test.sh
 script: tox
 branches:
   only:

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+Style guide:
+- Python 2.7 + Python 3.5+ compatible code
+- PEP-484 type hints, in comments for Python 2.7 compatability
+- Prefer new style format strings https://pyformat.info/
+- Use ``make format`` to format the your code
+
+In order to contribute to the development of ``schema-salad``, you need to install it from source (preferably in a virtual environment):
+Here's a rough guide (improvements are welcome!)
+- Install virtualenv via pip: ``pip install virtualenv``
+- Clone the code repository locally: ``git clone https://github.com/common-workflow-language/schema_salad.git``
+- Switch to cwltool directory: ``cd schema_salad``
+- Create a virtual Python environment: ``virtualenv env``
+- To begin using the Python virtual environment, it needs to be activated: ``source env/bin/activate``
+- To check if you have the Python virtual environment set up: ``which python`` and it should point to python executable in your virtual env
+- Install schema-salad in the Python virtual environment: ``pip install .``
+- Check the version which might be different from the version installed in general on any system: ``schema-salad-tool --version``
+- After you've made the changes, you can the complete test suite via tox: ``tox``
+	- If you want to run specific tests, say ``unit tests`` in Python 3.5, then: ``tox -e py35-unit``.
+	- Look at ``tox.ini`` for all available tests and runtimes
+- If tests are passing, you can simply commit and create a PR on ``schema_salad`` repo:
+- After you're done working, you can deactivate the virtual environment: ``deactivate``

Makefile

@@ -15,8 +15,7 @@
 #
 # Contact: [email protected]
 
-# make pycodestyle to check for basic Python code compliance
-# make autopep8 to fix most pep8 errors
+# make format to fix most python formatting errors
 # make pylint to check Python code for enhanced compliance including naming
 #  and documentation
 # make coverage-report to check coverage of the python scripts by the tests
@@ -27,7 +26,8 @@ PACKAGE=schema-salad
 # `SHELL=bash` doesn't work for some, so don't use BASH-isms like
 # `[[` conditional expressions.
 PYSOURCES=$(wildcard ${MODULE}/**.py tests/*.py) setup.py
-DEVPKGS=pycodestyle diff_cover autopep8 pylint coverage pep257 pytest-xdist flake8
+DEVPKGS=diff_cover black pylint coverage pep257 pytest-xdist \
+	flake8 flake8-bugbear
 COVBASE=coverage run --branch --append --source=${MODULE} \
 	--omit=schema_salad/tests/*
 
@@ -73,19 +73,6 @@ clean: FORCE
 sort_imports:
 	isort ${MODULE}/*.py ${MODULE}/tests/*.py setup.py
 
-pep8: pycodestyle
-## pycodestyle        : check Python code style
-pycodestyle: $(PYSOURCES)
-	pycodestyle --exclude=_version.py  --show-source --show-pep8 $^ || true
-
-pep8_report.txt: pycodestyle_report.txt
-pycodestyle_report.txt: $(PYSOURCES)
-	pycodestyle --exclude=_version.py $^ > $@ || true
-
-diff_pep8_report: diff_pycodestyle_report
-diff_pycodestyle_report: pycodestyle_report.txt
-	diff-quality --violations=pycodestyle $^
-
 pep257: pydocstyle
 ## pydocstyle      : check Python code style
 pydocstyle: $(PYSOURCES)
@@ -97,14 +84,9 @@ pydocstyle_report.txt: $(PYSOURCES)
 diff_pydocstyle_report: pydocstyle_report.txt
 	diff-quality --violations=pycodestyle --fail-under=100 $^
 
-## autopep8    : fix most Python code indentation and formatting
-autopep8: $(PYSOURCES)
-	autopep8 --recursive --in-place --ignore E309 $^
-
-# A command to automatically run astyle and autopep8 on appropriate files
-## format      : check/fix all code indentation and formatting (runs autopep8)
-format: autopep8
-	# Do nothing
+## format      : check/fix all code indentation and formatting (runs black)
+format:
+	black --target-version py27 schema_salad
 
 ## pylint      : run static code analysis on Python code
 pylint: $(PYSOURCES)
@@ -206,7 +188,7 @@ jenkins: FORCE
 	. env/bin/activate ; \
 	pip install -U setuptools pip wheel ; \
 	${MAKE} install-dep coverage.html coverage.xml pydocstyle_report.txt \
-		sloccount.sc pycodestyle_report.txt pylint_report.txt
+		sloccount.sc pylint_report.txt
 	if ! test -d env3 ; then virtualenv -p python3 env3 ; fi
 	. env3/bin/activate ; \
 	pip install -U setuptools pip wheel ; \

gittaggers.py

@@ -1,15 +1,23 @@
 import subprocess
 import time
-
+import pkg_resources
 from setuptools.command.egg_info import egg_info
 
+SETUPTOOLS_VER = pkg_resources.get_distribution(
+    "setuptools").version.split('.')
+
+RECENT_SETUPTOOLS = int(SETUPTOOLS_VER[0]) > 40 or (
+    int(SETUPTOOLS_VER[0]) == 40 and int(SETUPTOOLS_VER[1]) > 0) or (
+        int(SETUPTOOLS_VER[0]) == 40 and int(SETUPTOOLS_VER[1]) == 0 and
+        int(SETUPTOOLS_VER[2]) > 0)
 
 class EggInfoFromGit(egg_info):
     """Tag the build with git commit timestamp.
 
     If a build tag has already been set (e.g., "egg_info -b", building
     from source package), leave it alone.
     """
+
     def git_timestamp_tag(self):
         gitinfo = subprocess.check_output(
             ['git', 'log', '--first-parent', '--max-count=1',
@@ -20,7 +28,9 @@ def tags(self):
         if self.tag_build is None:
             try:
                 self.tag_build = self.git_timestamp_tag()
-            except (subprocess.CalledProcessError, OSError):
+            except subprocess.CalledProcessError:
                 pass
         return egg_info.tags(self)
-    vtags = property(tags)
+
+    if RECENT_SETUPTOOLS:
+        vtags = property(tags)

release-test.sh

@@ -8,8 +8,8 @@ module=schema_salad
 slug=${TRAVIS_PULL_REQUEST_SLUG:=common-workflow-language/schema_salad}
 repo=https://github.com/${slug}.git
 run_tests="bin/py.test --pyargs ${module}"
-pipver=8.0.1 # minimum required version of pip
-setupver=20.10.1 # minimum required version of setuptools
+pipver=18 # minimum required version of pip
+setupver=40.3 # minimum required version of setuptools
 PYVER=${PYVER:=2.7}
 
 rm -Rf "testenv${PYVER}_"? || /bin/true
@@ -22,10 +22,10 @@ then
 	# First we test the head
 	# shellcheck source=/dev/null
 	source "testenv${PYVER}_1/bin/activate"
-	rm "testenv${PYVER}_1/lib/python-wheels/setuptools"* \
-		&& pip install --force-reinstall -U pip==${pipver} \
-	        && pip install setuptools==${setupver} wheel
-	make install-dependencies
+	rm -f "testenv${PYVER}_1/lib/python-wheels/setuptools"*
+	pip install --force-reinstall -U pip==${pipver}
+	pip install setuptools==${setupver} wheel
+	pip install pytest\<5 pytest-xdist -rrequirements.txt
 	make test
 	pip uninstall -y ${package} || true; pip uninstall -y ${package} \
 		|| true; make install
@@ -56,7 +56,7 @@ rm lib/python-wheels/setuptools* \
 # The following can fail if you haven't pushed your commits to ${repo}
 pip install -e "git+${repo}@${HEAD}#egg=${package}"
 pushd src/${package}
-make install-dependencies
+pip install pytest\<5 pytest-xdist
 make dist
 make test
 cp dist/${package}*tar.gz "../../../testenv${PYVER}_3/"

schema_salad/__init__.py

@@ -1,14 +1,8 @@
 from __future__ import absolute_import
-import logging
-import os
-import sys
-import typing
-import threading
 
-import six
+import logging
 
-from .utils import onWindows
-__author__ = '[email protected]'
+__author__ = "[email protected]"
 
 _logger = logging.getLogger("salad")
 _logger.addHandler(logging.StreamHandler())

schema_salad/avro/__init__.py

@@ -14,4 +14,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__all__ = ['schema']
+__all__ = ["schema"]