Pydocstyle + Merge pull request #550 from iKostanOrg/master

.github/workflows/pydocstyle_kyu4.yml

@@ -0,0 +1,46 @@
+---
+name: pydocstyle for kyu4
+
+on:   # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - 'kyu4'
+
+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_4

kyu_4/__init__.py

@@ -0,0 +1 @@
+"""Codewars kyu_4 package."""

kyu_4/human_readable_duration_format/__init__.py

@@ -0,0 +1 @@
+"""Human readable duration format package."""

kyu_4/human_readable_duration_format/format_duration.py

@@ -1,4 +1,6 @@
 """
+Format duration.
+
 A function which formats a duration, given as a
 number of seconds, in a human-friendly way.
 Created by Egor Kostan.
@@ -8,6 +10,8 @@
 
 def format_duration(seconds: int) -> str:
     """
+    format_duration function.
+
     A function which formats a duration, given as a
     number of seconds, in a human-friendly way.
 
@@ -67,34 +71,36 @@ def format_duration(seconds: int) -> str:
     return result
 
 
-def format_days(days: int, day: str, result: str) -> str:
+def format_days(days: int,
+                day: str,
+                result: str) -> str:
     """
-    Format days for the final string
-    :param days:
-    :param day:
-    :param result:
-    :return:
+    Format days for the final string.
+
+    :param days: int
+    :param day: str
+    :param result: str
+    :return: str
     """
-    if days > 0 and result != '':
-        result += f', {day}'
-    elif days > 0:
-        result += f'{day}'
+    if days > 0:
+        result += f', {day}' if result else f'{day}'
 
     return result
 
 
-def format_hours(hours: int, hour: str, result: str) -> str:
+def format_hours(hours: int,
+                 hour: str,
+                 result: str) -> str:
     """
-    Format hours for the final string
-    :param hours:
-    :param hour:
-    :param result:
-    :return:
+    Format hours for the final string.
+
+    :param hours: int
+    :param hour: str
+    :param result: str
+    :return: str
     """
-    if hours > 0 and result != '':
-        result += f', {hour}'
-    elif hours > 0:
-        result += f'{hour}'
+    if hours > 0:
+        result += f', {hour}' if result else f'{hour}'
 
     return result
 
@@ -104,12 +110,13 @@ def format_minutes(minutes: int,
                    minute: str,
                    result: str) -> str:
     """
-    Format minutes for the final string
-    :param minutes:
-    :param seconds:
-    :param minute:
-    :param result:
-    :return:
+    Format minutes for the final string.
+
+    :param minutes: int
+    :param seconds: int
+    :param minute: str
+    :param result: str
+    :return: str
     """
     if minutes > 0 and result != '' and seconds == 0:
         result += f' and {minute}'
