Add Black to Spotless check (#133)

Check Python file formatting using Spotless and Black.

* Use print() instead of print.

Black is complaining.

* Format Python code with black.

* Add black to CI.

* Modify black config.

* Format Python files.

* Use Black version 24.1.1.

* Apply spotless.

* Use pip to install Black on Travis CI.

* Upgrade Travis CI top Jammy.

* Use pip to install Black on GH Actions.

* Split Black and Python in GH Actions.

Was getting an error.

* Fix test.

Due to formatting.

* Try `requirements.txt`.

* Install Python dependencies on GH Actions.

* Explicitly install requirements on Travis CI.

* Change Black config.

* Remove direct Black calls.

Author: khatchad

.github/workflows/continuous-integration.yml

@@ -37,6 +37,13 @@ jobs:
         pushd ${{ runner.temp }}/IDE/com.ibm.wala.cast.lsp
         mvn clean install -B -q -DskipTests
         popd
+    - name: Install Python.
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+        cache: 'pip'
+    - name: Install Python dependencies.
+      run: pip install -r requirements.txt
     - name: Check formatting with spotless.
       run: mvn spotless:check -B
     - name: Build with Maven

.travis.yml

@@ -1,5 +1,5 @@
 os: linux
-dist: focal
+dist: jammy
 language: java
 jdk: openjdk11
 before_install:
@@ -15,6 +15,7 @@ install:
  - pushd /tmp/IDE/com.ibm.wala.cast.lsp
  - mvn clean install -B -q -DskipTests
  - popd
+ - pip install -r requirements.txt
 script:
  - mvn spotless:check -B
  - mvn -Dlogging.config.file=\${maven.multiModuleProjectDirectory}/logging.ci.properties clean verify -B

com.ibm.wala.cast.python.jython/data/annots1.py

@@ -1,3 +1,2 @@
 def greet(name: str, age: int) -> str:
-    print('Hello {0}, you are {1} years old'.format(name, age))
-
+    print("Hello {0}, you are {1} years old".format(name, age))

com.ibm.wala.cast.python.jython/data/except1.py

@@ -1,14 +1,14 @@
 import sys
 
 try:
-    f = open('myfile.txt')
+    f = open("myfile.txt")
     s = f.readline()
     i = int(s.strip())
 except IOError as e:
-    print "I/O error:"
-    print "{0}: {1}".format(e.errno, e.strerror)
+    print("I/O error:")
+    print("{0}: {1}".format(e.errno, e.strerror))
 except ValueError:
-    print "Could not convert data to an integer."
+    print("Could not convert data to an integer.")
 except:
-    print "Unexpected error:", sys.exc_info()[0]
+    print("Unexpected error:", sys.exc_info()[0])
     raise

com.ibm.wala.cast.python.jython3/data/annots1.py

@@ -1,3 +1,2 @@
 def greet(name: str, age: int) -> str:
-    print('Hello {0}, you are {1} years old'.format(name, age))
-
+    print("Hello {0}, you are {1} years old".format(name, age))

com.ibm.wala.cast.python.jython3/data/except1.py

@@ -1,14 +1,14 @@
 import sys
 
 try:
-    f = open('myfile.txt')
+    f = open("myfile.txt")
     s = f.readline()
     i = int(s.strip())
 except IOError as e:
-    print "I/O error:"
-    print "{0}: {1}".format(e.errno, e.strerror)
+    print("I/O error:")
+    print("{0}: {1}".format(e.errno, e.strerror))
 except ValueError:
-    print "Could not convert data to an integer."
+    print("Could not convert data to an integer.")
 except:
-    print "Unexpected error:", sys.exc_info()[0]
+    print("Unexpected error:", sys.exc_info()[0])
     raise

com.ibm.wala.cast.python.ml.test/source/com/ibm/wala/cast/python/ml/test/TestTensorflowModelParsing.java

@@ -107,7 +107,7 @@ public void testParsing()
       Position parameterPosition = method.getParameterPosition(paramIndex);
 
       // check the line.
-      assertEquals(3, parameterPosition.getFirstLine());
+      assertEquals(4, parameterPosition.getFirstLine());
 
       // check the columns.
       if (lpk.getValueNumber() == 2) {

com.ibm.wala.cast.python.test/data/ana1.py

@@ -1,18 +1,21 @@
 def MAGIC_EQ(x, y):
-        return x == y
+    return x == y
+
 
 def Banana():
-        c = 5
-        b = c + 7
-        d = 10
-        a = 0
-        if (MAGIC_EQ(c, b)):
-                a = 2 * c
-        else:
-                a = c + 6
+    c = 5
+    b = c + 7
+    d = 10
+    a = 0
+    if MAGIC_EQ(c, b):
+        a = 2 * c
+    else:
+        a = c + 6
+
+    a = b + c
+    if MAGIC_EQ(a, d):
+        raise ("Oh no")
+
 
-        a = b + c
-        if (MAGIC_EQ(a, d)):
-                raise("Oh no")
 Apple()
-Banana()
+Banana()

com.ibm.wala.cast.python.test/data/annotations1.py

@@ -3,24 +3,27 @@
 
 app = Flask(__name__)
 
+
 def outer(outer_arg):
-    outer_ret_val = outer_arg + 'hey'
+    outer_ret_val = outer_arg + "hey"
     return outer_ret_val
 
+
 def inner(inner_arg):
-    inner_ret_val = inner_arg + 'hey'
+    inner_ret_val = inner_arg + "hey"
     return inner_ret_val
 
-@app.route('/menu', methods=['POST'])
+
+@app.route("/menu", methods=["POST"])
 def menu():
-    req_param = request.form['suggestion']
+    req_param = request.form["suggestion"]
     result = outer(inner("self isolating string"))
     subprocess.call(result, shell=True)
 
     result = outer(inner(req_param))
     subprocess.call(result, shell=True)
 
-    with open('menu.txt','r') as f:
+    with open("menu.txt", "r") as f:
         menu = f.read()
 
-    return render_template('command_injection.html', menu=menu)
+    return render_template("command_injection.html", menu=menu)

com.ibm.wala.cast.python.test/data/annotations2.py

@@ -1,30 +1,36 @@
 import pytest
 
+
 @pytest.mark.parametrize(
     "index", [[1, 2], [1.0, 2.0], ["a", "b"], ["1", "2"], ["1.", "2."]]
 )
 def test_param_one(index):
     def foo(x):
         print(type(x[0]))
-        
+
     foo(index)
 
+
 def test_no_params():
     def none():
         print("none")
 
     none()
-    
+
+
 def some_callee():
     return "some callee"
 
+
 @pytest.fixture
 def testparam():
     return some_callee
 
+
 def test_param_local(testparam):
     print("testparam is " + str(testparam()))
-    
+
+
 class TestTestClass:
     def show(self, x):
         print(str(x))
@@ -35,91 +41,118 @@ def test_param_two(self, value):
 
 
 class notATestClass:
-
     @pytest.mark.parametrize("value", [1, "a", True])
     def test_param_three(self, value):
         print(value)
 
+
 @pytest.mark.parametrize(
     "index", [[1, 2], [1.0, 2.0], ["a", "b"], ["1", "2"], ["1.", "2."]]
 )
-@pytest.mark.parametrize(
-    "columns", [["a", "b"], ["1", "2"], ["1.", "2."]]
-)
+@pytest.mark.parametrize("columns", [["a", "b"], ["1", "2"], ["1.", "2."]])
 def test_param_three(index, columns):
     def f(x, y):
         print("(" + str(x) + "," + str(y) + ")")
-        
+
     for x in index:
         for y in columns:
             f(x, y)
 
+
 import pandas_shim as pd
 
+
 @pytest.mark.parametrize(
-    "name, expected_obj",[("pandas.isnull", pd.isnull), ("pandas.DataFrame", pd.DataFrame)]
+    "name, expected_obj",
+    [("pandas.isnull", pd.isnull), ("pandas.DataFrame", pd.DataFrame)],
 )
 def test_param_four(name, expected_obj):
     print("(" + str(name) + "," + str(expected_obj(name)) + ")")
 
+
 @pytest.mark.parametrize(
-    "values", [pd.Categorical([]), pd.Categorical([]).dtype, pd.Series(pd.Categorical([]))]
+    "values",
+    [pd.Categorical([]), pd.Categorical([]).dtype, pd.Series(pd.Categorical([]))],
 )
 def test_param_five(values):
     def f(x):
         print(str(x))
-        
+
     f(values)
-    
+
+
 @pytest.mark.parametrize("ascending", [True, False])
 def test_param_six(ascending):
     def f(x):
         print(str(x))
 
     f(ascending)
-    
+
+
 @pytest.mark.parametrize("box", [pd.Series, lambda x: x])
 def test_box(box):
     def f(x):
         print(str(x(0)))
 
     f(box)
-    
+
+
 @pytest.mark.parametrize("repeats", [0, 1, 2, [1, 2, 3]])
 def test_repeat(repeats):
     def f(x):
         print(str(x))
 
     f(repeats)
 
+
 from pandas_shim import DecimalArrayWithoutFromSequence, DecimalArrayWithoutCoercion
 
-@pytest.mark.parametrize("class_", [DecimalArrayWithoutFromSequence, DecimalArrayWithoutCoercion])
+
+@pytest.mark.parametrize(
+    "class_", [DecimalArrayWithoutFromSequence, DecimalArrayWithoutCoercion]
+)
 def test_class(class_):
-     print(class_().foo())
+    print(class_().foo())
+
 
-@pytest.mark.parametrize("columns",[["A", "B"], pd.MultiIndex.from_tuples([("A", "a"), ("A", "b")], names=["outer", "inner"])])
+@pytest.mark.parametrize(
+    "columns",
+    [
+        ["A", "B"],
+        pd.MultiIndex.from_tuples([("A", "a"), ("A", "b")], names=["outer", "inner"]),
+    ],
+)
 def test_cols(columns):
-     print("(" + str(columns) + ")")
+    print("(" + str(columns) + ")")
+
 
-#@pytest.mark.parametrize("repeats, kwargs, error, msg",[
-#(2, dict(axis=1), ValueError, "'axis"),
-#(-1, dict(), ValueError, "negative"),
-#([1, 2], dict(), ValueError, "shape")])
-#def test_dict(repeats, kwargs, error, msg):
+# @pytest.mark.parametrize("repeats, kwargs, error, msg",[
+# (2, dict(axis=1), ValueError, "'axis"),
+# (-1, dict(), ValueError, "negative"),
+# ([1, 2], dict(), ValueError, "shape")])
+# def test_dict(repeats, kwargs, error, msg):
 #     print("(" + str(repeats) + " " + str(kwargs) + " " + str(error) + " " + msg + ")")
 
 from pandas_shim import DataFrame
 import np_shim as np
 
-@pytest.mark.parametrize("header,expected",[(None, DataFrame([0] + [np.nan] * 4)), (0, DataFrame([np.nan] * 4))])
+
+@pytest.mark.parametrize(
+    "header,expected",
+    [(None, DataFrame([0] + [np.nan] * 4)), (0, DataFrame([np.nan] * 4))],
+)
 def test_head_expected(header, expected):
-     print("(" + str(header) + " " + str(expected))
+    print("(" + str(header) + " " + str(expected))
 
 
-@pytest.mark.parametrize("option,result,expected",[ (None, lambda df: df.to_html(), "1"), (None, lambda df: df.to_html(border=0), "0"), (0, lambda df: df.to_html(), "0")])
+@pytest.mark.parametrize(
+    "option,result,expected",
+    [
+        (None, lambda df: df.to_html(), "1"),
+        (None, lambda df: df.to_html(border=0), "0"),
+        (0, lambda df: df.to_html(), "0"),
+    ],
+)
 def test_lamda_call(option, result, expected):
     df = DataFrame({"A": [1, 2]})
     print("(" + str(option) + " " + str(result(df)) + " " + str(expected))
-
-