Merge pull request #244 from Dekken/Python_format_checks

Addition of CI python formatting checks + format python

Author: PhilipDeegan

sh/format-diff.sh

@@ -9,13 +9,15 @@ DIRS=(lib/include lib/cpp lib/cpp-test)
 
 [ -z "$CLANG_FORMAT" ] && which clang-format &> /dev/null \
                        && CLANG_FORMAT="clang-format"
-[ -z "$CLANG_FORMAT" ] && echo "clang-format not on PATH, "\
-                               "add to PATH or set CLANG_FORMAT"\ && exit 1
+[ -z "$CLANG_FORMAT" ] && echo "clang-format not on PATH, " \
+                               "add to PATH or set CLANG_FORMAT" \
+                                && exit 1
 
 [ -z "$CLANG_FORMATDIFF" ] && which clang-format-diff.py &> /dev/null \
                            && CLANG_FORMATDIFF="clang-format-diff.py"
-[ -z "$CLANG_FORMATDIFF" ] && echo "clang-format-diff.py not on PATH, "\
-                                   "add to PATH or set CLANG_FORMATDIFF" && exit 1
+[ -z "$CLANG_FORMATDIFF" ] && echo "clang-format-diff.py not on PATH, " \
+                                   "add to PATH or set CLANG_FORMATDIFF" \
+                                    && exit 1
 
 BRANCH=$(git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,')
 

sh/format_python.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -e
+
+CWD="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PY=python
+VER=$($PY --version 2>&1 | cut -d' ' -f 2 | cut -d'.' -f1)
+((VER == 2 )) && PY=python3
+
+cd ..
+$PY -m yapf --style tools/python/yapf.conf -i tick --recursive
+
+echo "Please confirm your version of yapf is up to date from pip"
+echo "To upgrade run 'pip3 install yapf --upgrade'"

tick/array/tests/serialize_test.py

@@ -12,7 +12,6 @@
 
 
 class Test(object):
-
     def __init__(self, *args, dtype="float64", **kwargs):
         unittest.TestCase.__init__(self, *args, **kwargs)
         self.dtype = dtype
@@ -49,8 +48,8 @@ def test_serialize_2d_array(self):
     def test_serialize_sparse_2d_array(self):
         """...Test serialization of 2d dense array is done as expected
         """
-        array = sparse.rand(10, 10, density=0.3, format='csr').astype(
-            self.dtype)
+        array = sparse.rand(10, 10, density=0.3,
+                            format='csr').astype(self.dtype)
         serialize_array(array, self.array_file)
 
         serialized_array = load_array(self.array_file, array_dim=2,

tick/array_test/tests/array_methods_test.py

@@ -183,8 +183,8 @@ def test_dot(self):
                 array_types_1d, array_types_1d):
             test_arrays_1 = self._test_arrays(array_type_1)
             test_arrays_2 = self._test_arrays(array_type_2)
-            test_func = getattr(test, "test_dot_%s_%s" % (array_type_1,
-                                                          array_type_2))
+            test_func = getattr(
+                test, "test_dot_%s_%s" % (array_type_1, array_type_2))
             for test_array_1, test_array_2 in itertools.product(
                     test_arrays_1, test_arrays_2):
                 compare_array_1 = Test.cast_1d_array_to_1d_dense(test_array_1)

tick/array_test/tests/array_typemap_test.py

@@ -51,12 +51,12 @@ def setUp(self):
             info['number'] = 148  # info['python_type'](np.exp(5))
 
             # The dense array of the corresponding type
-            python_array = np.array([1, 2, 5, 0, 4, 1]).astype(
-                info['python_type'])
+            python_array = np.array([1, 2, 5, 0, 4,
+                                     1]).astype(info['python_type'])
 
             # The dense array 2D of the corresponding type
-            python_array_2d = np.array([[1, 2, 5], [0, 4, 1]]).astype(
-                info['python_type'])
+            python_array_2d = np.array([[1, 2, 5],
+                                        [0, 4, 1]]).astype(info['python_type'])
 
             # The list of dense array of the corresponding type
             python_array_list_1d = [
@@ -67,8 +67,8 @@ def setUp(self):
 
             python_array2d_list_1d = [
                 np.array([[1, 2, 5], [0, 4, 1]]).astype(info['python_type']),
-                np.array([[1, 2, 9], [1, 2, 5], [0, 4, 1]]).astype(
-                    info['python_type']),
+                np.array([[1, 2, 9], [1, 2, 5],
+                          [0, 4, 1]]).astype(info['python_type']),
                 np.array([[0]]).astype(info['python_type'])
             ]
 
@@ -82,22 +82,20 @@ def setUp(self):
             python_array2d_list_2d = [[
                 np.array([[1, 2, 5], [0, 4, 1]]).astype(info['python_type']),
             ], [
-                np.array([[1, 2, 9], [1, 2, 5], [0, 4, 1]]).astype(
-                    info['python_type']),
+                np.array([[1, 2, 9], [1, 2, 5],
+                          [0, 4, 1]]).astype(info['python_type']),
                 np.array([[0]]).astype(info['python_type'])
             ], []]
 
             # The sparse array of the corresponding type
-            python_sparse_array = csr_matrix((np.array([1.5, 2, 3, 1]),
-                                              np.array([3, 5, 7, 9]),
-                                              np.array([0, 4]))).astype(
-                                                  info['python_type'])
+            python_sparse_array = csr_matrix(
+                (np.array([1.5, 2, 3, 1]), np.array([3, 5, 7, 9]),
+                 np.array([0, 4]))).astype(info['python_type'])
 
             # The sparse array 2D of the corresponding type
-            python_sparse_array_2d = csr_matrix((np.array([1.5, 2, 3, 1]),
-                                                 np.array([3, 5, 7, 4]),
-                                                 np.array([0, 3, 4]))).astype(
-                                                     info['python_type'])
+            python_sparse_array_2d = csr_matrix(
+                (np.array([1.5, 2, 3, 1]), np.array([3, 5, 7, 4]),
+                 np.array([0, 3, 4]))).astype(info['python_type'])
 
             python_sparse_array_list_1d = [
                 csr_matrix((np.array([1.5, 2, 3, 1]), np.array([3, 5, 7, 9]),

tick/base/base.py

@@ -180,12 +180,12 @@ def setter(self, val):
                 if set_in_init:
                     base_setter(self, val)
                 else:
-                    raise AttributeError("%s is readonly in %s" %
-                                         (str(attr_name), class_name))
+                    raise AttributeError(
+                        "%s is readonly in %s" % (str(attr_name), class_name))
 
         def deletter(self):
-            raise AttributeError("can't delete %s in %s" % (str(attr_name),
-                                                            class_name))
+            raise AttributeError(
+                "can't delete %s in %s" % (str(attr_name), class_name))
 
         # We set doc to None otherwise it will interfere with
         # the docstring of the class.
@@ -529,9 +529,9 @@ def __init__(self, *args, **kwargs):
                     ])
 
                     # We copy property and add the doc found in docstring
-                    setattr(self.__class__, attr_name,
-                            property(prop.fget, prop.fset, prop.fdel,
-                                     prop_doc))
+                    setattr(
+                        self.__class__, attr_name,
+                        property(prop.fget, prop.fset, prop.fdel, prop_doc))
 
     @staticmethod
     def _get_now():

tick/base/learner/learner_optim.py

@@ -389,8 +389,9 @@ def elastic_net_ratio(self, val):
         if self.penalty == 'elasticnet':
             self._prox_obj.ratio = val
         else:
-            warn('Penalty "%s" has no elastic_net_ratio attribute' %
-                 self.penalty, RuntimeWarning)
+            warn(
+                'Penalty "%s" has no elastic_net_ratio attribute' %
+                self.penalty, RuntimeWarning)
 
     @property
     def blocks_start(self):
@@ -442,8 +443,9 @@ def sdca_ridge_strength(self, val):
         if self.solver == 'sdca':
             self._solver_obj.l_l2sq = val
         else:
-            warn('Solver "%s" has no sdca_ridge_strength attribute' %
-                 self.solver, RuntimeWarning)
+            warn(
+                'Solver "%s" has no sdca_ridge_strength attribute' %
+                self.solver, RuntimeWarning)
 
     @staticmethod
     def _safe_array(X, dtype="float64"):

tick/base/tests/base_test.py

@@ -432,14 +432,14 @@ def test_cpp_setter(self):
         self.assertEqual(self.a0._a0.get_cpp_int(), 15)
 
         # Test we raise correct error if setter was not a cpp method
-        with self.assertRaisesRegex(NameError,
-                                    "set_cpp_unlinked_int is not a method "
-                                    "of.*"):
+        with self.assertRaisesRegex(
+                NameError, "set_cpp_unlinked_int is not a method "
+                "of.*"):
             self.a0.cpp_unlinked_int = 3
 
-        with self.assertRaisesRegex(NameError,
-                                    "set_cpp_unlinked_int is not a method "
-                                    "of.*"):
+        with self.assertRaisesRegex(
+                NameError, "set_cpp_unlinked_int is not a method "
+                "of.*"):
             self.a0._set('cpp_unlinked_int', 3)
 
         # Test we raise correct error if _cpp_obj_name was not set

tick/base/tests/exceptions_test.py

@@ -26,8 +26,8 @@ def test_throw_system_error(self):
                                         os.strerror(errno.EACCES).lower()):
                 throw_system_error()
         else:
-            with self.assertRaisesRegex(RuntimeError, os.strerror(
-                    errno.EACCES)):
+            with self.assertRaisesRegex(RuntimeError,
+                                        os.strerror(errno.EACCES)):
                 throw_system_error()
 
     def test_throw_invalid_argument(self):

tick/base_model/model.py

@@ -135,9 +135,9 @@ def loss(self, coeffs: np.ndarray) -> float:
         if not self._fitted:
             raise ValueError("call ``fit`` before using ``loss``")
         if coeffs.shape[0] != self.n_coeffs:
-            raise ValueError(("``coeffs`` has size %i while the model" +
-                              " expects %i coefficients") % (len(coeffs),
-                                                             self.n_coeffs))
+            raise ValueError(
+                ("``coeffs`` has size %i while the model" +
+                 " expects %i coefficients") % (len(coeffs), self.n_coeffs))
         self._inc_attr(N_CALLS_LOSS)
         self._inc_attr(PASS_OVER_DATA, step=self.pass_per_operation[LOSS])
 
@@ -159,10 +159,11 @@ def _get_typed_class(self, dtype_or_object_with_dtype, dtype_map):
     def astype(self, dtype_or_object_with_dtype):
         import tick.base.dtype_to_cpp_type
         new_model = tick.base.dtype_to_cpp_type.copy_with(
-          self, ["_model"]  # ignore _model on deepcopy
+            self,
+            ["_model"]  # ignore _model on deepcopy
         )
         new_model._set('_model',
-            new_model._build_cpp_model(dtype_or_object_with_dtype))
+                       new_model._build_cpp_model(dtype_or_object_with_dtype))
         return new_model
 
     def _build_cpp_model(self, dtype: str):