@@ -123,26 +130,27 @@ def format_minutes(minutes: int,
 
 def format_seconds(seconds: int, second: str, result: str) -> str:
     """
-    Format seconds for the final string
-    :param seconds:
-    :param second:
-    :param result:
-    :return:
+    Format seconds for the final string.
+
+    :param seconds: int
+    :param second: str
+    :param result: str
+    :return: str
     """
-    if seconds > 0 and result != '':
-        result += f' and {second}'
-    elif seconds > 0:
-        result += f'{second}'
+    if seconds > 0:
+        result += f' and {second}' if result else f'{second}'
 
     return result
 
 
-def get_string(number: int, string: str) -> str:
+def get_string(number: int,
+               string: str) -> str:
     """
-    Concatenate string result
-    :param number:
-    :param string:
-    :return:
+    Concatenate string result.
+
+    :param number: int
+    :param string: str
+    :return: str
     """
     result: str = ''
     if number == 1:
@@ -155,59 +163,52 @@ def get_string(number: int, string: str) -> str:
 
 def calc_seconds(seconds: int) -> int:
     """
-    Calculate seconds
-    :param seconds:
-    :return:
-    """
-    if seconds < 60:
-        return seconds
+    Calculate seconds.
 
-    return seconds % 60
+    :param seconds: int
+    :return: int
+    """
+    return seconds if seconds < 60 else seconds % 60
 
 
 def calc_minutes(seconds: int) -> int:
     """
-    calculate minutes
-    :param seconds:
-    :return:
+    Calculate minutes.
+
+    :param seconds: int
+    :return: int
     """
     minutes = seconds // 60
-    if minutes < 60:
-        return minutes
-
-    return minutes % 60
+    return minutes if minutes < 60 else minutes % 60
 
 
 def calc_hours(seconds: int) -> int:
     """
-    Calculate hours
-    :param seconds:
-    :return:
+    Calculate hours.
+
+    :param seconds: int
+    :return: int
     """
     hours = seconds // (60 * 60)
-    if hours < 24:
-        return hours
-
-    return hours % 24
+    return hours if hours < 24 else hours % 24
 
 
 def calc_days(seconds: int) -> int:
     """
-    Calculate days
-    :param seconds:
-    :return:
+    Calculate days.
+
+    :param seconds: int
+    :return: int
     """
     days = seconds // (60 * 60 * 24)
-    if days < 365:
-        return days
-
-    return days % 365
+    return days if days < 365 else days % 365
 
 
 def calc_years(seconds: int) -> int:
     """
-    Calculate years
-    :param seconds:
-    :return:
+    Calculate years.
+
+    :param seconds: int
+    :return: int
     """
     return seconds // (60 * 60 * 24 * 365)

kyu_4/human_readable_duration_format/test_format_duration.py

@@ -1,5 +1,6 @@
 """
-Test for 'Human readable duration format'
+Test for 'Human readable duration format'.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -29,12 +30,12 @@
              name='Source/Kata')
 # pylint: enable-msg=R0801
 class FormatDurationTestCase(unittest.TestCase):
-    """
-    Testing format_duration
-    """
+    """Testing format_duration."""
 
     def test_format_duration(self):
         """
+        Test format_duration function.
+
         Test a function which formats a duration,
         given as a number of seconds, in a human-friendly way.
 

kyu_4/most_frequently_used_words/__init__.py

@@ -0,0 +1 @@
+"""Most frequently used words in a text package."""

kyu_4/most_frequently_used_words/solution.py

@@ -1,12 +1,15 @@
 """
-Most frequently used words in a text
+Most frequently used words in a text.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
 
 
 def top_3_words(text: str) -> list:
     """
+    Top 3 words function.
+
     Given a string of text (possibly with punctuation and line-breaks),
     returns an array of the top-3 most occurring words, in descending
     order of the number of occurrences.

kyu_4/most_frequently_used_words/test_top_3_words.py

@@ -1,5 +1,6 @@
 """
-Test for 'Most frequently used words in a text'
+Test for 'Most frequently used words in a text'.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -28,13 +29,13 @@
     url='https://www.codewars.com/kata/51e056fe544cf36c410000fb',
     name='Source/Kata')
 class Top3WordsTestCase(unittest.TestCase):
-    """
-    Testing top_3_words
-    """
+    """Testing top_3_words."""
 
     def test_top_3_words(self):
         """
-        Test top_3_words function
+        Test top_3_words function with various test data.
+
+        :return:
         """
         # pylint: disable-msg=R0801
         allure.dynamic.title("Testing top_3_words function")

kyu_4/next_bigger_number_with_the_same_digits/__init__.py

@@ -0,0 +1 @@
+"""Next bigger number with the same digits package."""

kyu_4/next_bigger_number_with_the_same_digits/next_bigger.py

@@ -1,5 +1,6 @@
 """
-Solution for -> Next bigger number with the same digits
+Solution for -> Next bigger number with the same digits.
+
 Created by Egor Kostan.
 GitHub: https://github.com/ikostan
 """
@@ -62,11 +63,8 @@ def next_greater_digit_index(digits: list, i: int) -> int:
         return i
 
     for index, digit in enumerate(digits[i:]):
-        if digits[i - 1] < digit:
-            if current == '':
-                current = digit
-                j = i + index
-            elif current > digit:
-                current = digit
-                j = i + index
+        if digits[i - 1] < digit and (current == '' or current > digit):
+            current = digit
+            j = i + index
+
     return j

kyu_4/next_smaller_number_with_the_same_digits/__init__.py

@@ -0,0 +1 @@
+"""Next smaller number with the same digits package."""