Testing | Init Checker

dev/test.sh

@@ -7,6 +7,10 @@ echo "=== test.sh ==="
 clang-format-10 --Werror --dry-run src/proto/flwr/proto/*                 && echo "- clang-format: done" &&
 python -m isort --check-only --skip src/py/flwr/proto src/py/flwr         && echo "- isort:  done" &&
 python -m black --exclude "src\/py\/flwr\/proto" --check src/py/flwr      && echo "- black:  done" &&
+python -m flwr_tool.init_py_check \
+  src/py/flwr src/py/flwr_tool \
+  src/py/flwr_example \
+  src/py/flwr_experimental
 python -m docformatter -c -r src/py/flwr -e src/py/flwr/proto             && echo "- docformatter:  done" &&
 python -m mypy src/py                                                     && echo "- mypy:   done" &&
 python -m pylint --ignore=src/py/flwr/proto src/py/flwr                   && echo "- pylint: done" &&

src/py/flwr/dataset/utils/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2020 Adap GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Flower Datasets utility functions."""

src/py/flwr/dataset/utils/common.py

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-
+"""Provides commonely used functions when generating a dataset for Federated
+Learning."""
 # pylint: disable=invalid-name
 
 from typing import List, Tuple, cast

src/py/flwr/dataset/utils/common_test.py

@@ -49,7 +49,7 @@ class CifarPartitionedTestCase(unittest.TestCase):
     """Tests for partitioned CIFAR-10/100 dataset generation."""
 
     def setUp(self) -> None:
-        x = np.random.random(size=(500, 3, 32, 32))
+        x = np.random.random(size=(500, 3, 32, 32))  # pylint: disable=no-member
         y = np.concatenate(np.array([50 * [j] for j in range(10)]), axis=0)
         y = np.expand_dims(y, axis=1)
 

src/py/flwr_example/pytorch_save_weights/client.py

@@ -17,8 +17,6 @@
 
 import argparse
 import timeit
-
-# pylint: enable=no-member
 from typing import Dict, List, Tuple
 
 import numpy as np

src/py/flwr_tool/init_py_check.py

@@ -0,0 +1,45 @@
+# Copyright 2020 Adap GmbH. All Rights Reserved.
+
+"""Check provided directory and sub-directories for missing __init__.py files.
+
+Example:
+    python -m flwr_tool.init_py_check src/py/flwr
+"""
+
+import os
+import re
+import sys
+
+
+def check_missing_init_files(absolute_path: str) -> None:
+    """Searches through the specified absolute_path and looks for missing __init__.py
+    files."""
+    path = os.walk(absolute_path)
+    warning_list = []
+    ignore_list = ["__pycache__$", ".pytest_cache.*$", "dist", "flwr.egg-info$"]
+
+    for dir_path, _, files_in_dir in path:
+        # As some directories are automatically generated we are going to ignore them
+        if any([re.search(iw, dir_path) is not None for iw in ignore_list]):
+            continue
+
+        # If no init is found in current directory add a warning_message to warning_list
+        if not any(filename == "__init__.py" for filename in files_in_dir):
+            warning_message = "- " + dir_path
+            warning_list.append(warning_message)
+
+    if len(warning_list) > 0:
+        print("Could not find '__init__.py' in the following directories:")
+        for warning in warning_list:
+            print(warning)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    if len(sys.argv) == 0:
+        raise Exception(
+            "Please provide at least one directory path relative to your current working directory."
+        )
+    for i in range(len(sys.argv)):
+        abs_path: str = os.path.abspath(os.path.join(os.getcwd(), sys.argv[i]))
+        check_missing_init_files(abs_path)