Merge pull request #561 from iKostanOrg/master

.github/workflows/pydocstyle_kyu6.yml

@@ -0,0 +1,46 @@
+---
+name: pydocstyle for kyu6
+
+on:   # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - 'kyu6'
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.x"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        # This is the version of the action for setting up Python,
+        # not the Python version.
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # You can test your matrix by printing the current Python version
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install -r requirements.txt
+          pip install pydocstyle
+          pip install types-requests
+      - name: Check to make sure that the module is in your Python path
+        run: |
+          echo $PYTHONPATH
+      - name: Check pydocstyle version
+        run: |
+          pydocstyle --version
+      - name: Doc style checking with pydocstyle
+        # Pydocstyle testing (Guide)
+        # https://www.pydocstyle.org/en/stable/usage.html#cli-usage
+        run: |
+          pydocstyle --verbose --explain --count kyu_6

kyu_6/__init__.py

@@ -0,0 +1 @@
+"""6 kyu - Novice package."""

kyu_6/a_rule_of_divisibility_by_13/__init__.py

@@ -0,0 +1 @@
+"""A Rule of Divisibility by 13."""

kyu_6/array_diff/__init__.py

@@ -0,0 +1 @@
+"""# Array.diff."""

kyu_6/array_diff/solution.py

@@ -1,5 +1,6 @@
 """
-Solution for -> Array.diff
+Solution for -> Array.diff.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """

kyu_6/array_diff/test_array_diff.py

@@ -1,5 +1,6 @@
 """
-Test for -> Array.diff
+Test for -> Array.diff.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -8,6 +9,7 @@
 
 import unittest
 import allure
+from parameterized import parameterized
 from kyu_6.array_diff.solution import array_diff
 from utils.log_func import print_log
 
@@ -28,7 +30,7 @@
 # pylint: enable-msg=R0801
 class ArrayDiffTestCase(unittest.TestCase):
     """
-    Testing array_diff function
+    Testing array_diff function.
 
     Your goal in this kata is to implement a difference function,
     which subtracts one list from another and returns the result.
@@ -42,9 +44,16 @@ class ArrayDiffTestCase(unittest.TestCase):
     array_diff([1,2,2,2,3],[2]) == [1,3]
     """
 
-    def test_array_diff_function(self):
+    @parameterized.expand([
+        ([1, 2], [1], [2], "a was [1,2], b was [1], expected [2]"),
+        ([1, 2, 2], [1], [2, 2], "a was [1,2,2], b was [1], expected [2,2]"),
+        ([1, 2, 2], [2], [1], "a was [1,2,2], b was [2], expected [1]"),
+        ([1, 2, 2], [], [1, 2, 2], "a was [1,2,2], b was [], expected [1,2,2]"),
+        ([], [1, 2], [], "a was [], b was [1,2], expected []")])
+    def test_array_diff_function(self, a, b, expected, message):
         """
-        Testing array_diff function
+        Testing array_diff function.
+
         :return:
         """
         # pylint: disable-msg=R0801
@@ -59,29 +68,15 @@ def test_array_diff_function(self):
             "and returns the result. It should remove all values from "
             "list a, which are present in list b.</p>")
         # pylint: enable-msg=R0801
-        test_data: tuple = (
-            ([1, 2], [1], [2], "a was [1,2], b was [1], expected [2]"),
-            ([1, 2, 2], [1], [2, 2], "a was [1,2,2], b was [1], expected [2,2]"),
-            ([1, 2, 2], [2], [1], "a was [1,2,2], b was [2], expected [1]"),
-            ([1, 2, 2], [], [1, 2, 2], "a was [1,2,2], b was [], expected [1,2,2]"),
-            ([], [1, 2], [], "a was [], b was [1,2], expected []"))
-
-        for test_item in test_data:
-            a: list = test_item[0]
-            b: list = test_item[1]
-            expected: list = test_item[2]
-            message: str = test_item[-1]
+        with allure.step(f"Enter a test data: {a, b} and verify the "
+                         f"expected output vs actual result: {expected}."):
             actual_result: list = array_diff(a, b)
+            print_log(a=a,
+                      b=b,
+                      exp=expected,
+                      message=message,
+                      actual_result=actual_result)
 
-            with allure.step("Enter a test data and verify the "
-                             "expected output vs actual result"):
-
-                print_log(a=a,
-                          b=b,
-                          exp=expected,
-                          message=message,
-                          res=actual_result)
-
-                self.assertEqual(expected,
-                                 actual_result,
-                                 message)
+            self.assertEqual(expected,
+                             actual_result,
+                             message)