Merge pull request #11 from ForNeus57/fix/linters

fix: fixed linters so all tests should pass

Author: ForNeus57

.github/workflows/cpp_linter.yaml

@@ -0,0 +1,26 @@
+name: C++ Linters
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  cpp_linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Python Setup
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.13
+
+      - name: Install libraries
+        run: make python-install-development
+
+      - name: clang-tidy
+        run: make clang-tidy

.github/workflows/cpp_linters.yaml

@@ -1,32 +1,32 @@
-name: Linters
-
-on:
-  push:
-    branches:
-      - '**'
-  pull_request:
-    branches:
-      - '**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Python Setup
-        uses: actions/setup-python@v3
-        with:
-          python-version: 3.13
-
-      - name: Install libraries
-        run: make python-install-development
-
-      - name: mypy
-        run: make mypy
-
-      - name: ruff
-        run: make ruff
-      
-      - name: flake8
-        run: make flake8
+name: Python Linters
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  python_linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Python Setup
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.13
+
+      - name: Install libraries
+        run: make python-install-development
+
+      - name: mypy
+        run: make mypy
+
+      - name: ruff
+        run: make ruff
+      
+      - name: flake8
+        run: make flake8

.github/workflows/linters.yaml .github/workflows/python_linter.yaml.github/workflows/linters.yaml renamed to .github/workflows/python_linter.yaml

@@ -10,6 +10,9 @@ python-install-development:
 python-install-editable:
 	pip3 install -e .[development]
 
+clang-tidy:
+	clang-tidy $(shell find ./src/cpp/ -name '*.hpp' -o -name '*.cpp') -- -I$(shell python3 -c "import sysconfig; print(sysconfig.get_path('include'))") -I$(shell python3 -c "import numpy; print(numpy.get_include())")
+
 mypy:
 	mypy ./src/python/
 
@@ -18,4 +21,3 @@ ruff:
 
 flake8:
 	flake8 ./src/python/
-

Makefile

@@ -1,5 +1,8 @@
 # CPython-based Extension for Image Manipulation
 
