Merge master with varun

.github/workflows/autopep.yml

@@ -0,0 +1,22 @@
+name: Autopep 8
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Install autopep8
+        run: |
+          pip install autopep8
+      - name: Run autopep8
+        run: |
+          autopep8 --diff --exit-code --recursive .

.github/workflows/pyflake.yml

@@ -0,0 +1,19 @@
+name: Python PyFlakes
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          pip install pyflakes
+      - name: Run linters
+        run: |
+          pyflakes $(find . -name "*.py") > post_traces/pyflakes_report.txt

.github/workflows/pylint.yml

@@ -0,0 +1,19 @@
+name: Python PyLint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          pip install pylint
+      - name: Run linters
+        run: |
+          pylint $(find . -name "*.py")

.github/workflows/unit-test-cases.yml

@@ -0,0 +1,26 @@
+name: Unit Test Cases
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install Dependencies and pytest
+        run: |
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install pytest coverage
+      - name: Run Unit Tests
+        run: |
+          coverage run -m pytest
+      - name: Generate Coverage Report
+        run: |
+          coverage report -m

README.md

@@ -1,4 +1,9 @@
+Group 38 - SE Homwork 2
+
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-![Language](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue)
-![Platform](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
-![Unit tests](https://github.com/GradHackersGuild/se-homework/actions/workflows/git-commit-workflow.yml/badge.svg)
+[![Language](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue)](https://www.python.org/)
+[![Platform](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)](https://www.linux.org/)
+[![Unit tests](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/unit-test-cases.yml/badge.svg)](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/unit-test-cases.yml)
+[![PEP8 Check](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/autopep.yml/badge.svg)](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/autopep.yml)
+[![PyLint Check](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/pylint.yml/badge.svg)](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/pylint.yml)
+[![PyFlake Check](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/pyflake.yml/badge.svg)](https://github.com/GradHackersGuild/se-homework-2/actions/workflows/pyflake.yml)

hw2_debugging.py

@@ -1,34 +1,51 @@
+"""
+Module implementing the Merge Sort algorithm.
+
+This script contains functions to perform merge sort on a given list and merge two sorted arrays.
+"""
 import rand
 
-def mergeSort(arr):
-    if (len(arr) == 1):
+
+def merge_sort(arr):
+    """
+    Recursively divides and sorts an array using the merge sort algorithm.
+
+    :param array: List of integers to be sorted.
+    :return: Sorted list of integers.
+    """
+    if len(arr) == 1:
         return arr
-    half = len(arr)//2
-    return recombine(mergeSort(arr[:half]), mergeSort(arr[half:]))
-
-def recombine(leftArr, rightArr):
-    leftIndex = 0
-    rightIndex = 0
-    mergeArr = [None] * (len(leftArr) + len(rightArr))
-    while leftIndex < len(leftArr) and rightIndex < len(rightArr):
-        if leftArr[leftIndex] < rightArr[rightIndex]:
-            mergeArr[leftIndex + rightIndex] = leftArr[leftIndex]
-            leftIndex += 1
+    half = len(arr) // 2
+    return recombine(merge_sort(arr[:half]), merge_sort(arr[half:]))
+
+
+def recombine(left_arr, right_arr):
+    """
+    Merges two sorted arrays into a single sorted array.
+
+    :param left_arr: Left half sorted array.
+    :param right_arr: Right half sorted array.
+    :return: Merged sorted array.
+    """
+    left_index = 0
+    right_index = 0
+    merge_arr = [None] * (len(left_arr) + len(right_arr))
+    while left_index < len(left_arr) and right_index < len(right_arr):
+        if left_arr[left_index] < right_arr[right_index]:
+            merge_arr[left_index + right_index] = left_arr[left_index]
+            left_index += 1
         else:
-            mergeArr[leftIndex + rightIndex] = rightArr[rightIndex]
-            rightIndex += 1
+            merge_arr[left_index + right_index] = right_arr[right_index]
+            right_index += 1
 
-    for i in range(rightIndex, len(rightArr)):
-        mergeArr[leftIndex + i] = rightArr[i]
-
-    for i in range(leftIndex, len(leftArr)):
-        mergeArr[i + rightIndex] = leftArr[i]
+    for i in range(right_index, len(right_arr)):
+        merge_arr[left_index + i] = right_arr[i]
+    for i in range(left_index, len(left_arr)):
+        merge_arr[i + right_index] = left_arr[i]
+    return merge_arr
 
-    return mergeArr
 
-arr = rand.random_array([int] * 20)
-arr_out = mergeSort(arr)
+array = rand.random_array([int] * 20)
+arr_out = merge_sort(array)
 
 print(arr_out)
-
-

post_traces/pyflakes_output_hw2_debugging.txt

@@ -0,0 +1 @@
+

post_traces/pyflakes_output_rand.txt

@@ -0,0 +1 @@
+

post_traces/pylint_output_hw2_debugging.txt

@@ -0,0 +1,4 @@
+
+--------------------------------------------------------------------
+Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
+

post_traces/pylint_output_rand.txt

@@ -0,0 +1,4 @@
+
+--------------------------------------------------------------------
+Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)
+

post_traces/pylint_output_test_merge_sort.txt

@@ -0,0 +1,4 @@
+
+-------------------------------------------------------------------
+Your code has been rated at 10.00/10 (previous run: 8.18/10, +1.82)
+

rand.py

@@ -1,7 +1,19 @@
+"""
+Module for generating random arrays.
+
+This module contains a function to create a list of random integers.
+"""
+
 import random
 
-def random_array(arr)-> list[int]:
-    shuffled_num = None
-    for i in range(len(arr)):
-        arr[i] = random.randint(1,20)
+
+def random_array(arr) -> list[int]:
+    """
+    Fill the provided list with random integers between 1 and 20.
+
+    :param arr: List of integers to be filled with random values.
+    :return: The list filled with random integers.
+    """
+    for i, _ in enumerate(arr):
+        arr[i] = random.randint(1, 20)
     return arr

test_mergesort.py

@@ -1,13 +1,28 @@
+"""
+Module implementing the unit test cases for Merge Sort algorithm.
+"""
 import hw2_debugging as OP
 
+
 def test_mergesort1():
+    """
+    Takes array of random integers and checks whether it is sorted or not
+    """
     arr = [10, 12, 2, 4, 1, 14, 10, 15, 16, 7, 9, 10]
-    assert OP.mergeSort(arr) == [1, 2, 4, 7, 9, 10, 10, 10, 12, 14, 15, 16]
+    assert OP.merge_sort(arr) == [1, 2, 4, 7, 9, 10, 10, 10, 12, 14, 15, 16]
+
 
 def test_mergesort2():
+    """
+    Takes array of random integers and checks whether it is sorted or not
+    """
     arr = [8, 12, 2, 1, 4, 10, 14, 15, 20, 7, 9, 4]
-    assert OP.mergeSort(arr) == [1, 2, 4, 4, 7, 8, 9, 10, 12, 14, 15, 20]
+    assert OP.merge_sort(arr) == [1, 2, 4, 4, 7, 8, 9, 10, 12, 14, 15, 20]
+
 
 def test_mergesort3():
-    arr = [8, 12, 2, 4, 1, 14, 10, 15, 16, 7, 9, 10]
-    assert OP.mergeSort(arr) == [1, 2, 4, 7, 9, 8, 10, 10, 12, 14, 15, 16, 17]
+    """
+    Takes array of random integers and checks whether it is sorted or not
+    """
+    arr = [-10, -17, -5, -5, -3, 1, -1000, 10]
+    assert OP.merge_sort(arr) == [-1000, -17, -10, -5, -5, -3, 1, 10]