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

.yamllint.yaml

@@ -16,8 +16,8 @@ rules:
   colons: enable
   commas: enable
   comments: disable
-  comments-indentation: disable
-  document-start: disable
+  comments-indentation: enable
+  document-start: enable
   empty-lines: enable
   empty-values: disable
   float-values: disable

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)

kyu_6/array_to_html_table/__init__.py

@@ -0,0 +1 @@
+"""Array to HTML table."""

kyu_6/array_to_html_table/test_list_to_html_table.py

@@ -1,5 +1,6 @@
 """
-Test for -> Array to HTML table
+Test for -> Array to HTML table.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -25,13 +26,12 @@
     url='https://www.codewars.com/kata/5e7e4b7cd889f7001728fd4a',
     name='Source/Kata')
 class ArrayToTableTestCase(unittest.TestCase):
-    """
-    Testing to_table function
-    """
+    """Testing to_table function."""
 
     def test_array_to_table_function(self):
         """
-        Testing to_table with various test data
+        Testing to_table with various test data.
+
         :return:
         """
         # pylint: disable-msg=R0801
@@ -110,6 +110,7 @@ def test_array_to_table_function(self):
             expected = test_item["output"]
             actual_result = to_table(data, header, index)
 
-            with allure.step("Enter a test data and verify the expected output vs actual result"):
+            with allure.step("Enter a test data and verify expected"
+                             " output vs actual result"):
                 print_log(exp=expected, res=actual_result)
                 self.assertEqual(expected, actual_result)

kyu_6/array_to_html_table/to_table.py

@@ -1,5 +1,6 @@
 """
-Solution for -> Array to HTML table
+Solution for -> Array to HTML table.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -26,6 +27,8 @@
 
 def to_table(data: list, header: bool = False, index: bool = False) -> str:
     """
+    Array to table.
+
     Takes three arguments: data, headers, index, and returns
     a string containing HTML tags representing the table.
 

kyu_6/binary_to_text_ascii_conversion/__init__.py

@@ -0,0 +1 @@
+"""Binary to Text (ASCII) Conversion."""

kyu_6/binary_to_text_ascii_conversion/binary_to_string.py

@@ -1,12 +1,15 @@
 """
-Solution for -> Binary to Text (ASCII) Conversion
+Solution for -> Binary to Text (ASCII) Conversion.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
 
 
 def binary_to_string(binary: str) -> str:
     """
+    Binary to string.
+
     Write a function that takes in a binary string
     and returns the equivalent decoded text
     (the text is ASCII encoded).
@@ -29,7 +32,6 @@ def binary_to_string(binary: str) -> str:
     :param binary:
     :return:
     """
-
     if not binary:
         return ''
 

kyu_6/binary_to_text_ascii_conversion/test_binary_to_string.py

@@ -1,5 +1,6 @@
 """
-Test for -> Binary to Text (ASCII) Conversion
+Test for -> Binary to Text (ASCII) Conversion.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -29,14 +30,12 @@
     url='https://www.codewars.com/kata/5583d268479559400d000064',
     name='Source/Kata')
 class SequenceTestCase(unittest.TestCase):
-    """
-    Testing binary_to_string function
-    """
+    """Testing binary_to_string function."""
 
     def test_binary_to_string(self):
         """
-        Testing binary_to_string function
-        with various test data
+        Testing binary_to_string function with various test data.
+
         :return:
         """
         # pylint: disable-msg=R0801

kyu_6/casino_chips/__init__.py

@@ -0,0 +1 @@
+"""Casino chips."""

kyu_6/casino_chips/solve.py

@@ -1,12 +1,15 @@
 """
-Solution for Casino chips
+Solution for Casino chips.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
 
 
 def solve(arr: list) -> int:
     """
+    Solve function.
+
     You are given three piles of casino chips: white, green and black
     chips:
 
@@ -26,7 +29,6 @@ def solve(arr: list) -> int:
     :return:
     """
     arr = sorted(arr)
-
     if arr[0] + arr[1] <= arr[2]:
         return arr[0] + arr[1]
 

kyu_6/casino_chips/test_solve.py

@@ -1,5 +1,6 @@
 """
-Test for Casino chips
+Test for Casino chips.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -8,6 +9,7 @@
 
 import unittest
 import allure
+from parameterized import parameterized
 from kyu_6.casino_chips.solve import solve
 from utils.log_func import print_log
 
@@ -28,12 +30,26 @@
     name='Source/Kata')
 # pylint: enable-msg=R0801
 class SolveTestCase(unittest.TestCase):
-    """
-    Testing solve function
-    """
-    def test_solve(self):
+    """Testing solve function."""
+
+    @parameterized.expand([
+        ([8, 8, 8], 12),
+        ([1, 1, 1], 1),
+        ([8, 1, 4], 5),
+        ([7, 4, 10], 10),
+        ([12, 12, 12], 18),
+        ([6, 6, 6], 9),
+        ([1, 23, 2], 3),
+        ([9, 8, 6], 11),
+        ([10, 9, 6], 12),
+        ([4, 4, 3], 5),
+        ([1, 2, 1], 2),
+        ([4, 1, 1], 2),
+        ([8, 2, 8], 9)])
+    def test_solve(self, arr, expected):
         """
-        Testing 'solve' function with various test data
+        Testing 'solve' function with various test data.
+
         :return:
         """
         # pylint: disable-msg=R0801
@@ -49,31 +65,9 @@ def test_solve(self):
             "maximum number of days you can pick the chips. Each "
             "day you need to take exactly two chips.</p>")
         # pylint: enable-msg=R0801
-        test_data: tuple = (
-            ([8, 8, 8], 12),
-            ([1, 1, 1], 1),
-            ([8, 1, 4], 5),
-            ([7, 4, 10], 10),
-            ([12, 12, 12], 18),
-            ([6, 6, 6], 9),
-            ([1, 23, 2], 3),
-            ([9, 8, 6], 11),
-            ([10, 9, 6], 12),
-            ([4, 4, 3], 5),
-            ([1, 2, 1], 2),
-            ([4, 1, 1], 2),
-            ([8, 2, 8], 9))
-
-        for arr, expected in test_data:
-            actual_result = solve(arr)
-
-            with allure.step(f"Enter an array ({arr}) and verify the "
-                             f"expected output ({expected}) vs "
-                             f"actual result ({actual_result})"):
-
-                print_log(arr=arr,
-                          expected=expected,
-                          result=actual_result)
-
-                self.assertEqual(expected,
-                                 actual_result)
+        actual_result = solve(arr)
+        with allure.step(f"Enter an array ({arr}) and verify the "
+                         f"expected output ({expected}) vs "
+                         f"actual result ({actual_result})"):
+            print_log(arr=arr, expected=expected, result=actual_result)
+            self.assertEqual(expected, actual_result)

kyu_6/character_frequency/__init__.py

@@ -0,0 +1 @@
+"""Character frequency."""