+[![C++ Linters](https://github.com/ForNeus57/advanced-python-programming-project/actions/workflows/cpp_linter.yaml/badge.svg)](https://github.com/ForNeus57/advanced-python-programming-project/actions/workflows/cpp_linter.yaml)
+[![Python Linters](https://github.com/ForNeus57/advanced-python-programming-project/actions/workflows/python_linter.yaml/badge.svg)](https://github.com/ForNeus57/advanced-python-programming-project/actions/workflows/python_linter.yaml)
+
 <!-- TOC -->
 * [CPython-based Extension for Image Manipulation](#cpython-based-extension-for-image-manipulation)
     * [Team members](#team-members)

README.md

@@ -9,31 +9,39 @@ numpy_system(PyObject *self, PyObject *args)
     int sts;
 
     if (!PyArg_ParseTuple(args, "s", &command))
+    {
         return NULL;
+    }
+
     sts = system(command);
     return PyLong_FromLong(sts);
 }
 
 static PyObject * 
-numpy_add(PyObject *self, PyObject *args){
+numpy_add(PyObject *self, PyObject *args)
+{
     PyArrayObject *arr;
     PyArg_ParseTuple(args, "O", &arr);
-    if(PyErr_Occurred()){
+    if(PyErr_Occurred())
+    {
         return NULL;
     }
-    if(!PyArray_Check(arr) || PyArray_TYPE(arr) != NPY_DOUBLE) {
+    if(!PyArray_Check(arr) || PyArray_TYPE(arr) != NPY_DOUBLE)
+    {
         PyErr_SetString(PyExc_TypeError, "Argument must be a numpy array of type double!");
         return NULL;
     }
 
 
-    double *data = (double *) PyArray_DATA(arr);
+    double *data = reinterpret_cast<double *>(PyArray_DATA(arr));
     int64_t size = PyArray_SIZE(arr);
 
-    double total=0;
-    for (int i=0; i < size; i++){
+    double total = 0;
+    for (int i = 0; i < size; i++)
+    {
         total += data[i];
     }
+
     return PyFloat_FromDouble(total);
 }
 
@@ -42,13 +50,15 @@ static PyObject *SpamError = NULL;
 static int
 numpy_module_exec(PyObject *m)
 {
-    if (SpamError != NULL) {
+    if (SpamError != NULL)
+    {
         PyErr_SetString(PyExc_ImportError,
                         "cannot initialize numpy module more than once");
         return -1;
     }
     SpamError = PyErr_NewException("numpy.error", NULL, NULL);
-    if (PyModule_AddObjectRef(m, "SpamError", SpamError) < 0) {
+    if (PyModule_AddObjectRef(m, "SpamError", SpamError) < 0)
+    {
         return -1;
     }
 
@@ -62,7 +72,7 @@ static PyMethodDef numpy_methods[] = {
 };
 
 static PyModuleDef_Slot numpy_module_slots[] = {
-    {Py_mod_exec, (void*) numpy_module_exec},
+    {Py_mod_exec, reinterpret_cast<void*>(numpy_module_exec)},
     {0, NULL}
 };
 

src/cpp/fast/foo.cpp

@@ -34,8 +34,7 @@ def get_parser() -> ArgumentParser:
     subparser = parser.add_subparsers(required=True,
                                       help='Command to be performed on an image')
 
-    operation_class: type[Operation]
-    for operation_class in [Rotate90Operation, IdentityOperation, FlipOperation, BGR2RGBOperation, RollOperation, GrayscaleOperation, HistogramEqualizationOperation]:
+    for operation_class in available_commands():
         operation = operation_class()
 
         operation_parser = subparser.add_parser(name=operation_class.name(),
@@ -46,6 +45,7 @@ def get_parser() -> ArgumentParser:
 
     return parser
 
+
 def prepare_command(command: Operation) -> Callable[[Namespace], int]:
 
     def wrapper(args: Namespace) -> int:
@@ -61,3 +61,15 @@ def wrapper(args: Namespace) -> int:
         return 0
 
     return wrapper
+
+
+def available_commands():
+    return [
+        Rotate90Operation,
+        IdentityOperation,
+        FlipOperation,
+        BGR2RGBOperation,
+        RollOperation,
+        GrayscaleOperation,
+        HistogramEqualizationOperation,
+    ]

src/python/app/command/parser.py

@@ -1,9 +1,12 @@
+"""Main entrypoint for imcli program"""
+
 from app.command.parser import get_parser
 
 
 def main() -> None:
     args = get_parser().parse_args()
     return args.func(args)
 
+
 if __name__ == '__main__':
     main()

src/python/app/imcli.py

@@ -46,7 +46,8 @@ def read_format(self, file: BinaryIO) -> Image:
         assert panes == 1
         assert bits_per_pixel in (1, 4, 8, 16, 24, 32)
 
-        compression_method, raw_bitmap_data_size, horizontal_resolution, vertical_resolution, num_colors, num_important_colors = \
+        compression_method, raw_bitmap_data_size, horizontal_resolution, vertical_resolution, \
+            num_colors, num_important_colors = \
             struct.unpack('IIiiII', dib_header_no_size[12:])
         assert compression_method == 0
         assert raw_bitmap_data_size != 0
@@ -61,7 +62,8 @@ def read_format(self, file: BinaryIO) -> Image:
         num_colors_end = bits_per_pixel // 8
         return Image(data=np.flip(
             np.flip(
-                np.frombuffer(bytes(image_bytes), dtype=np.uint8).reshape(image_height, image_width, num_colors_end)[:, :, ::-1],
+                np.frombuffer(bytes(image_bytes),
+                              dtype=np.uint8).reshape(image_height, image_width, num_colors_end)[:, :, ::-1],
                 axis=0
             ),
             axis=1)

src/python/app/io/bmp.py

@@ -1,5 +1,4 @@
 import enum
-from typing import Self
 
 from app.error.unknown_format_exception import UnknownFormatException
 from app.io.bmp import BMPReader, BMPWriter
@@ -11,7 +10,7 @@ class KnownFormat(enum.Enum):
     BMP = 0
 
     @classmethod
-    def from_string(cls, data_format: str) -> Self:
+    def from_string(cls, data_format: str) -> 'KnownFormat':
         match data_format:
             case 'bmp':
                 return cls.BMP
@@ -24,7 +23,7 @@ def get_available_formats(cls) -> list[str]:
         return [e.name.lower() for e in cls]
 
     @classmethod
-    def default(cls) -> Self:
+    def default(cls) -> 'KnownFormat':
         return KnownFormat.BMP
 
 
@@ -37,6 +36,7 @@ def get_reader_from_format(data_format: KnownFormat) -> FormatReader:
         case _:
             assert False, "unreachable"
 
+
 def get_writer_from_format(data_format: KnownFormat) -> FormatWriter:
 
     match data_format: