Merge pull request #73 from jayvdb/blacken

Lint with black & pyflakes

Author: ctrueden

.github/workflows/build.yml

@@ -35,8 +35,12 @@ jobs:
         pip install -e .
     - name: Install pytest
       run: |
-        mamba install -c conda-forge pytest
+        mamba install -c conda-forge black pyflakes pytest
     - name: Test with pytest
       run: |
         pytest
-
+    - name: Lint with pyflakes and black
+      shell: bash
+      run: |
+        pyflakes jgo/*.py
+        black --check .

jgo/__init__.py

@@ -4,3 +4,11 @@
     maven_scijava_repository,
     add_jvm_args_as_necessary,
 )
+
+__all__ = (
+    "add_jvm_args_as_necessary",
+    "main_from_endpoint",
+    "main",
+    "maven_scijava_repository",
+    "resolve_dependencies",
+)

jgo/jgo.py

@@ -8,7 +8,6 @@
 import shutil
 import subprocess
 import sys
-import traceback
 import zipfile
 import hashlib
 
@@ -132,10 +131,11 @@ def dependency_string(self):
         return xml
 
     def get_coordinates(self):
-        return ([self.groupId, self.artifactId]
+        return (
+            [self.groupId, self.artifactId]
             + ([self.version] if self.version != Endpoint.VERSION_MANAGED else [])
             + ([self.classifier] if self.classifier else [])
-            )
+        )
 
     def is_endpoint(string):
         endpoint_elements = (
@@ -215,7 +215,7 @@ def link(source, link_name, link_type="auto"):
                 raise e
         try:
             return link(source=source, link_name=link_name, link_type="soft")
-        except OSError as e:
+        except OSError:
             pass
 
         return link(source=source, link_name=link_name, link_type="copy")
@@ -232,17 +232,6 @@ def m2_path():
     return os.getenv("M2_REPO", (pathlib.Path.home() / ".m2").absolute())
 
 
-def expand(string, **shortcuts):
-
-    for (k, v) in shortcuts.items():
-        if string in k:
-            return "{}{}".format(
-                v,
-            )
-
-    return string
-
-
 def launch_java(
     jar_dir,
     jvm_args,
@@ -297,7 +286,12 @@ def find_endpoint(argv, shortcuts={}):
 
 
 def jgo_parser(log_levels=_default_log_levels):
-
+    usage = (
+        "usage: jgo [-v] [-u] [-U] [-m] [-q] [--log-level] [--ignore-jgorc]\n"
+        "           [--link-type type] [--additional-jars jar [jar ...]]\n"
+        "           [--additional-endpoints endpoint [endpoint ...]]\n"
+        "           [JVM_OPTIONS [JVM_OPTIONS ...]] <endpoint> [main-args]"
+    )
     epilog = """
 The endpoint should have one of the following formats:
 
@@ -315,10 +309,7 @@ def jgo_parser(log_levels=_default_log_levels):
 
     parser = argparse.ArgumentParser(
         description="Run Java main class from Maven coordinates.",
-        usage="jgo [-v] [-u] [-U] [-m] [-q] [--log-level] [--ignore-jgorc]\n" +
-              "           [--link-type type] [--additional-jars jar [jar ...]]\n" +
-              "           [--additional-endpoints endpoint [endpoint ...]]\n" +
-              "           [JVM_OPTIONS [JVM_OPTIONS ...]] <endpoint> [main-args]",
+        usage=usage[len("usage: ") :],
         epilog=epilog,
         formatter_class=argparse.RawTextHelpFormatter,
     )
@@ -378,8 +369,8 @@ def jgo_parser(log_levels=_default_log_levels):
         "--link-type",
         default=None,
         type=str,
-        help="How to link from local Maven repository into jgo cache.\n" +
-             "Defaults to the `links' setting in ~/.jgorc or 'auto' if not specified.",
+        help="How to link from local Maven repository into jgo cache.\n"
+        + "Defaults to the `links' setting in ~/.jgorc or 'auto' if not specified.",
         choices=("hard", "soft", "copy", "auto"),
     )
     parser.add_argument(
@@ -656,7 +647,7 @@ def resolve_dependencies(
         if e.stderr:
             err_lines += e.stderr.decode().splitlines()
         for l in err_lines:
-            if l.startswith('[ERROR]'):
+            if l.startswith("[ERROR]"):
                 _logger.error("\t%s", l)
             else:
                 _logger.debug("\t%s", l)
@@ -703,8 +694,8 @@ def resolve_dependencies(
                     jar_file_in_workspace,
                     link_type=link_type,
                 )
-            except FileExistsError as e:
-                # Do not throw exceptionif target file exists.
+            except FileExistsError:
+                # Do not throw exception if target file exists.
                 pass
     pathlib.Path(build_success_file).touch(exist_ok=True)
     return primary_endpoint, workspace

jgo/util.py

@@ -22,10 +22,10 @@ def add_jvm_args_as_necessary(argv, gc_option="-XX:+UseConcMarkSweepGC"):
             return argv
 
     total_memory = psutil.virtual_memory().total
-    exponent = 3 if total_memory > 2 * 1024 ** 3 else 2
+    exponent = 3 if total_memory > 2 * 1024**3 else 2
     memory_unit = "G" if exponent == 3 else "M"
     max_heap_size = "{}{}".format(
-        max(total_memory // (1024 ** exponent) // 2, 1), memory_unit
+        max(total_memory // (1024**exponent) // 2, 1), memory_unit
     )
 
     argv = ["-Xmx{}".format(max_heap_size)] + argv

setup.py

@@ -17,9 +17,7 @@
     license="Public domain",
     url="https://github.com/scijava/jgo",
     packages=["jgo"],
-    test_suite="nose.collector",
     entry_points={"console_scripts": ["jgo=jgo:main"]},
-    python_requires='>=3.6',
+    python_requires=">=3.6",
     install_requires=["psutil"],
-    tests_require=["nose>=1.0"],
 )

tests/test_managed.py

@@ -1,7 +1,6 @@
 import glob
 from jgo.jgo import InvalidEndpoint
 import jgo
-import re
 import os
 import pathlib
 import unittest
@@ -33,6 +32,7 @@ def resolve_managed(endpoint, cache_dir, m2_repo):
         repositories=REPOSITORIES,
     )
 
+
 def find_jar_matching(jars, pattern):
     for jar in jars:
         lastindex = jar.rindex(os.sep)
@@ -51,13 +51,13 @@ def test_resolve_managed(self):
             )
             jars = glob.glob(os.path.join(workspace, "*jar"))
             self.assertEqual(len(jars), 4, "Expected four jars in workspace")
-            sj_common_jar = find_jar_matching(jars, 'scijava-common')
+            sj_common_jar = find_jar_matching(jars, "scijava-common")
             self.assertEqual(
                 sj_common_jar,
                 os.path.join(workspace, "scijava-common-%s.jar" % SJC_VERSION),
                 "Expected scijava-common jar",
             )
-            sj_optional_jar = find_jar_matching(jars, 'scijava-optional')
+            sj_optional_jar = find_jar_matching(jars, "scijava-optional")
             self.assertEqual(
                 sj_optional_jar,
                 os.path.join(
@@ -66,8 +66,13 @@ def test_resolve_managed(self):
                 "Expected scijava-optional jar",
             )
 
-            pom = (
-                    os.path.join(tmp_dir, 'org.scijava', 'scijava-common', SJC_VERSION, 'd9deda31e3772a497c66ee3593296f33e918cda69b376c33039ba181dab14db4', 'pom.xml')
+            pom = os.path.join(
+                tmp_dir,
+                "org.scijava",
+                "scijava-common",
+                SJC_VERSION,
+                "d9deda31e3772a497c66ee3593296f33e918cda69b376c33039ba181dab14db4",
+                "pom.xml",
             )
             with open(pom) as f:
                 if "RELEASE" in f.read():
@@ -81,7 +86,7 @@ def test_managed_primary(self):
         tmp_dir = tempfile.mkdtemp(prefix="jgo-test-cache-dir")
         m2_repo = os.path.join(str(pathlib.Path.home()), ".m2", "repository")
         try:
-            with self.assertRaises(InvalidEndpoint) as context:
+            with self.assertRaises(InvalidEndpoint):
                 resolve_managed(
                     MANAGED_PRIMARY_ENDPOINT, cache_dir=tmp_dir, m2_repo=m2_repo
                 )

tests/test_parsington.py

@@ -1,5 +1,4 @@
 import glob
-import io
 import jgo
 import os
 import pathlib

tox.ini

@@ -1,5 +1,6 @@
 [tox]
 envlist =
+    py3{6,7,8,9,10}
     lint
 
 [testenv:lint]
@@ -8,3 +9,7 @@ deps =
 skip_install = true
 commands = black jgo/ tests/ setup.py
 description = Run black to reformat all code
+
+[testenv]
+deps = pytest
+commands = pytest {posargs}